From ddc55f28d06a8a67778cad0c82a353834a63d7fb Mon Sep 17 00:00:00 2001 From: justoneapi <139095138+justoneapi@users.noreply.github.com> Date: Mon, 6 Apr 2026 07:37:59 +0000 Subject: [PATCH] chore: sync OpenAPI spec and generated SDK --- justoneapi/generated/resources/__init__.py | 3 + justoneapi/generated/resources/amazon.py | 42 +- justoneapi/generated/resources/beike.py | 42 +- justoneapi/generated/resources/bilibili.py | 75 +- justoneapi/generated/resources/douban.py | 50 +- justoneapi/generated/resources/douyin.py | 89 +- .../generated/resources/douyin_xingtu.py | 174 +- justoneapi/generated/resources/facebook.py | 54 +- justoneapi/generated/resources/imdb.py | 133 +- justoneapi/generated/resources/instagram.py | 45 +- justoneapi/generated/resources/jd.py | 36 +- justoneapi/generated/resources/kuaishou.py | 62 +- justoneapi/generated/resources/reddit.py | 38 +- justoneapi/generated/resources/search.py | 17 +- justoneapi/generated/resources/taobao.py | 152 +- justoneapi/generated/resources/tiktok.py | 80 +- justoneapi/generated/resources/tiktok_shop.py | 20 +- justoneapi/generated/resources/toutiao.py | 43 +- justoneapi/generated/resources/twitter.py | 23 +- justoneapi/generated/resources/web.py | 70 + justoneapi/generated/resources/weibo.py | 85 +- justoneapi/generated/resources/weixin.py | 42 +- justoneapi/generated/resources/xiaohongshu.py | 172 +- .../generated/resources/xiaohongshu_pgy.py | 111 +- justoneapi/generated/resources/youku.py | 30 +- justoneapi/generated/resources/youtube.py | 33 +- justoneapi/generated/resources/zhihu.py | 32 +- openapi/public-api.json | 1719 ++++++++-------- openapi/public-api.normalized.json | 1723 ++++++++--------- 29 files changed, 2132 insertions(+), 3063 deletions(-) create mode 100644 justoneapi/generated/resources/web.py diff --git a/justoneapi/generated/resources/__init__.py b/justoneapi/generated/resources/__init__.py index 5336e158..d8865fef 100644 --- a/justoneapi/generated/resources/__init__.py +++ b/justoneapi/generated/resources/__init__.py @@ -18,6 +18,7 @@ from justoneapi.generated.resources.tiktok_shop import TiktokShopResource from justoneapi.generated.resources.toutiao import ToutiaoResource from justoneapi.generated.resources.twitter import TwitterResource +from justoneapi.generated.resources.web import WebResource from justoneapi.generated.resources.weibo import WeiboResource from justoneapi.generated.resources.weixin import WeixinResource from justoneapi.generated.resources.xiaohongshu import XiaohongshuResource @@ -45,6 +46,7 @@ "tiktok_shop": TiktokShopResource, "toutiao": ToutiaoResource, "twitter": TwitterResource, + "web": WebResource, "weibo": WeiboResource, "weixin": WeixinResource, "xiaohongshu": XiaohongshuResource, @@ -73,6 +75,7 @@ "TiktokShopResource", "ToutiaoResource", "TwitterResource", + "WebResource", "WeiboResource", "WeixinResource", "XiaohongshuResource", diff --git a/justoneapi/generated/resources/amazon.py b/justoneapi/generated/resources/amazon.py index d454603a..808dcf81 100644 --- a/justoneapi/generated/resources/amazon.py +++ b/justoneapi/generated/resources/amazon.py @@ -16,16 +16,9 @@ def get_product_detail_v1( country: str | None = "US", ) -> ApiResponse[Any]: """ - Product Details (V1) + Product Details - Retrieves detailed product information from Amazon based on the provided ASIN. - It returns core product data such as title, brand, price, availability, rating, - review count, product images, category information, and other publicly available details. - - Typical use cases: - - Building product catalogs and enriching item content (e.g., images) - - Price monitoring and availability tracking - - E-commerce analytics and competitor tracking + Get Amazon product Details data, including title, brand, and price, for building product catalogs and enriching item content (e.g., images), price monitoring and availability tracking, and e-commerce analytics and competitor tracking. Args: asin: ASIN (Amazon Standard Identification Number). @@ -46,16 +39,9 @@ def get_product_top_reviews_v1( country: str | None = "US", ) -> ApiResponse[Any]: """ - Product Top Reviews (V1) - - Retrieves top (most relevant or most helpful) public reviews for an Amazon product based on the provided ASIN. - It returns review details such as review ID, reviewer name, rating score, - review title, review content, publish time, and helpful vote count (if available). + Product Top Reviews - Typical use cases: - - Sentiment analysis and consumer feedback tracking - - Product research and quality assessment - - Monitoring competitor customer experience + Get Amazon product Top Reviews data, including most helpful) public reviews, for sentiment analysis and consumer feedback tracking, product research and quality assessment, and monitoring competitor customer experience. Args: asin: ASIN (Amazon Standard Identification Number). @@ -77,15 +63,9 @@ def get_best_sellers_v1( page: int | None = 1, ) -> ApiResponse[Any]: """ - Best Sellers (V1) + Best Sellers - Retrieves top performing products for a given category on Amazon. - Supports top level best sellers categories (e.g. software). In addition, subcategories / category path can be specified. - - Typical use cases: - - Identifying trending products in specific categories - - Market share analysis and category research - - Tracking sales rank and popularity over time + Get Amazon best Sellers data, including rank positions, product metadata, and pricing, for identifying trending products in specific categories, market share analysis and category research, and tracking sales rank and popularity over time. Args: category: Best sellers category to return products for (e.g. 'software' or 'software/229535'). @@ -110,15 +90,9 @@ def get_products_by_category_v1( page: int | None = 1, ) -> ApiResponse[Any]: """ - Products By Category (V1) - - Retrieves products under a specified Amazon category. - Supports category-based product discovery and returns product information such as title, price, rating, review count, and other available marketplace fields. + Products By Category - Typical use cases: - - Discovering products within a specific category - - Category research and competitor analysis - - Monitoring product assortment, pricing, and popularity trends + Get Amazon products By Category data, including title, price, and rating, for category-based product discovery and returns product information such as title, price, and rating. Args: category_id: For example: https://amazon.com/s?node=172282 - the Amazon Category ID is 172282 diff --git a/justoneapi/generated/resources/beike.py b/justoneapi/generated/resources/beike.py index 9f8161a1..16423167 100644 --- a/justoneapi/generated/resources/beike.py +++ b/justoneapi/generated/resources/beike.py @@ -16,19 +16,9 @@ def ershoufang_detail_v1( house_code: str, ) -> ApiResponse[Any]: """ - Resale Housing Details (V1) + Resale Housing Details - Retrieves comprehensive information for a specific second-hand property listing on Beike (Lianjia). - - The data includes: - - Pricing (total and unit price). - - Physical attributes (area, layout, floor, orientation). - - Listing metadata (tags, listing date). - - Agent contact information. - - Typical use cases: - - Displaying a full property profile to users. - - Detailed price comparison between specific listings. + Get Beike resale Housing Details data, including - Pricing (total and unit price), Physical attributes (area, and layout, for displaying a full property profile to users and detailed price comparison between specific listings. Args: city_id: The ID of the city (e.g., '110000' for Beijing). @@ -50,18 +40,9 @@ def get_ershoufang_list_v1( offset: int | None = 0, ) -> ApiResponse[Any]: """ - Resale Housing List (V1) - - Fetches a list of second-hand property listings from Beike (Lianjia) based on specified filters. + Resale Housing List - Key features: - - Supports filtering by city/region, price range, layout, and area. - - Returns core listing details such as title, total price, unit price, and community info. - - Provides house codes for fetching full details via the detail API. - - Typical use cases: - - Building search result pages for property portals. - - Aggregating market data for regional housing trends. + Get Beike resale Housing List data, including - Supports filtering by city/region, price range, and layout, for building search result pages for property portals and aggregating market data for regional housing trends. Args: city_id: The ID of the city (e.g., '110000' for Beijing). @@ -85,20 +66,9 @@ def community_list_v1( limit_offset: int | None = 0, ) -> ApiResponse[Any]: """ - Community List (V1) - - Retrieves a list of residential communities (Xiaoqu) from Beike (Lianjia) within a specified city. - - The data includes: - - Community name and unique ID. - - Average listing price and historical price trends. - - Build year and architectural details. - - Geographical coordinates and location information. + Community List - Typical use cases: - - Identifying popular residential areas in a city. - - Comparing average housing prices across different communities. - - Spatial analysis of property development patterns. + Get Beike community List data, including - Community name and unique ID and Average listing price and historical price trends, for identifying popular residential areas in a city and comparing average housing prices across different communities. Args: city_id: The ID of the city (e.g., '110000' for Beijing). diff --git a/justoneapi/generated/resources/bilibili.py b/justoneapi/generated/resources/bilibili.py index 3e050a5b..cc080585 100644 --- a/justoneapi/generated/resources/bilibili.py +++ b/justoneapi/generated/resources/bilibili.py @@ -15,13 +15,9 @@ def get_video_detail_v2( bvid: str, ) -> ApiResponse[Any]: """ - Video Details (V2) + Video Details - Retrieve comprehensive details about a specific Bilibili video, including metadata (title, tags, publishing time), statistics (views, likes, danmaku count), and uploader profile information. - - Typical use cases: - - Tracking video performance and engagement metrics. - - Analyzing content metadata and uploader information. + Get Bilibili video Details data, including metadata (title, tags, and publishing time), for tracking video performance and engagement metrics and analyzing content metadata and uploader information. Args: bvid: Bilibili Video ID (BVID). @@ -40,13 +36,9 @@ def get_user_video_list_v2( param: str | None = None, ) -> ApiResponse[Any]: """ - User Published Videos (V2) - - Retrieve a list of videos published by a specific Bilibili user, including video metadata, cover images, and engagement metrics. + User Published Videos - Typical use cases: - - Monitoring creator's content updates and publishing patterns. - - Building user-specific video catalogs for analysis. + Get Bilibili user Published Videos data, including titles, covers, and publish times, for creator monitoring and content performance analysis. Args: uid: Bilibili User ID (UID). @@ -66,13 +58,9 @@ def get_user_detail_v2( uid: str, ) -> ApiResponse[Any]: """ - User Profile (V2) - - Retrieve detailed profile information of a specific Bilibili user, including username, avatar, level, and verification status. + User Profile - Typical use cases: - - Analyzing creator's profile, level, and verification status. - - Verifying user identity and social presence on Bilibili. + Get Bilibili user Profile data, including account metadata, audience metrics, and verification-related fields, for analyzing creator's profile, level, and verification status and verifying user identity and social presence on bilibili. Args: uid: Bilibili User ID (UID). @@ -92,13 +80,9 @@ def get_video_danmu_v2( page: str | None = None, ) -> ApiResponse[Any]: """ - Video Danmaku (V2) + Video Danmaku - Retrieve danmaku (rolling comments) for a specific Bilibili video. - - Typical use cases: - - Analyzing real-time viewer reactions and community trends. - - Sentiment analysis based on rolling comments. + Get Bilibili video Danmaku data, including timeline positions and comment text, for audience reaction analysis and subtitle-style comment review. Args: aid: Bilibili Archive ID (AID). @@ -121,13 +105,9 @@ def get_video_comment_v2( cursor: str | None = None, ) -> ApiResponse[Any]: """ - Video Comments (V2) - - Retrieve top-level comments for a specific Bilibili video, including commenter info, text, likes, and timestamps. + Video Comments - Typical use cases: - - Gathering detailed viewer feedback and community discussions. - - Sentiment analysis and public opinion monitoring. + Get Bilibili video Comments data, including commenter profiles, text, and likes, for sentiment analysis and comment moderation workflows. Args: aid: Bilibili Archive ID (AID). @@ -149,13 +129,9 @@ def search_video_v2( order: str | None = "general", ) -> ApiResponse[Any]: """ - Video Search (V2) + Video Search - Search for Bilibili videos based on keywords, returning matched videos with metadata, author information, and engagement stats. - - Typical use cases: - - Discovering trending videos or creators by specific keywords. - - Competitive analysis and market research on Bilibili. + Get Bilibili video Search data, including matched videos, creators, and engagement metrics, for topic research and content discovery. Args: keyword: Search keyword. @@ -177,16 +153,9 @@ def share_url_transfer_v1( share_url: str, ) -> ApiResponse[Any]: """ - Share Link Resolution (V1) - - Resolve Bilibili share URLs (e.g., https://b23.tv/...) to get the original content metadata. - - Typical use cases: - - Converting shortened mobile share links to standard BVID/metadata. - - Automating content extraction from shared social media links. + Share Link Resolution - Highlights - - Only supports share URLs starting with 'https://b23.tv/'. + Get Bilibili share Link Resolution data, including resolved video and page identifier, for converting shortened mobile share links to standard bvid/metadata and automating content extraction from shared social media links. Args: share_url: Bilibili share URL (must start with https://b23.tv/). @@ -204,13 +173,9 @@ def get_user_relation_stat( wmid: str, ) -> ApiResponse[Any]: """ - User Relation Stats (V1) + User Relation Stats - Retrieve follower count and following count for a specific Bilibili user. - - Typical use cases: - - Tracking creator's follower growth and audience reach. - - Analyzing social influence and account popularity. + Get Bilibili user Relation Stats data, including following counts, for creator benchmarking and audience growth tracking. Args: wmid: Bilibili User ID (WMID). @@ -230,13 +195,9 @@ def get_video_caption_v1( cid: str, ) -> ApiResponse[Any]: """ - Video Captions (V2) - - Retrieve subtitle/caption information for a specific Bilibili video. + Video Captions - Typical use cases: - - Extracting textual content from video subtitles for indexing or analysis. - - Multi-language content processing and accessibility analysis. + Get Bilibili video Captions data, including caption data, for transcript extraction and multilingual content analysis. Args: bvid: Bilibili Video ID (BVID). diff --git a/justoneapi/generated/resources/douban.py b/justoneapi/generated/resources/douban.py index a93c3aa1..e5eb3380 100644 --- a/justoneapi/generated/resources/douban.py +++ b/justoneapi/generated/resources/douban.py @@ -7,7 +7,7 @@ class DoubanResource(BaseResource): - """Generated resource for Douban.""" + """Generated resource for Douban Movie.""" def get_movie_reviews_v1( self, @@ -17,13 +17,9 @@ def get_movie_reviews_v1( page: int | None = 1, ) -> ApiResponse[Any]: """ - Movie Reviews (V1) + Movie Reviews - Retrieves long-form user reviews for a specific movie subject (identified by subjectId). - - Typical use cases: - - Analyzing detailed audience feedback for movies. - - Long-term trend analysis of viewer sentiment. + Get Douban movie Reviews data, including review titles, ratings, and snippets, for audience sentiment analysis and review research. Args: subject_id: The unique ID for a movie or TV subject on Douban. @@ -45,13 +41,9 @@ def get_movie_review_details_v1( review_id: str, ) -> ApiResponse[Any]: """ - Movie Review Details (V1) - - Retrieves the full content and metadata of a specific movie review (identified by reviewId). + Review Details - Typical use cases: - - Fetching the complete text of a single long review. - - Analyzing the structured data and user engagement (likes, replies) of a specific review. + Get Douban movie Review Details data, including metadata, content fields, and engagement signals, for review archiving and detailed opinion analysis. Args: review_id: The unique ID for a specific review on Douban. @@ -71,13 +63,9 @@ def get_movie_comments_v1( page: int | None = 1, ) -> ApiResponse[Any]: """ - Movie Comments (V1) - - Retrieves short user comments (short reviews) for a specific movie subject (identified by subjectId). + Comments - Typical use cases: - - Fast-paced sentiment analysis using quick viewer comments. - - Monitoring initial audience reaction upon movie release. + Get Douban movie Comments data, including ratings, snippets, and interaction counts, for quick sentiment sampling and review monitoring. Args: subject_id: The unique ID for a movie or TV subject on Douban. @@ -99,13 +87,9 @@ def get_subject_detail_v1( subject_id: str, ) -> ApiResponse[Any]: """ - Subject Details (V1) + Subject Details - Retrieves detailed information for a specific subject identified by subjectId. - - Typical use cases: - - Displaying complete subject metadata in applications or websites. - - Supporting content analysis, cataloging, or detail page rendering. + Get Douban subject Details data, including title, rating, and cast, for title enrichment and catalog research. Args: subject_id: The unique ID for a movie or TV subject on Douban. @@ -123,13 +107,9 @@ def get_recent_hot_movie_v1( page: int | None = 1, ) -> ApiResponse[Any]: """ - Recent Hot Movie (V1) - - Retrieves the latest hot movies currently trending on the platform. + Recent Hot Movie - Typical use cases: - - Discovering recently popular movies. - - Tracking current movie trends for content analysis or recommendation. + Get Douban recent Hot Movie data, including ratings, posters, and subject metadata, for movie discovery and trend monitoring. Args: page: Page number for pagination. @@ -147,13 +127,9 @@ def get_recent_hot_tv_v1( page: int | None = 1, ) -> ApiResponse[Any]: """ - Recent Hot Tv (V1) - - Retrieves the latest hot TV shows currently trending on the platform. + Recent Hot Tv - Typical use cases: - - Discovering recently popular TV shows. - - Tracking current TV trends for content analysis or recommendation. + Get Douban recent Hot Tv data, including ratings, posters, and subject metadata, for series discovery and trend monitoring. Args: page: Page number for pagination. diff --git a/justoneapi/generated/resources/douyin.py b/justoneapi/generated/resources/douyin.py index 792b4e7e..39313e07 100644 --- a/justoneapi/generated/resources/douyin.py +++ b/justoneapi/generated/resources/douyin.py @@ -7,7 +7,7 @@ class DouyinResource(BaseResource): - """Generated resource for Douyin.""" + """Generated resource for Douyin (TikTok China).""" def get_user_detail_v3( self, @@ -15,15 +15,9 @@ def get_user_detail_v3( sec_uid: str, ) -> ApiResponse[Any]: """ - User Profile (V3) + User Profile - Retrieves detailed profile information of a Douyin user, including nickname, avatar, - follower count, verification status, bio, and other user statistics. - - Typical use cases: - - Identifying creators and building creator lists - - Enriching user records for analytics and reporting - - Monitoring profile changes and audience growth + Get Douyin (TikTok China) user Profile data, including follower counts, verification status, and bio details, for creator research and account analysis. Args: sec_uid: The unique user ID (sec_uid) on Douyin. @@ -42,17 +36,9 @@ def get_user_video_list_v1( max_cursor: int | None = 0, ) -> ApiResponse[Any]: """ - User Published Videos (V1) - - Retrieves a list of videos published by a specific Douyin user, including video ID, - cover image, title/caption, publish time, and engagement metrics. - - Highlights: - - Capable of retrieving the latest published videos. + User Published Videos - Typical use cases: - - Creator monitoring and content tracking - - Building content timelines for specific accounts + Get Douyin (TikTok China) user Published Videos data, including captions, covers, and publish times, for account monitoring. Args: sec_uid: The unique user ID (sec_uid) on Douyin. @@ -73,17 +59,9 @@ def get_user_video_list_v3( max_cursor: int | None = 0, ) -> ApiResponse[Any]: """ - User Published Videos (V3) + User Published Videos - Retrieves a list of videos published by a specific Douyin user. This version may offer - different data structure or coverage compared to V1. - - Highlights: - - Not capable of retrieving the latest published videos. - - Typical use cases: - - Creator monitoring and content tracking - - Building content timelines for specific accounts + Get Douyin (TikTok China) user Published Videos data, including captions, covers, and publish times, for account monitoring. Args: sec_uid: The unique user ID (sec_uid) on Douyin. @@ -103,14 +81,9 @@ def get_video_detail_v2( video_id: str, ) -> ApiResponse[Any]: """ - Video Details (V2) - - Provides detailed information about a specific Douyin video, including video URL, - description, author info, publish time, and engagement metrics (likes, comments, shares). + Video Details - Typical use cases: - - Content analysis and performance tracking - - Retrieving high-quality video assets and metadata + Get Douyin (TikTok China) video Details data, including author details, publish time, and engagement counts, for video research, archiving, and performance analysis. Args: video_id: The unique video identifier (aweme_id or model_id). @@ -133,14 +106,9 @@ def search_video_v4( search_id: str | None = None, ) -> ApiResponse[Any]: """ - Video Search (V4) + Video Search - Allows searching for Douyin videos based on keywords, returning matched results with - video metadata and engagement metrics. Supports filtering by sort type, publish time, and duration. - - Typical use cases: - - Trend analysis and keyword monitoring - - Discovery of relevant content for specific topics + Get Douyin (TikTok China) video Search data, including metadata and engagement signals, for content discovery, trend research, and competitive monitoring. Args: keyword: The search keyword. @@ -170,14 +138,9 @@ def search_user_v2( user_type: str | None = None, ) -> ApiResponse[Any]: """ - User Search (V2) - - Enables searching for Douyin users by keyword, returning profiles with nickname, - avatar, follower count, and other metadata. + User Search - Typical use cases: - - Identifying creators and influencers - - Competitive analysis and creator discovery + Get Douyin (TikTok China) user Search data, including profile metadata and follower signals, for creator discovery and account research. Args: keyword: The search keyword. @@ -200,14 +163,9 @@ def get_video_comment_v1( page: int | None = 1, ) -> ApiResponse[Any]: """ - Video Comments (V1) - - Retrieves the comment list of a Douyin video by awemeId. - Returns comment content, author info, like count, reply count, and publish time. + Video Comments - Typical use cases: - - Sentiment analysis and community feedback monitoring - - Gathering user engagement data for specific videos + Get Douyin (TikTok China) video Comments data, including authors, text, and likes, for sentiment analysis and engagement review. Args: aweme_id: The unique video identifier (aweme_id). @@ -228,14 +186,9 @@ def get_video_sub_comment_v1( page: int | None = 1, ) -> ApiResponse[Any]: """ - Comment Replies (V1) + Comment Replies - Retrieves replies to a specific top-level comment under a Douyin video, - including reply content, user information, timestamp, and like count. - - Typical use cases: - - Deep-dive into specific discussion threads - - Detailed community feedback analysis + Get Douyin (TikTok China) comment Replies data, including text, authors, and timestamps, for thread analysis and feedback research. Args: comment_id: The unique identifier of the top-level comment. @@ -255,13 +208,9 @@ def share_url_transfer_v1( share_url: str, ) -> ApiResponse[Any]: """ - Share Link Resolution (V1) - - Converts a Douyin short share URL (e.g., https://v.douyin.com/...) into structured video data. + Share Link Resolution - Typical use cases: - - Resolving shared links from users or social media posts - - Automating content ingestion from shared URLs + Get Douyin (TikTok China) share Link Resolution data, including helping extract canonical IDs, for downstream video and comment workflows. Args: share_url: The Douyin short share URL. diff --git a/justoneapi/generated/resources/douyin_xingtu.py b/justoneapi/generated/resources/douyin_xingtu.py index 307289f9..68310b60 100644 --- a/justoneapi/generated/resources/douyin_xingtu.py +++ b/justoneapi/generated/resources/douyin_xingtu.py @@ -7,7 +7,7 @@ class DouyinXingtuResource(BaseResource): - """Generated resource for Douyin Xingtu.""" + """Generated resource for Douyin Creator Marketplace (Xingtu).""" def gw_api_author_get_author_base_info_v1( self, @@ -16,9 +16,9 @@ def gw_api_author_get_author_base_info_v1( platform: str | None = "SHORT_VIDEO", ) -> ApiResponse[Any]: """ - Author Base Info (V1) + Creator Profile - Retrieve basic information for a specific author. + Get Douyin Creator Marketplace (Xingtu) creator Profile data, including audience and pricing data, for influencer vetting, benchmark analysis, and campaign planning. Args: o_author_id: Author's unique ID. @@ -39,9 +39,9 @@ def gw_api_data_sp_author_link_struct_v1( platform: str | None = "SHORT_VIDEO", ) -> ApiResponse[Any]: """ - Author Link Struct (V1) + Creator Link Structure - Get structure of author links. + Get Douyin Creator Marketplace (Xingtu) creator Link Structure data, including engagement and conversion metrics, for creator performance analysis. Args: o_author_id: Author's unique ID. @@ -62,9 +62,9 @@ def gw_api_data_sp_check_author_display_v1( platform: str | None = "SHORT_VIDEO", ) -> ApiResponse[Any]: """ - Check Author Display (V1) + Creator Visibility Status - Check visibility status of an author. + Get Douyin Creator Marketplace (Xingtu) creator Visibility Status data, including availability status, discovery eligibility, and campaign display signals, for creator evaluation, campaign planning, and marketplace research. Args: o_author_id: Author's unique ID. @@ -85,9 +85,9 @@ def gw_api_author_get_author_platform_channel_info_v2_v1( platform: str | None = "SHORT_VIDEO", ) -> ApiResponse[Any]: """ - Author Platform Channel Info (V1) + Creator Channel Metrics - Retrieve author's platform channel data. + Get Douyin Creator Marketplace (Xingtu) creator Channel Metrics data, including platform distribution and channel performance data used, for creator evaluation. Args: o_author_id: Author's unique ID. @@ -108,9 +108,9 @@ def gw_api_aggregator_get_author_order_experience_v1( period: str | None = "DAY_30", ) -> ApiResponse[Any]: """ - Author Order Experience (V1) + Creator Order Experience - Get author's transaction experience summary. + Get Douyin Creator Marketplace (Xingtu) creator Order Experience data, including commercial history and transaction-related indicators, for creator evaluation, campaign planning, and marketplace research. Args: o_author_id: Author's unique ID. @@ -132,9 +132,9 @@ def gw_api_data_sp_get_author_link_info_v1( industry_tag: str | None = "ALL", ) -> ApiResponse[Any]: """ - Author Link Info (V1) + Creator Link Metrics - Get author's link index and stats. + Get Douyin Creator Marketplace (Xingtu) creator Link Metrics data, including creator ranking, traffic structure, and related performance indicators, for creator evaluation, campaign planning, and marketplace research. Args: o_author_id: Author's unique ID. @@ -157,9 +157,9 @@ def gw_api_data_sp_author_video_distribution_v1( platform: str | None = "SHORT_VIDEO", ) -> ApiResponse[Any]: """ - Author Video Distribution (V1) + Video Distribution - Get author's video performance distribution. + Get Douyin Creator Marketplace (Xingtu) video Distribution data, including content performance breakdowns across published videos, for creator evaluation, campaign planning, and marketplace research. Args: o_author_id: Author's unique ID. @@ -181,9 +181,9 @@ def gw_api_data_sp_author_audience_distribution_v1( link_type: str | None = "CONNECTED", ) -> ApiResponse[Any]: """ - Author Audience Distribution (V1) + Audience Distribution - Get author's audience demographics. + Get Douyin Creator Marketplace (Xingtu) audience Distribution data, including demographic and interest-based audience segmentation, for creator evaluation, campaign planning, and marketplace research. Args: o_author_id: Author's unique ID. @@ -206,9 +206,9 @@ def gw_api_author_get_author_marketing_info_v1( platform: str | None = "SHORT_VIDEO", ) -> ApiResponse[Any]: """ - Author Marketing Info (V1) + Marketing Rates - Get author's marketing pricing and stats. + Get Douyin Creator Marketplace (Xingtu) marketing Rates data, including rate card details and commercial service metrics, for creator evaluation, campaign planning, and marketplace research. Args: o_author_id: Author's unique ID. @@ -233,9 +233,9 @@ def gw_api_data_sp_get_author_spread_info_v1( flow_type: str | None = "EXCLUDE", ) -> ApiResponse[Any]: """ - Author Spread Info (V1) + Distribution Metrics - Get author's spread performance metrics. + Get Douyin Creator Marketplace (Xingtu) distribution Metrics data, including exposure, spread, and related performance indicators, for creator evaluation, campaign planning, and marketplace research. Args: o_author_id: Author's unique ID. @@ -265,9 +265,9 @@ def gw_api_data_sp_get_author_convert_ability_v1( range: str | None = "DAY_30", ) -> ApiResponse[Any]: """ - Author Convert Ability (V1) + Conversion Analysis - Get author's conversion capability analysis. + Get Douyin Creator Marketplace (Xingtu) conversion Analysis data, including conversion efficiency and commercial performance indicators, for creator evaluation, campaign planning, and marketplace research. Args: o_author_id: Author's unique ID. @@ -292,9 +292,9 @@ def gw_api_author_get_author_show_items_v2_v1( flow_type: str | None = "EXCLUDE", ) -> ApiResponse[Any]: """ - Author Show Items (V1) + Showcase Items - Get author's showcased items or videos. + Get Douyin Creator Marketplace (Xingtu) showcase Items data, including products and videos associated with the account, for creator evaluation, campaign planning, and marketplace research. Args: o_author_id: Author's unique ID. @@ -323,9 +323,9 @@ def gw_api_data_sp_get_author_convert_videos_or_products_v1( page: int | None = 1, ) -> ApiResponse[Any]: """ - Author Convert Videos or Products (V1) + Conversion Resources - Get detailed conversion data for videos or products. + Get Douyin Creator Marketplace (Xingtu) conversion Resources data, including products tied to a Douyin Xingtu creator's conversion activity, for commerce analysis and campaign optimization. Args: o_author_id: Author's unique ID. @@ -354,9 +354,9 @@ def gw_api_data_sp_author_cp_info_v1( platform: str | None = "SHORT_VIDEO", ) -> ApiResponse[Any]: """ - Author CP Info (V1) + Cost Performance Analysis - Get author's cost-performance analysis. + Get Douyin Creator Marketplace (Xingtu) cost Performance Analysis data, including pricing, exposure, and engagement efficiency indicators, for creator evaluation, campaign planning, and marketplace research. Args: o_author_id: Author's unique ID. @@ -377,9 +377,9 @@ def gw_api_data_sp_author_touch_distribution_v1( platform: str | None = "SHORT_VIDEO", ) -> ApiResponse[Any]: """ - Author Touch Distribution (V1) + Audience Touchpoint Distribution - Get author's user touchpoints and distribution. + Get Douyin Creator Marketplace (Xingtu) audience Touchpoint Distribution data, including segment breakdowns, audience composition, and distribution signals, for creator evaluation, campaign planning, and marketplace research. Args: o_author_id: Author's unique ID. @@ -400,9 +400,9 @@ def gw_api_data_sp_author_rec_videos_v2_v1( platform: str | None = "SHORT_VIDEO", ) -> ApiResponse[Any]: """ - Author Recommended Videos (V1) + Recommended Videos - Get author's high-performance recommended videos. + Get Douyin Creator Marketplace (Xingtu) recommended Videos data, including content references used, for creator evaluation. Args: o_author_id: Author's unique ID. @@ -423,9 +423,9 @@ def gw_api_data_sp_get_author_fans_distribution_v1( author_type: str | None = "FAN", ) -> ApiResponse[Any]: """ - Author Fans Distribution (V1) + Follower Distribution - Get author's fans demographics and distribution. + Get Douyin Creator Marketplace (Xingtu) follower Distribution data, including audience segmentation and location and demographic breakdowns, for creator evaluation, campaign planning, and marketplace research. Args: o_author_id: Author's unique ID. @@ -451,9 +451,9 @@ def gw_api_gsearch_search_for_author_square_v1( content_tag: str | None = None, ) -> ApiResponse[Any]: """ - Author Search (V1) + Creator Search - Search for authors using filters. + Get Douyin Creator Marketplace (Xingtu) creator Search data, including filters, returning profile, and audience, for discovery, comparison, and shortlist building. Args: keyword: Search keyword. @@ -483,9 +483,9 @@ def gw_api_data_sp_item_report_trend_v1( item_id: str, ) -> ApiResponse[Any]: """ - Item Report Trend (V1) + Item Report Trend - Get trend analysis for an item report. + Get Douyin Creator Marketplace (Xingtu) item Report Trend data, including time-based changes in item performance metrics, for creator evaluation, campaign planning, and marketplace research. Args: item_id: Item's unique ID. @@ -503,9 +503,9 @@ def gw_api_data_sp_item_report_detail_v1( item_id: str, ) -> ApiResponse[Any]: """ - Item Report Details (V1) + Item Report Details - Get detailed item report data. + Get Douyin Creator Marketplace (Xingtu) item Report Details data, including key metrics and report fields used, for item performance analysis. Args: item_id: Item's unique ID. @@ -523,9 +523,9 @@ def gw_api_data_sp_item_report_th_analysis_v1( item_id: str, ) -> ApiResponse[Any]: """ - Item Report Analysis (V1) + Item Report Analysis - Get analytical insights for an item report. + Get Douyin Creator Marketplace (Xingtu) item Report Analysis data, including performance interpretation, for creator evaluation, campaign planning, and marketplace research. Args: item_id: Item's unique ID. @@ -545,9 +545,9 @@ def get_kol_info_v1( accept_cache: bool | None = False, ) -> ApiResponse[Any]: """ - KOL Profile (V1) [Deprecated] + Creator Profile - Retrieve KOL profile information (Legacy). + Get Douyin Creator Marketplace (Xingtu) creator Profile data, including audience and pricing data, for influencer vetting, benchmark analysis, and campaign planning. Args: kol_id: KOL ID. @@ -570,9 +570,9 @@ def get_kol_audience_distribution_v1( accept_cache: bool | None = False, ) -> ApiResponse[Any]: """ - KOL Audience Profile (V1) [Deprecated] + Audience Distribution - Get fans audience distribution (Legacy). + Get Douyin Creator Marketplace (Xingtu) audience Distribution data, including demographic and interest-based audience segmentation, for creator evaluation, campaign planning, and marketplace research. Args: kol_id: KOL ID. @@ -594,9 +594,9 @@ def get_kol_fans_distribution_v1( accept_cache: bool | None = False, ) -> ApiResponse[Any]: """ - KOL Follower Profile (V1) [Deprecated] + Follower Profile - Get fans portrait (Legacy). + Get Douyin Creator Marketplace (Xingtu) follower Profile data, including audience demographics, interests, and distribution metrics, for creator evaluation, campaign planning, and marketplace research. Args: kol_id: KOL ID. @@ -620,9 +620,9 @@ def get_kol_marketing_info_v1( accept_cache: bool | None = False, ) -> ApiResponse[Any]: """ - KOL Service Pricing (V1) [Deprecated] + Marketing Rates - Get marketing pricing info (Legacy). + Get Douyin Creator Marketplace (Xingtu) marketing Rates data, including rate card details and commercial service metrics, for creator evaluation, campaign planning, and marketplace research. Args: kol_id: KOL ID. @@ -649,9 +649,9 @@ def get_kol_spread_info_v1( accept_cache: bool | None = False, ) -> ApiResponse[Any]: """ - KOL Data Overview (V1) [Deprecated] + Creator Performance Overview - Get spread performance metrics (Legacy). + Get Douyin Creator Marketplace (Xingtu) creator Performance Overview data, including audience, content performance, and commercial indicators, for quick evaluation. Args: kol_id: KOL ID. @@ -680,9 +680,9 @@ def search_douyin_kol_v1( accept_cache: bool | None = False, ) -> ApiResponse[Any]: """ - Douyin KOL Search (V1) [Deprecated] + Legacy KOL Search - Search for Douyin KOLs (Legacy JSON body). + Get Douyin Creator Marketplace (Xingtu) legacy KOL Search data, including preserving the request format, for creator evaluation, campaign planning, and marketplace research. Args: body: JSON request body. @@ -705,9 +705,9 @@ def search_kol_simple_v1( accept_cache: bool | None = False, ) -> ApiResponse[Any]: """ - KOL Keyword Search (V1) + KOL Keyword Search - Simple keyword-based KOL search. + Get Douyin Creator Marketplace (Xingtu) kOL Keyword Search data, including matching creators and discovery data, for creator sourcing and shortlist building. Args: keyword: Search keywords. @@ -733,9 +733,9 @@ def get_kol_convert_ability_v1( accept_cache: bool | None = False, ) -> ApiResponse[Any]: """ - KOL Conversion Analysis (V1) [Deprecated] + Conversion Analysis - Get conversion capability analysis (Legacy). + Get Douyin Creator Marketplace (Xingtu) conversion Analysis data, including conversion efficiency and commercial performance indicators, for creator evaluation, campaign planning, and marketplace research. Args: kol_id: KOL ID. @@ -759,9 +759,9 @@ def get_kol_show_items_v2_v1( accept_cache: bool | None = False, ) -> ApiResponse[Any]: """ - KOL Video Performance (V1) [Deprecated] + Video Performance - Get showcased items or videos performance (Legacy). + Get Douyin Creator Marketplace (Xingtu) video Performance data, including core metrics, trend signals, and performance indicators, for creator evaluation, campaign planning, and marketplace research. Args: kol_id: KOL ID. @@ -785,9 +785,9 @@ def get_kol_link_info_v1( accept_cache: bool | None = False, ) -> ApiResponse[Any]: """ - KOL Xingtu Index (V1) [Deprecated] + Creator Link Metrics - Get author link index (Legacy). + Get Douyin Creator Marketplace (Xingtu) creator Link Metrics data, including creator ranking, traffic structure, and related performance indicators, for creator evaluation, campaign planning, and marketplace research. Args: kol_id: KOL ID. @@ -812,9 +812,9 @@ def get_kol_convert_videos_or_products_v1( accept_cache: bool | None = False, ) -> ApiResponse[Any]: """ - KOL Conversion Video Display (V1) [Deprecated] + Conversion Resources - Get detailed conversion resource list (Legacy). + Get Douyin Creator Marketplace (Xingtu) conversion Resources data, including products tied to a Douyin Xingtu creator's conversion activity, for commerce analysis and campaign optimization. Args: kol_id: KOL ID. @@ -839,9 +839,9 @@ def get_kol_link_struct_v1( accept_cache: bool | None = False, ) -> ApiResponse[Any]: """ - KOL Link Struct (V1) [Deprecated] + Creator Link Structure - Get author link structure (Legacy). + Get Douyin Creator Marketplace (Xingtu) creator Link Structure data, including engagement and conversion metrics, for creator performance analysis. Args: kol_id: KOL ID. @@ -862,9 +862,9 @@ def get_kol_touch_distribution_v1( accept_cache: bool | None = False, ) -> ApiResponse[Any]: """ - KOL Connected User Sources (V1) [Deprecated] + Audience Source Distribution - Get connected user source distribution (Legacy). + Get Douyin Creator Marketplace (Xingtu) audience Source Distribution data, including segment breakdowns, audience composition, and distribution signals, for traffic analysis and existing integration compatibility. Args: kol_id: KOL ID. @@ -885,9 +885,9 @@ def get_kol_cp_info_v1( accept_cache: bool | None = False, ) -> ApiResponse[Any]: """ - KOL Cost-Effectiveness Analysis (V1) [Deprecated] + Cost Performance Analysis - Get cost-effectiveness analysis data (Legacy). + Get Douyin Creator Marketplace (Xingtu) cost Performance Analysis data, including pricing, exposure, and engagement efficiency indicators, for creator evaluation, campaign planning, and marketplace research. Args: kol_id: KOL ID. @@ -908,9 +908,9 @@ def get_kol_rec_videos_v1( accept_cache: bool | None = False, ) -> ApiResponse[Any]: """ - KOL Content Performance (V1) [Deprecated] + KOL Content Performance - Get author content and video performance (Legacy). + Get Douyin Creator Marketplace (Xingtu) kOL Content Performance data, including video performance metrics, for creator evaluation, campaign planning, and marketplace research. Args: kol_id: KOL ID. @@ -932,9 +932,9 @@ def search_for_author_square_v3( fans_high: int, ) -> ApiResponse[Any]: """ - Creator List Search (V3) [Deprecated] + Creator Search - Search for creators by fans range (Legacy). + Get Douyin Creator Marketplace (Xingtu) creator Search data, including filters, returning profile, and audience, for discovery, comparison, and shortlist building. Args: page: Page number. @@ -959,9 +959,9 @@ def get_kol_daily_fans_v1( accept_cache: bool | None = False, ) -> ApiResponse[Any]: """ - KOL Follower Trend (V1) + Follower Growth Trend - Get author's historical daily fans growth trend. + Get Douyin Creator Marketplace (Xingtu) follower Growth Trend data, including historical audience changes over time, for creator evaluation, campaign planning, and marketplace research. Args: kol_id: KOL ID. @@ -986,9 +986,9 @@ def get_author_hot_comment_tokens_v1( accept_cache: bool | None = False, ) -> ApiResponse[Any]: """ - KOL Comment Keyword Analysis (V1) + KOL Comment Keyword Analysis - Get analytical tokens from author's top comments. + Get Douyin Creator Marketplace (Xingtu) kOL Comment Keyword Analysis data, including core metrics, trend signals, and performance indicators, for audience language analysis and comment-topic research. Args: kol_id: KOL ID. @@ -1010,9 +1010,9 @@ def get_author_content_hot_keywords_v1( accept_cache: bool | None = False, ) -> ApiResponse[Any]: """ - KOL Content Keyword Analysis (V1) + KOL Content Keyword Analysis - Get analytical keywords from author's content. + Get Douyin Creator Marketplace (Xingtu) kOL Content Keyword Analysis data, including core metrics, trend signals, and performance indicators, for content theme analysis and creator positioning research. Args: kol_id: KOL ID. @@ -1035,9 +1035,9 @@ def get_author_commerce_spread_info_v1( accept_cache: bool | None = False, ) -> ApiResponse[Any]: """ - Author Commerce Spread Info (V1) + Author Commerce Spread Info - Get author's commercial spread metrics. + Get Douyin Creator Marketplace (Xingtu) author Commerce Spread Info data, including spread metrics, for creator evaluation for campaign planning and media buying. Args: kol_id: KOL ID. @@ -1059,9 +1059,9 @@ def get_author_commerce_seeding_base_info_v1( accept_cache: bool | None = False, ) -> ApiResponse[Any]: """ - Author Commerce Seeding Base Info (V1) + Author Commerce Seeding Base Info - Get author's commercial seeding data. + Get Douyin Creator Marketplace (Xingtu) author Commerce Seeding Base Info data, including baseline metrics, commercial signals, and seeding indicators, for product seeding analysis, creator vetting, and campaign planning. Args: kol_id: KOL ID. @@ -1084,9 +1084,9 @@ def get_video_detail_v1( accept_cache: bool | None = False, ) -> ApiResponse[Any]: """ - Video Details (V1) [Deprecated] + Video Details - Get detailed video data (Legacy). + Get Douyin Creator Marketplace (Xingtu) video Details data, including performance fields from the legacy Douyin Xingtu endpoint, for content review and integration compatibility. Args: detail_id: Video detail ID. diff --git a/justoneapi/generated/resources/facebook.py b/justoneapi/generated/resources/facebook.py index 473c2f84..b39789f3 100644 --- a/justoneapi/generated/resources/facebook.py +++ b/justoneapi/generated/resources/facebook.py @@ -18,16 +18,9 @@ def search_v1( cursor: str | None = "", ) -> ApiResponse[Any]: """ - Search Posts (V1) + Post Search - Search for public posts on Facebook based on keywords. - - The results include post metadata, content, author information, publication time, - engagement metrics (reactions, comments, shares), and media URLs. - - Typical use cases: - - Discovering relevant public posts for specific keywords. - - Analyzing engagement and reach of public content on Facebook. + Get Facebook post Search data, including matched results, metadata, and ranking signals, for discovering relevant public posts for specific keywords and analyzing engagement and reach of public content on facebook. Args: keyword: Keyword to search for in public posts. Supports basic text matching. @@ -44,3 +37,46 @@ def search_v1( "cursor": cursor, }, ) + + def get_profile_id_v1( + self, + *, + url: str, + ) -> ApiResponse[Any]: + """ + Get Profile ID + + Retrieve the unique Facebook profile ID from a given profile URL. + + Args: + url: The path part of the Facebook profile URL. Do not include `https://www.facebook.com`. Example: `/people/To-Bite/pfbid021XLeDjjZjsoWse1H43VEgb3i1uCLTpBvXSvrnL2n118YPtMF5AZkBrZobhWWdHTHl/` + """ + return self._get( + "/api/facebook/get-profile-id/v1", + { + "url": url, + }, + ) + + def get_profile_posts_v1( + self, + *, + profile_id: str, + cursor: str | None = "", + ) -> ApiResponse[Any]: + """ + Get Profile Posts + + Get public posts from a specific Facebook profile using its profile ID. + + Args: + profile_id: The unique Facebook profile ID. + cursor: Pagination cursor for fetching the next set of results. + """ + return self._get( + "/api/facebook/get-profile-posts/v1", + { + "profileId": profile_id, + "cursor": cursor, + }, + ) diff --git a/justoneapi/generated/resources/imdb.py b/justoneapi/generated/resources/imdb.py index 037ee01f..408ee54b 100644 --- a/justoneapi/generated/resources/imdb.py +++ b/justoneapi/generated/resources/imdb.py @@ -17,12 +17,9 @@ def title_release_expectation_query( accept_cache: bool | None = False, ) -> ApiResponse[Any]: """ - Title Release Expectation (V1) + Release Expectation - Retrieve release expectation data for a specific title. - - Typical use cases: - - Analyze audience anticipation for upcoming movie or TV show releases. + Get IMDb title Release Expectation data, including production status, release dates, and anticipation signals, for release monitoring and title research. Args: id_: The unique IMDb ID of the title (e.g., tt12037194). @@ -45,12 +42,9 @@ def title_extended_details_query( language_country: str | None = "en_US", ) -> ApiResponse[Any]: """ - Title Extended Details (V1) - - Retrieve comprehensive extended details for a specific title. + Extended Details - Typical use cases: - - Get in-depth metadata including production details, alternate titles, and more. + Get IMDb title Extended Details data, including title info, images, and genres, for title enrichment and catalog research. Args: id_: The unique IMDb ID of the title (e.g., tt12037194). @@ -71,12 +65,9 @@ def title_top_cast_and_crew( language_country: str | None = "en_US", ) -> ApiResponse[Any]: """ - Title Top Cast and Crew (V1) - - Retrieve information about the top cast and crew members of a title. + Top Cast and Crew - Typical use cases: - - List directors, writers, and main actors for a movie or TV show. + Get IMDb title Top Cast and Crew data, including names, roles, and profile references, for talent research and title enrichment. Args: id_: The unique IMDb ID of the title (e.g., tt12037194). @@ -97,12 +88,9 @@ def title_base_query( language_country: str | None = "en_US", ) -> ApiResponse[Any]: """ - Title Base Info (V1) + Base Info - Retrieve basic metadata for a specific title. - - Typical use cases: - - Get essential information like title, year, and genre. + Get IMDb title Base Info data, including title text, release year, and type, for catalog enrichment and title lookup workflows. Args: id_: The unique IMDb ID of the title (e.g., tt12037194). @@ -123,12 +111,9 @@ def title_redux_overview_query( language_country: str | None = "en_US", ) -> ApiResponse[Any]: """ - Title Redux Overview (V1) - - Retrieve a redux overview of a specific title. + Redux Overview - Typical use cases: - - Get a concise summary and overview of a movie or TV show's key attributes. + Get IMDb title Redux Overview data, including key summary fields and linked metadata, for get a concise summary and overview of a movie or TV show's key attributes. Args: id_: The unique IMDb ID of the title (e.g., tt12037194). @@ -149,12 +134,9 @@ def title_did_you_know_query( language_country: str | None = "en_US", ) -> ApiResponse[Any]: """ - Title 'Did You Know' Insights (V1) + 'Did You Know' Insights - Retrieve interesting 'Did You Know' facts and trivia for a title. - - Typical use cases: - - Enhance user engagement with fun facts and behind-the-scenes trivia. + Get IMDb title 'Did You Know' Insights data, including trivia, for editorial research and title insight enrichment. Args: id_: The unique IMDb ID of the title (e.g., tt12037194). @@ -175,12 +157,9 @@ def title_critics_review_summary_query( language_country: str | None = "en_US", ) -> ApiResponse[Any]: """ - Title Critics Review Summary (V1) - - Retrieve a summary of critical reviews for a specific title. + Critics Review Summary - Typical use cases: - - Display Metacritic scores and a compilation of professional critic feedback. + Get IMDb title Critics Review Summary data, including review highlights, for review analysis and title comparison. Args: id_: The unique IMDb ID of the title (e.g., tt12037194). @@ -201,12 +180,9 @@ def title_awards_summary_query( language_country: str | None = "en_US", ) -> ApiResponse[Any]: """ - Title Awards Summary (V1) - - Retrieve a summary of awards and nominations for a specific title. + Awards Summary - Typical use cases: - - List Oscar wins, Golden Globe nominations, and other accolades. + Get IMDb title Awards Summary data, including nominations, for title benchmarking and awards research. Args: id_: The unique IMDb ID of the title (e.g., tt12037194). @@ -227,12 +203,9 @@ def title_user_reviews_summary_query( language_country: str | None = "en_US", ) -> ApiResponse[Any]: """ - Title User Reviews Summary (V1) + User Reviews Summary - Retrieve a summary of user-submitted reviews for a specific title. - - Typical use cases: - - Get average user ratings and a snapshot of audience sentiment. + Get IMDb title User Reviews Summary data, including aggregated review content and counts, for audience sentiment analysis. Args: id_: The unique IMDb ID of the title (e.g., tt12037194). @@ -253,12 +226,9 @@ def title_plot_query( language_country: str | None = "en_US", ) -> ApiResponse[Any]: """ - Title Plot Summary (V1) - - Retrieve the plot summary for a specific title. + Plot Summary - Typical use cases: - - Display a detailed description of the storyline for a movie or TV show. + Get IMDb title Plot Summary data, including core metrics, trend signals, and performance indicators, for displaying a detailed description of the storyline for a movie or TV show. Args: id_: The unique IMDb ID of the title (e.g., tt12037194). @@ -279,12 +249,9 @@ def title_contribution_questions( language_country: str | None = "en_US", ) -> ApiResponse[Any]: """ - Title Contribution Questions (V1) + Contribution Questions - Retrieve contribution questions for a specific title. - - Typical use cases: - - Facilitate user contributions by providing relevant metadata questions for a movie or TV show. + Get IMDb title Contribution Questions data, including specific IMDb title, for data maintenance workflows and title metadata review. Args: id_: The unique IMDb ID of the title (e.g., tt12037194). @@ -305,12 +272,9 @@ def title_details_query( language_country: str | None = "en_US", ) -> ApiResponse[Any]: """ - Title Details (V1) - - Retrieve comprehensive details for a specific title. + Details - Typical use cases: - - Get all standard information for a movie or TV show including summary, ratings, and more. + Get IMDb title Details data, including metadata, release info, and cast, for deep title research and catalog enrichment. Args: id_: The unique IMDb ID of the title (e.g., tt12037194). @@ -331,12 +295,9 @@ def title_box_office_summary( language_country: str | None = "en_US", ) -> ApiResponse[Any]: """ - Title Box Office Summary (V1) - - Retrieve box office summary for a specific title. + Box Office Summary - Typical use cases: - - Analyze financial performance including budget, opening weekend, and worldwide gross. + Get IMDb title Box Office Summary data, including grosses and related performance indicators, for revenue tracking and title comparison. Args: id_: The unique IMDb ID of the title (e.g., tt12037194). @@ -357,12 +318,9 @@ def title_more_like_this_query( language_country: str | None = "en_US", ) -> ApiResponse[Any]: """ - Title Recommendations (V1) + Recommendations - Retrieve title recommendations (More Like This) for a specific title. - - Typical use cases: - - Provide users with similar content recommendations based on their interest in a specific title. + Get IMDb title Recommendations data, including related titles and suggestion metadata, for content discovery and recommendation analysis. Args: id_: The unique IMDb ID of the title (e.g., tt12037194). @@ -385,12 +343,9 @@ def main_search_query( language_country: str | None = "en_US", ) -> ApiResponse[Any]: """ - Main Search (V1) - - Perform a general search on IMDb for titles, people, and more. + Keyword Search - Typical use cases: - - Search for a movie by name or find a celebrity's profile. + Get IMDb keyword Search data, including matched results, metadata, and ranking signals, for entity discovery and entertainment research. Args: search_term: The term to search for (e.g., 'fire'). @@ -414,12 +369,9 @@ def streaming_picks_query( language_country: str | None = "en_US", ) -> ApiResponse[Any]: """ - Streaming Picks (V1) + Streaming Picks - Retrieve streaming recommendations curated by IMDb. - - Typical use cases: - - Browse popular and recommended content available on streaming services. + Get IMDb streaming Picks data, including curated titles available across streaming surfaces, for content discovery and watchlist research. Args: language_country: Language and country preferences. Available Values: - `en_US`: English (US) - `fr_CA`: French (Canada) - `fr_FR`: French (France) - `de_DE`: German (Germany) - `hi_IN`: Hindi (India) - `it_IT`: Italian (Italy) - `pt_BR`: Portuguese (Brazil) - `es_ES`: Spanish (Spain) - `es_US`: Spanish (US) - `es_MX`: Spanish (Mexico) @@ -438,12 +390,9 @@ def news_by_category_query( language_country: str | None = "en_US", ) -> ApiResponse[Any]: """ - News by Category (V1) - - Retrieve entertainment news articles filtered by category. + News by Category - Typical use cases: - - Stay updated on movie, TV, or celebrity news. + Get IMDb news by Category data, including headlines, summaries, and source metadata, for media monitoring and news research. Args: category: News category to filter by. Available Values: - `TOP`: Top News - `MOVIE`: Movie News - `TV`: TV News - `CELEBRITY`: Celebrity News @@ -464,12 +413,9 @@ def title_chart_rankings( language_country: str | None = "en_US", ) -> ApiResponse[Any]: """ - Title Chart Rankings (V1) + Chart Rankings - Retrieve title rankings from IMDb charts (e.g., Top 250). - - Typical use cases: - - View the highest-rated movies and TV shows of all time. + Get IMDb title Chart Rankings data, including positions in lists such as Top 250 and related charts, for ranking monitoring and title benchmarking. Args: rankings_chart_type: Type of rankings chart to retrieve. Available Values: - `TOP_250`: Top 250 Movies - `TOP_250_TV`: Top 250 TV Shows @@ -490,12 +436,9 @@ def title_countries_of_origin( language_country: str | None = "en_US", ) -> ApiResponse[Any]: """ - Title Countries of Origin (V1) - - Retrieve the countries of origin for a specific title. + Countries of Origin - Typical use cases: - - Identify the production locations and international roots of a movie or TV show. + Get IMDb title Countries of Origin data, including country names and regional metadata, for catalog enrichment and regional content analysis. Args: id_: The unique IMDb ID of the title (e.g., tt12037194). diff --git a/justoneapi/generated/resources/instagram.py b/justoneapi/generated/resources/instagram.py index 41055670..2bab8d8f 100644 --- a/justoneapi/generated/resources/instagram.py +++ b/justoneapi/generated/resources/instagram.py @@ -15,14 +15,9 @@ def get_user_detail_v1( username: str, ) -> ApiResponse[Any]: """ - User Details (V1) + User Profile - Retrieves public profile information of an Instagram user, including follower count, following count, post count, and basic profile details. - - Typical use cases: - - Obtaining basic account metadata for influencer vetting - - Tracking follower growth and audience reach over time - - Mapping user handles to specific profile stats + Get Instagram user Profile data, including follower count, following count, and post count, for obtaining basic account metadata for influencer vetting, tracking follower growth and audience reach over time, and mapping user handles to specific profile stats. Args: username: The Instagram username whose profile details are to be retrieved. @@ -40,14 +35,9 @@ def get_post_detail_v1( code: str, ) -> ApiResponse[Any]: """ - Post Details (V1) - - Retrieves detailed information of a public Instagram post by post code, including post caption, media content (images/videos), publish time, and engagement metrics such as likes and comments. + Post Details - Typical use cases: - - Analyzing engagement metrics (likes/comments) for a specific post - - Archiving post content and media assets for content analysis - - Verifying post details via the unique shortcode + Get Instagram post Details data, including post caption, media content (images/videos), and publish time, for analyzing engagement metrics (likes/comments) for a specific post and archiving post content and media assets for content analysis. Args: code: The unique shortcode (slug) for the Instagram post (e.g., 'DRhvwVLAHAG'). @@ -66,14 +56,9 @@ def get_user_posts_v1( pagination_token: str | None = "", ) -> ApiResponse[Any]: """ - User Published Posts (V1) - - Retrieves a list of public posts published by an Instagram user, including post code, caption, media type, publish time, and basic engagement metrics. + User Published Posts - Typical use cases: - - Monitoring recent publishing activity of a specific user - - Building a historical record of content for auditing or analysis - - Collecting post identifiers for deeper engagement analysis + Get Instagram user Published Posts data, including post code, caption, and media type, for monitoring recent publishing activity of a specific user and building a historical record of content for auditing or analysis. Args: username: The Instagram username whose published posts are to be retrieved. @@ -94,14 +79,9 @@ def search_reels_v1( pagination_token: str | None = "", ) -> ApiResponse[Any]: """ - Reels Search (V1) + Reels Search - Allows you to search public Instagram Reels by keyword or hashtag. It returns detailed information for each matched post, including post ID, caption, author profile, publish time, and engagement metrics. - - Typical use cases: - - Tracking trends and viral content via specific keywords or hashtags - - Discovering high-engagement Reels within a particular niche - - Monitoring brand mentions and campaign hashtags + Get Instagram reels Search data, including post ID, caption, and author profile, for tracking trends and viral content via specific keywords or hashtags and discovering high-engagement reels within a particular niche. Args: keyword: The search keyword or hashtag to filter Reels. @@ -122,14 +102,9 @@ def search_hashtag_posts_v1( end_cursor: str | None = "", ) -> ApiResponse[Any]: """ - Hashtag Posts Search (V1) - - Searches public Instagram posts by keyword or hashtag. It returns a list of matched posts with metadata including caption, author profile, publish time, and media links. + Hashtag Posts Search - Typical use cases: - - Competitive analysis of trending topics and hashtags - - Monitoring community discussions and public opinion on specific tags - - Aggregating user-generated content for specific campaigns + Get Instagram hashtag Posts Search data, including caption, author profile, and publish time, for competitive analysis of trending topics and hashtags and monitoring community discussions and public opinion on specific tags. Args: hashtag: The hashtag or keyword to search for. diff --git a/justoneapi/generated/resources/jd.py b/justoneapi/generated/resources/jd.py index cbeff788..410614d9 100644 --- a/justoneapi/generated/resources/jd.py +++ b/justoneapi/generated/resources/jd.py @@ -7,7 +7,7 @@ class JdResource(BaseResource): - """Generated resource for JD.""" + """Generated resource for JD.com.""" def get_item_detail_v1( self, @@ -15,18 +15,9 @@ def get_item_detail_v1( item_id: str, ) -> ApiResponse[Any]: """ - Product Details (V1) + Product Details - Retrieves product detail data for JD.com items, including basic metadata (title, item ID), - media assets (images), shop information, item status, and pricing. - - Typical use cases: - - Building product catalogs and enriching item content - - E-commerce analytics and competitor tracking - - General product lookup and verification - - Highlights - - Price accuracy: The after-coupon (coupon-discounted) price is not accurate(Non-login version). + Get JD.com product Details data, including pricing, images, and shop information, for catalog analysis, product monitoring, and ecommerce research. Args: item_id: A unique product identifier on JD.com (item ID). @@ -45,17 +36,9 @@ def get_item_comments_v1( page: str | None = None, ) -> ApiResponse[Any]: """ - Product Comments (V1) - - Retrieves customer reviews (comments) for a specific JD.com (China) product by item ID. - It returns review content, rating/score, review time, user/display info (if available), and paging data. + Product Comments - Typical use cases: - - Review & sentiment monitoring: track comment volume and rating shifts. - - Public opinion analysis: analyze negative/positive feedback signals. - - Highlights - - Page limit: The maximum page number supported is 8. + Get JD.com product Comments data, including ratings, timestamps, and reviewer signals, for customer feedback analysis and product research. Args: item_id: A unique product identifier on JD.com (item ID). @@ -76,14 +59,9 @@ def get_shop_item_list_v1( page: str | None = None, ) -> ApiResponse[Any]: """ - Shop Product List (V1) - - Retrieves the product list for a specific JD.com (China) shop. - It returns items available in the shop, typically including basic product information such as item ID, title, price, sales-related data, image, and paging data. + Shop Product List - Typical use cases: - - Shop catalog monitoring: track product assortments and newly listed items for a target shop. - - Competitive analysis: analyze a shop’s product lineup, pricing, and listing changes over time. + Get JD.com shop Product List data, including item titles, prices, and images, for catalog tracking and seller research. Args: shop_id: A unique shop identifier on JD.com (Shop ID). diff --git a/justoneapi/generated/resources/kuaishou.py b/justoneapi/generated/resources/kuaishou.py index 8c413b32..f5577202 100644 --- a/justoneapi/generated/resources/kuaishou.py +++ b/justoneapi/generated/resources/kuaishou.py @@ -16,14 +16,9 @@ def search_user_v2( page: int | None = 1, ) -> ApiResponse[Any]: """ - User Search (V2) + User Search - Enhanced user search for Kuaishou, returning detailed user profiles with nickname, - avatar, follower count, and bio. - - Typical use cases: - - Creator discovery and influencer analytics - - Market research on specific content domains + Get Kuaishou user Search data, including profile names, avatars, and follower counts, for creator discovery and account research. Args: keyword: The search keyword to find users. @@ -44,14 +39,9 @@ def get_user_video_list_v2( pcursor: str | None = None, ) -> ApiResponse[Any]: """ - User Published Videos (V2) + User Published Videos - Retrieves a list of videos posted by a specific Kuaishou user, including video ID, - cover image, publish time, and engagement metrics. - - Typical use cases: - - Content analysis for specific creators - - Monitoring video performance and engagement trends + Get Kuaishou user Published Videos data, including covers, publish times, and engagement metrics, for creator monitoring and content performance analysis. Args: user_id: The unique user ID on Kuaishou. @@ -71,17 +61,12 @@ def get_video_details_v2( video_id: str, ) -> ApiResponse[Any]: """ - Video Details (V2) + Video Details - Provides detailed information about a specific Kuaishou video, including video URL, - caption, author info, publish time, and engagement metrics (likes, comments, shares). - - Typical use cases: - - In-depth content performance analysis - - Building databases of viral videos + Get Kuaishou video Details data, including video URL, caption, and author info, for in-depth content performance analysis and building databases of viral videos. Args: - video_id: The unique ID of the Kuaishou video. + video_id: The unique ID of the Kuaishou video, e.g. `3xg9avuebhtfcku` """ return self._get( "/api/kuaishou/get-video-detail/v2", @@ -97,14 +82,9 @@ def search_video_v2( page: int | None = 1, ) -> ApiResponse[Any]: """ - Video Search (V2) - - Enables searching for Kuaishou videos by keyword, returning matched results with video ID, - cover image, description, author info, publish time, and engagement metrics. + Video Search - Typical use cases: - - Competitive analysis and market trends - - Keywords monitoring and brand tracking + Get Kuaishou video Search data, including video ID, cover image, and description, for competitive analysis and market trends and keywords monitoring and brand tracking. Args: keyword: The search keyword to find videos. @@ -124,14 +104,9 @@ def get_user_profile_v1( user_id: str, ) -> ApiResponse[Any]: """ - User Profile (V1) - - Retrieves detailed profile information of a Kuaishou user, including nickname, - avatar, follower count, verification status, and bio. + User Profile - Typical use cases: - - Creator research and building creator profiles - - Monitoring audience growth and account status + Get Kuaishou user Profile data, including account metadata, audience metrics, and verification-related fields, for creator research and building creator profiles and monitoring audience growth and account status. Args: user_id: The unique user ID on Kuaishou. @@ -149,12 +124,9 @@ def share_link_resolution_v1( share_url: str, ) -> ApiResponse[Any]: """ - Share Link Resolution (V1) + Share Link Resolution - Converts Kuaishou short share URLs to structured data. - - Typical use cases: - - Resolving shared links for automated content processing + Get Kuaishou share Link Resolution data, including resolved content identifier and target object data, for resolving shared links for automated content processing. Args: share_url: Kuaishou share URL (must start with 'https://v.kuaishou.com/'). @@ -169,11 +141,11 @@ def share_link_resolution_v1( def get_video_comments_v1( self, *, - photo_id: str, + video_id: str, pcursor: str | None = None, ) -> ApiResponse[Any]: """ - Video Comments (V1) + Video Comments Retrieves public comments of a Kuaishou video, including comment content, author info, like count, and reply count. @@ -183,13 +155,13 @@ def get_video_comments_v1( - Gathering engagement data for specific videos Args: - photo_id: The unique numeric photo ID of the video. + video_id: The unique ID of the Kuaishou video, e.g. `3xbknvct79h46h9` pcursor: Pagination cursor for subsequent pages. """ return self._get( "/api/kuaishou/get-video-comment/v1", { - "photoId": photo_id, + "videoId": video_id, "pcursor": pcursor, }, ) diff --git a/justoneapi/generated/resources/reddit.py b/justoneapi/generated/resources/reddit.py index 38e31ff6..fe8658a3 100644 --- a/justoneapi/generated/resources/reddit.py +++ b/justoneapi/generated/resources/reddit.py @@ -15,16 +15,9 @@ def get_post_detail_v1( post_id: str, ) -> ApiResponse[Any]: """ - Post Details (V1) + Post Details - Retrieves comprehensive information of a specific Reddit post by its unique ID. - Includes the post content (text or link), author details, subreddit information, - and engagement statistics like upvotes, downvotes, and comment counts. - - Typical use cases - - Sentiment analysis for brands, products, or topics - - Tracking public engagement with specific pieces of content - - Content archiving and metadata analysis + Get Reddit post Details data, including author details, subreddit info, and engagement counts, for content analysis, moderation research, and monitoring. Args: post_id: The unique identifier of the Reddit post (e.g., 't3_1q4aqti'). @@ -43,19 +36,9 @@ def get_post_comments_v1( cursor: str | None = "", ) -> ApiResponse[Any]: """ - Post Comments (V1) - - Fetches the discussion thread (comments) for a specific Reddit post by its ID. - The results are returned as a paginated list of comment objects, including the text, - author, and other metadata for each response. - - Typical use cases - - Mining customer feedback and reviews - - Understanding community sentiment through detailed discussions - - Tracking the evolution of topics within a thread + Post Comments - Highlights - - Pagination is supported via the 'cursor' parameter. + Get Reddit post Comments data, including text, authors, and timestamps, for discussion analysis and moderation research. Args: post_id: The unique identifier of the Reddit post. @@ -76,18 +59,9 @@ def search_v1( after: str | None = "", ) -> ApiResponse[Any]: """ - Search (V1) - - Performs a search for posts on Reddit based on specified keywords. - Retrieves matching posts along with their metadata and basic engagement metrics. - - Typical use cases - - Discovering new discussions or trends on specific topics - - Competitive intelligence and brand monitoring - - Researching community activity across the platform + Keyword Search - Highlights - - Results can be paginated using the 'after' parameter. + Get Reddit keyword Search data, including titles, authors, and subreddit context, for topic discovery and monitoring. Args: keyword: Search query keywords. diff --git a/justoneapi/generated/resources/search.py b/justoneapi/generated/resources/search.py index 85a07f8b..5e6d91e2 100644 --- a/justoneapi/generated/resources/search.py +++ b/justoneapi/generated/resources/search.py @@ -7,7 +7,7 @@ class SearchResource(BaseResource): - """Generated resource for Search.""" + """Generated resource for Social Media.""" def search_v1( self, @@ -19,20 +19,9 @@ def search_v1( next_cursor: str | None = None, ) -> ApiResponse[Any]: """ - Unified Search (V1) + Cross-Platform Search - Retrieves social media data across all supported platforms (Weibo, Weixin, Douyin, Xiaohongshu, etc.) - based on the provided keyword and time range. This non-real-time search provides a - comprehensive view of cross-platform social sentiment and trends. - - Typical use cases: - - Analyzing brand mentions across different social ecosystems - - Comparative sentiment monitoring between platforms - - Historical keyword tracking within an 84-day window - - Highlights - - Time range limit: Data is restricted to the last 84 days from the current date. - - Non-real-time: Results are not indexed in real-time and may have a delay. + Get cross-platform social media search data, including Xiaohongshu, Douyin, Kuaishou, WeChat, Bilibili, Weibo and Zhihu results, for trend research and monitoring. Args: keyword: Search query string. Supports: - Multiple keywords (AND): keyword1 keyword2 - Multiple keywords (OR): keyword1~keyword2 - Excluded keywords (NOT): required_keyword -excluded_keyword diff --git a/justoneapi/generated/resources/taobao.py b/justoneapi/generated/resources/taobao.py index 9cbeeb82..cd0a0365 100644 --- a/justoneapi/generated/resources/taobao.py +++ b/justoneapi/generated/resources/taobao.py @@ -7,7 +7,7 @@ class TaobaoResource(BaseResource): - """Generated resource for Taobao & Tmall.""" + """Generated resource for Taobao and Tmall.""" def get_item_detail_v1( self, @@ -15,19 +15,9 @@ def get_item_detail_v1( item_id: str, ) -> ApiResponse[Any]: """ - Product Details (V1) + Product Details - Retrieves product detail data for Taobao/Tmall items, including basic metadata (title, item ID, category), - media assets (images), shop information, item status, and pricing. - - Typical use cases: - - Building product catalogs and enriching item content (e.g., images) - - E-commerce analytics and competitor tracking - - General product lookup and verification - - Highlights - - Some items are not supported; in that case the response business code is 202 and retrying will not help. - - After-coupon (coupon-discounted) price is not guaranteed: some items may miss it or return an imprecise value. + Get Taobao and Tmall product Details data, including pricing, images, and shop details, for product research, catalog monitoring, and ecommerce analysis. Args: item_id: AUnique product identifier on Taobao/Tmall (item ID). @@ -39,55 +29,15 @@ def get_item_detail_v1( }, ) - def get_item_detail_v3( - self, - *, - item_id: str, - ) -> ApiResponse[Any]: - """ - Product Details (V3) - - Retrieves product detail data for Taobao/Tmall items, including basic metadata (title, item ID, category), - media assets (images), shop information, item status, and pricing. - - Typical use cases: - - Price monitoring and promotion tracking - - Building product catalogs and enriching item content (e.g., images) - - E-commerce analytics and competitor tracking - - Highlights - - App-based data source. - - Accurate after-coupon (coupon-discounted) price. - - Works across all items supported by this endpoint. - - Args: - item_id: AUnique product identifier on Taobao/Tmall (item ID). - """ - return self._get( - "/api/taobao/get-item-detail/v3", - { - "itemId": item_id, - }, - ) - def get_item_detail_v4( self, *, item_id: str, ) -> ApiResponse[Any]: """ - Product Details (V4) - - Retrieves product detail data for Taobao/Tmall items, including basic metadata (title, item ID, category), - media assets (images), shop information, item status, and pricing. - - Typical use cases: - - Building product catalogs and enriching item content (e.g., images) - - E-commerce analytics and competitor tracking - - General product lookup and verification + Product Details - Highlights - - Accurate after-coupon price is available, but detailed coupon information is not included. + Get Taobao and Tmall product Details data, including pricing, images, and shop details, for product research, catalog monitoring, and ecommerce analysis. Args: item_id: AUnique product identifier on Taobao/Tmall (item ID). @@ -105,20 +55,9 @@ def get_item_detail_v5( item_id: str, ) -> ApiResponse[Any]: """ - Product Details (V5) + Product Details - Retrieves product detail data for Taobao/Tmall items, including basic metadata (title, item ID, category), - media assets (images), shop information, item status, and pricing. - - Typical use cases: - - Building product catalogs and enriching item content (e.g., images) - - E-commerce analytics and competitor tracking - - General product lookup and verification - - Highlights - - Some items are not supported. Unsupported items and transient collection failures may both return business code = 301. - - Retry is not meant to be unlimited. A small number of retries (e.g., up to 5 attempts) is recommended. - If it still returns code = 301, treat the item as unsupported and switch to another item or endpoint. + Get Taobao and Tmall product Details data, including pricing, images, and shop details, for product research, catalog monitoring, and ecommerce analysis. Args: item_id: AUnique product identifier on Taobao/Tmall (item ID). @@ -136,19 +75,9 @@ def get_item_detail_v9( item_id: str, ) -> ApiResponse[Any]: """ - Product Details (V9) - - Retrieves product detail data for Taobao/Tmall items, including basic metadata (title, item ID, category), - media assets (images), shop information, item status, and pricing. - - Typical use cases: - - Building product catalogs and enriching item content (e.g., images) - - E-commerce analytics and competitor tracking - - General product lookup and verification + Product Details - Highlights - - Some items are not supported; in that case the response business code is 202 and retrying will not help. - - After-coupon (coupon-discounted) price is not guaranteed: some items may miss it or return an imprecise value. + Get Taobao and Tmall product Details data, including pricing, images, and shop details, for product research, catalog monitoring, and ecommerce analysis. Args: item_id: AUnique product identifier on Taobao/Tmall (item ID). @@ -168,16 +97,9 @@ def get_item_comment_v3( page: int | None = 1, ) -> ApiResponse[Any]: """ - Product Reviews (V3) + Product Reviews - Retrieves user reviews for a Taobao/Tmall item, including review text, publish time, - author info (when available), rating/likes (if present), and other review metadata. Supports pagination. - - Typical use cases: - - Review and sentiment monitoring - - Tracking rating/review volume changes over time - - Collecting feedback for product/competitor analysis - - Building datasets for NLP or customer-insight workflows + Get Taobao and Tmall product Reviews data, including ratings, timestamps, and reviewer signals, for feedback analysis and product research. Args: item_id: AUnique product identifier on Taobao/Tmall (item ID). @@ -201,19 +123,9 @@ def get_shop_item_list_v1( page: int | None = 1, ) -> ApiResponse[Any]: """ - Shop Product List (V1) - - Retrieves a paginated list of products under a Taobao/Tmall shop, including basic product metadata - (e.g., item ID, title, price, images when available) and listing status. + Shop Product List - Typical use cases: - - Monitoring a shop's assortment and new/removed products - - Building shop-level catalogs and scheduled collection pipelines - - Competitor shop tracking and e-commerce analytics - - Highlights - - An empty product list may mean either: the shop has no products, or the shop is not supported by this endpoint. - If the list is empty, verify with another shop or use an alternative endpoint if available. + Get Taobao and Tmall shop Product List data, including item titles, prices, and images, for seller research and catalog tracking. Args: user_id: Shop identifier. Also known as Seller ID or User ID (they refer to the same value). @@ -238,19 +150,9 @@ def get_shop_item_list_v2( page: int | None = 1, ) -> ApiResponse[Any]: """ - Shop Product List (V2) - - Retrieves a paginated list of products under a Taobao/Tmall shop, including basic product metadata - (e.g., item ID, title, price, images when available) and listing status. + Shop Product List - Typical use cases: - - Monitoring a shop's assortment and new/removed products - - Building shop-level catalogs and scheduled collection pipelines - - Competitor shop tracking and e-commerce analytics - - Highlights - - An empty product list may mean either: the shop has no products, or the shop is not supported by this endpoint. - If the list is empty, verify with another shop or use an alternative endpoint if available. + Get Taobao and Tmall shop Product List data, including item titles, prices, and images, for seller research and catalog tracking. Args: user_id: Shop identifier. Also known as Seller ID or User ID (they refer to the same value). @@ -277,18 +179,9 @@ def get_shop_item_list_v3( page: int | None = 1, ) -> ApiResponse[Any]: """ - Shop Product List (V3) - - Retrieves a paginated list of products under a Taobao/Tmall shop, including basic product metadata - (e.g., item ID, title, price, images when available) and listing status. + Shop Product List - Typical use cases: - - Monitoring a shop's assortment and new/removed products - - Building shop-level catalogs and scheduled collection pipelines - - Competitor shop tracking and e-commerce analytics - - Highlights - - Works across all shops supported by this endpoint. + Get Taobao and Tmall shop Product List data, including item titles, prices, and images, for seller research and catalog tracking. Args: user_id: Shop identifier. Also known as Seller ID or User ID (they refer to the same value). @@ -317,16 +210,9 @@ def search_item_list_v1( page: int | None = 1, ) -> ApiResponse[Any]: """ - Product Search (V1) - - Searches Taobao/Tmall products by keyword and optional filters, returning a paginated result set - with basic product metadata (e.g., item ID, title, price, images when available) and listing status. + Product Search - Typical use cases: - - Discovering products for analysis or monitoring - - Building watchlists by keyword/category - - Market and competitor research - - Feeding downstream pipelines (detail collection, price tracking) + Get Taobao and Tmall product Search data, including titles, prices, and images, for product discovery. Args: keyword: Search keyword. diff --git a/justoneapi/generated/resources/tiktok.py b/justoneapi/generated/resources/tiktok.py index f304876f..b4fba61c 100644 --- a/justoneapi/generated/resources/tiktok.py +++ b/justoneapi/generated/resources/tiktok.py @@ -17,16 +17,9 @@ def get_user_post_v1( sort: str | None = "_0", ) -> ApiResponse[Any]: """ - User Published Posts (V1) + User Published Posts - Retrieve a list of posts published by a specific TikTok user. - The API returns detailed information about each post, including video ID, description, publish time, - statistics (likes, comments, shares, views), and video download URL if available. - - Typical use cases: - - User activity analysis and posting frequency tracking. - - Influencer performance evaluation. - - Content trend monitoring for specific creators. + Get TikTok user Published Posts data, including video ID, description, and publish time, for user activity analysis and posting frequency tracking, influencer performance evaluation, and content trend monitoring for specific creators. Args: sec_uid: The unique security ID of the TikTok user (e.g., MS4wLjABAAAAonP2...). @@ -48,16 +41,9 @@ def get_post_detail_v1( post_id: str, ) -> ApiResponse[Any]: """ - Post Details (V1) - - Retrieve detailed information for a specific TikTok post by its post ID. - The API returns complete metadata including video ID, author information, description text, publish time, - engagement metrics (likes, comments, shares, views), and available download URLs for both the video and cover image. + Post Details - Typical use cases: - - Content performance analysis and metadata extraction. - - Influencer evaluation via specific post metrics. - - Verifying post authenticity and downloading media for offline analysis. + Get TikTok post Details data, including video ID, author information, and description text, for content performance analysis and metadata extraction and influencer evaluation via specific post metrics. Args: post_id: The unique ID of the TikTok post. @@ -76,19 +62,9 @@ def get_user_detail_v1( sec_uid: str | None = "", ) -> ApiResponse[Any]: """ - User Profile (V1) - - Retrieve detailed profile information for a specific TikTok user by user ID. - The API returns comprehensive data including nickname, unique ID, avatar, bio, follower/following counts, - total likes, and other engagement indicators. - - Typical use cases: - - Influencer profiling and audience analysis. - - Account performance tracking and growth monitoring. - - Identifying verified status and official accounts. + User Profile - Notes: - - You must provide either 'uniqueId' or 'secUid'. + Get TikTok user Profile data, including nickname, unique ID, and avatar, for influencer profiling and audience analysis, account performance tracking and growth monitoring, and identifying verified status and official accounts. Args: unique_id: The unique handle/username of the user (e.g., 'tiktok'). @@ -109,16 +85,9 @@ def get_post_comment_v1( cursor: str | None = "0", ) -> ApiResponse[Any]: """ - Post Comments (V1) + Post Comments - Retrieve a list of comments under a specific TikTok post by post ID. - The API returns detailed information for each comment, including comment ID, user information, - text content, like count, reply count, and publish time. - - Typical use cases: - - Sentiment analysis of the audience's reaction to specific content. - - Engagement measurement via comment volume and quality. - - Community interaction research and feedback collection. + Get TikTok post Comments data, including comment ID, user information, and text content, for sentiment analysis of the audience's reaction to specific content and engagement measurement via comment volume and quality. Args: aweme_id: The unique ID of the TikTok post (awemeId). @@ -140,16 +109,9 @@ def get_post_sub_comment_v1( cursor: str | None = "0", ) -> ApiResponse[Any]: """ - Comment Replies (V1) - - Retrieve a list of replies under a specific TikTok comment by comment ID. - The API returns detailed information for each reply, including reply ID, user information, - text content, like count, and publish time. + Comment Replies - Typical use cases: - - Understanding detailed user interactions and threaded discussions. - - Identifying influencers or active participants within a comment section. - - Tracking sentiment propagation within comment threads. + Get TikTok comment Replies data, including reply ID, user information, and text content, for understanding detailed user interactions and threaded discussions and identifying influencers or active participants within a comment section. Args: aweme_id: The unique ID of the TikTok post. @@ -173,16 +135,9 @@ def search_user_v1( search_id: str | None = "", ) -> ApiResponse[Any]: """ - User Search (V1) + User Search - Search for TikTok users by keyword. - The API returns a list of matching users along with basic profile information such as user ID, - nickname, unique handle, avatar, bio, follower count, and verification status. - - Typical use cases: - - Discovering influencers in specific niches via keywords. - - Identifying target audiences and conducting competitor research. - - Finding official brand accounts. + Get TikTok user Search data, including basic profile information such as user ID, nickname, and unique handle, for discovering influencers in specific niches via keywords and identifying target audiences and conducting competitor research. Args: keyword: Search keywords (e.g., 'deepseek'). @@ -208,16 +163,9 @@ def search_post_v1( region: str | None = "US", ) -> ApiResponse[Any]: """ - Post Search (V1) - - Search for TikTok posts by keyword. - The API returns a list of matching posts with key details such as video ID, description, - author information, publish time, and engagement metrics (likes, comments, shares, views). + Post Search - Typical use cases: - - Trend monitoring and content discovery. - - Keyword-based market analysis and sentiment tracking. - - Identifying viral content related to specific topics. + Get TikTok post Search data, including key details such as video ID, description, and author information, for trend monitoring and content discovery and keyword-based market analysis and sentiment tracking. Args: keyword: Search keywords (e.g., 'deepseek'). diff --git a/justoneapi/generated/resources/tiktok_shop.py b/justoneapi/generated/resources/tiktok_shop.py index 2e5dac63..336487fc 100644 --- a/justoneapi/generated/resources/tiktok_shop.py +++ b/justoneapi/generated/resources/tiktok_shop.py @@ -18,15 +18,9 @@ def search_products_v1( page_token: str | None = None, ) -> ApiResponse[Any]: """ - Search Products (V1) + Product Search - Searches for products on TikTok Shop based on the provided keyword and region. - It returns a list of products including title, price, sales, and other metadata. - - Typical use cases: - - Market research and trend analysis - - Competitor product discovery - - Monitoring product popularity in specific regions + Get TikTok Shop product Search data, including title, price, and sales, for market research and trend analysis, competitor product discovery, and monitoring product popularity in specific regions. Args: keyword: Search keyword. @@ -51,15 +45,9 @@ def get_product_detail_v1( region: str | None = "US", ) -> ApiResponse[Any]: """ - Product Detail (V1) - - Retrieves detailed information for a specific product on TikTok Shop based on the provided product ID and region. - It returns comprehensive product data including title, description, price, stock, and media. + Product Details - Typical use cases: - - Building product catalogs - - Price and stock monitoring - - In-depth product analysis + Get TikTok Shop product Details data, including title, description, and price, for building product catalogs, price and stock monitoring, and in-depth product analysis. Args: product_id: TikTok Shop Product ID. diff --git a/justoneapi/generated/resources/toutiao.py b/justoneapi/generated/resources/toutiao.py index ccc2c69f..0617c30c 100644 --- a/justoneapi/generated/resources/toutiao.py +++ b/justoneapi/generated/resources/toutiao.py @@ -15,15 +15,9 @@ def get_article_detail_v1( id_: str, ) -> ApiResponse[Any]: """ - Article Details (V1) + Article Details - Retrieve detailed information for a specific Toutiao (Jinri Toutiao) article by its article ID. - - The API returns complete metadata including article ID, title, author information, publish time, content text or summary, engagement metrics (views, comments, likes, shares), and the article URL. - - Typical use cases: - - Content performance analysis and media monitoring. - - Verifying article authenticity and metadata retrieval. + Get Toutiao article Details data, including article ID, title, and author information, for content performance analysis and media monitoring and verifying article authenticity and metadata retrieval. Args: id_: The unique identifier of the Toutiao article. @@ -41,15 +35,9 @@ def get_user_detail_v1( user_id: str, ) -> ApiResponse[Any]: """ - User Profile (V1) - - Retrieve detailed information for a specific Toutiao (Jinri Toutiao) user by their user ID. + User Profile - The API returns comprehensive profile metadata including user ID, nickname, avatar, bio/description, verification status, follower and following counts, total likes, and total published articles or videos. - - Typical use cases: - - Influencer profiling and audience analysis. - - Monitoring creator performance and growth. + Get Toutiao user Profile data, including user ID, nickname, and avatar, for influencer profiling and audience analysis and monitoring creator performance and growth. Args: user_id: The unique identifier of the Toutiao user. @@ -69,15 +57,9 @@ def search_v1( search_id: str | None = "", ) -> ApiResponse[Any]: """ - Search (V1) - - Perform a keyword-based search on Toutiao (Jinri Toutiao) App to retrieve a list of matching articles, videos, and other content. + App Keyword Search - The API returns detailed search results including title, summary, author, publish time, and engagement metrics such as likes, comments, and shares. - - Typical use cases: - - Content aggregation and trend analysis. - - Media monitoring and keyword intelligence. + Get Toutiao app Keyword Search data, including matching articles, videos, and authors, for topic discovery and monitoring. Args: keyword: Search keyword or query. @@ -99,18 +81,9 @@ def search_v2( keyword: str, ) -> ApiResponse[Any]: """ - Search (V2) - - Perform a keyword-based search on Toutiao (Jinri Toutiao) PC version to retrieve a list of matching articles, videos, and other content. - - The API returns detailed search results including title, summary, author, publish time, and engagement metrics such as likes, comments, and shares. - - Typical use cases: - - Content aggregation and trend analysis. - - Media monitoring and keyword intelligence. + Web Keyword Search - Highlights - - This is the PC version of the search API. Note that it currently only supports retrieving the first page of results. + Get Toutiao web Keyword Search data, including this is the PC version of the search API. Note that it currently only supports retrieving the first page of results, for first-page discovery of articles, videos, and authors for trend research and monitoring. Args: keyword: Search keyword or query. diff --git a/justoneapi/generated/resources/twitter.py b/justoneapi/generated/resources/twitter.py index 396a9b8a..51f34af0 100644 --- a/justoneapi/generated/resources/twitter.py +++ b/justoneapi/generated/resources/twitter.py @@ -7,7 +7,7 @@ class TwitterResource(BaseResource): - """Generated resource for X(Twitter).""" + """Generated resource for Twitter.""" def get_user_detail_v1( self, @@ -15,14 +15,9 @@ def get_user_detail_v1( rest_id: str, ) -> ApiResponse[Any]: """ - User Details (V1) + User Profile - Retrieves basic public information for a specific X (Twitter) user using their Rest ID. - - Typical use cases: - - Accessing user profile metadata (e.g., description, location, verification status). - - Collecting follower and following counts. - - Verifying account details for identity confirmation. + Get Twitter user Profile data, including account metadata, audience metrics, and verification-related fields, for accessing user profile metadata (e.g., description, location, verification status) and collecting follower and following counts. Args: rest_id: The unique numeric identifier (Rest ID) for the X user. @@ -41,17 +36,9 @@ def get_user_posts_v1( cursor: str | None = "", ) -> ApiResponse[Any]: """ - User Published Posts (V1) - - Retrieves the public tweet timeline (posts) for a specific X (Twitter) user. - - Typical use cases: - - Monitoring recent activity of influential accounts. - - Collecting tweets for archival or content analysis. - - Tracking engagement on specific user-generated content. + User Published Posts - Highlights: - - Supports pagination via cursor for large datasets. + Get Twitter user Published Posts data, including post content, timestamps, and engagement data, for account monitoring and content analysis. Args: rest_id: The unique numeric identifier (Rest ID) for the X user. diff --git a/justoneapi/generated/resources/web.py b/justoneapi/generated/resources/web.py new file mode 100644 index 00000000..6e4ceb3d --- /dev/null +++ b/justoneapi/generated/resources/web.py @@ -0,0 +1,70 @@ +from __future__ import annotations + +from typing import Any + +from justoneapi._resource import BaseResource +from justoneapi._response import ApiResponse + + +class WebResource(BaseResource): + """Generated resource for Web Page.""" + + def html_v1( + self, + *, + url: str, + ) -> ApiResponse[Any]: + """ + HTML Content + + Get the HTML content of a web page. + + Args: + url: The URL of the web page to fetch. + """ + return self._get( + "/api/web/html/v1", + { + "url": url, + }, + ) + + def rendered_html_v1( + self, + *, + url: str, + ) -> ApiResponse[Any]: + """ + Rendered HTML Content + + Get the Rendered HTML content of a web page. + + Args: + url: The URL of the web page to fetch. + """ + return self._get( + "/api/web/rendered-html/v1", + { + "url": url, + }, + ) + + def markdown_v1( + self, + *, + url: str, + ) -> ApiResponse[Any]: + """ + Markdown Content + + Get the Markdown content of a web page. + + Args: + url: The URL of the web page to fetch. + """ + return self._get( + "/api/web/markdown/v1", + { + "url": url, + }, + ) diff --git a/justoneapi/generated/resources/weibo.py b/justoneapi/generated/resources/weibo.py index 3e0fc19c..f9bb67ff 100644 --- a/justoneapi/generated/resources/weibo.py +++ b/justoneapi/generated/resources/weibo.py @@ -21,14 +21,9 @@ def search_all_v2( page: int | None = 1, ) -> ApiResponse[Any]: """ - Keyword Search (V2) + Keyword Search - Enables advanced keyword-based search on Weibo posts, supporting filters such as time range. - Returns matching posts with content, author info, publish time, and engagement metrics (likes, reposts, comments). - - Typical use cases: - - Tracking discussions around specific brands or events - - Gathering public opinion data for a specific time period + Get Weibo keyword Search data, including authors, publish times, and engagement signals, for trend monitoring. Args: q: Search Keywords. @@ -58,14 +53,9 @@ def get_weibo_details_v1( id_: str, ) -> ApiResponse[Any]: """ - Post Details (V1) - - Retrieves detailed information about a specific Weibo post, including full text content, - media assets (images/videos), author information, publish time, and engagement metrics (likes, comments, and reposts). + Post Details - Typical use cases: - - Detailed analysis of specific social media posts - - Content archival and monitoring + Get Weibo post Details data, including media, author metadata, and engagement counts, for post analysis, archiving, and campaign monitoring. Args: id_: Weibo post ID. @@ -83,14 +73,9 @@ def get_user_profile_v3( uid: str, ) -> ApiResponse[Any]: """ - User Profile (V3) - - Retrieves detailed profile information for a specified Weibo user, including nickname, avatar, - user ID, follower/following counts, bio, and verification status. + User Profile - Typical use cases: - - Creator/KOL identification and monitoring - - Enriching user records for analytics and reporting + Get Weibo user Profile data, including follower counts, verification status, and bio details, for creator research and account analysis. Args: uid: Weibo User ID (UID). @@ -109,14 +94,9 @@ def get_fans_v1( page: int | None = 1, ) -> ApiResponse[Any]: """ - User Fans (V1) + User Fans - Retrieves the follower list (fans) of a specified Weibo user with pagination. - Includes user IDs, nicknames, avatars, and verification status of followers. - - Typical use cases: - - Audience analysis and demographic research - - Monitoring follower growth and community engagement + Get Weibo user Fans data, including profile metadata and verification signals, for audience analysis and influencer research. Args: uid: Weibo User ID (UID). @@ -137,14 +117,9 @@ def get_followers_v1( page: int | None = 1, ) -> ApiResponse[Any]: """ - User Followers (V1) - - Retrieves the list of accounts that a specified Weibo user is following. - Includes user IDs, nicknames, avatars, and verification status of the followed accounts. + User Followers - Typical use cases: - - Relationship mapping and network analysis - - Identifying interests and associations of specific users + Get Weibo user Followers data, including profile metadata and verification signals, for network analysis and creator research. Args: uid: Weibo User ID (UID). @@ -166,14 +141,9 @@ def get_user_published_posts_v1( since_id: str | None = None, ) -> ApiResponse[Any]: """ - User Published Posts (V1) + User Published Posts - Retrieves the post list of a specified Weibo user with pagination. - Each entry includes status ID, text, media assets, publish time, and engagement metrics. - - Typical use cases: - - Creator monitoring and content tracking - - Building content timelines for specific accounts + Get Weibo user Published Posts data, including text, media, and publish times, for account monitoring. Args: uid: Weibo User ID (UID). @@ -195,14 +165,9 @@ def tv_component_v1( oid: str, ) -> ApiResponse[Any]: """ - TV Video Details (V1) - - Retrieves detailed information of a single Weibo TV video by its object ID. - Includes video metadata, media URLs, cover images, author info, and engagement metrics. + TV Video Details - Typical use cases: - - Video content analysis and archival - - Monitoring performance of Weibo TV videos + Get Weibo tV Video Details data, including media URLs, author details, and engagement counts, for video research, archiving, and performance analysis. Args: oid: Weibo video/object ID. @@ -218,13 +183,9 @@ def hot_search_v1( self, ) -> ApiResponse[Any]: """ - Hot Search (V1) + Hot Search - Retrieves the current hot search (trending) topics from Weibo. - - Typical use cases: - - Real-time trend monitoring - - Identifying viral topics and news + Get Weibo hot Search data, including ranking data, for trend monitoring, newsroom workflows, and topic discovery. """ return self._get( "/api/weibo/hot-search/v1", @@ -239,15 +200,9 @@ def get_post_comments_v1( max_id: str | None = None, ) -> ApiResponse[Any]: """ - Post Comments (V1) - - Retrieves comments for a specified Weibo post with pagination. - Returns comment content, comment ID, author information, publish time, and related engagement data when available. + Post Comments - Typical use cases: - - Collecting comment threads for a specific post - - Sentiment analysis and audience feedback research - - Monitoring engagement and discussion around a post + Get Weibo post Comments data, including text, authors, and timestamps, for feedback analysis. Args: mid: Weibo post mid. @@ -273,9 +228,9 @@ def search_profile_v1( page: int | None = 1, ) -> ApiResponse[Any]: """ - Search User Published Posts (V1) + Search User Published Posts - Search Weibo posts published by a specific user by keywords and time range. + Get Weibo search User Published Posts data, including matched results, metadata, and ranking signals, for author research and historical content discovery. Args: uid: Weibo User ID (UID). diff --git a/justoneapi/generated/resources/weixin.py b/justoneapi/generated/resources/weixin.py index 62e954db..e51e8622 100644 --- a/justoneapi/generated/resources/weixin.py +++ b/justoneapi/generated/resources/weixin.py @@ -7,7 +7,7 @@ class WeixinResource(BaseResource): - """Generated resource for Weixin.""" + """Generated resource for WeChat Official Accounts.""" def get_user_post( self, @@ -15,13 +15,9 @@ def get_user_post( wxid: str, ) -> ApiResponse[Any]: """ - User Published Posts (V1) + User Published Posts - Retrieves posts published by a specific Weixin Official Account, including title, author, publish time, content summary, and engagement metrics such as reads, likes, and shares. - - Typical use cases: - - Monitoring recent activity of a specific account. - - Analyzing publishing frequency and content types. + Get WeChat Official Accounts user Published Posts data, including titles, publish times, and summaries, for account monitoring. Args: wxid: The ID of the Weixin Official Account (e.g., 'rmrbwx'). @@ -39,13 +35,9 @@ def get_article_feedback( article_url: str, ) -> ApiResponse[Any]: """ - Article Engagement Metrics (V1) - - Retrieves engagement metrics for a specific Weixin Official Account article, including read count, like count, share count, and comment count. + Article Engagement Metrics - Typical use cases: - - Tracking performance of a specific post. - - Comparing engagement levels across different articles. + Get WeChat Official Accounts article Engagement Metrics data, including like, share, and comment metrics, for article performance tracking and benchmarking. Args: article_url: The URL of the Weixin article. @@ -63,13 +55,9 @@ def get_article_comment( article_url: str, ) -> ApiResponse[Any]: """ - Article Comments (V1) - - Retrieves user comments from a specific Weixin Official Account article, including commenter name, comment content, like count, and timestamp. + Article Comments - Typical use cases: - - Analyzing community sentiment and feedback. - - Identifying popular discussion points. + Get WeChat Official Accounts article Comments data, including commenter details, comment text, and timestamps, for feedback analysis. Args: article_url: The URL of the Weixin article. @@ -90,13 +78,9 @@ def search_v1( sort_type: str | None = "_0", ) -> ApiResponse[Any]: """ - Search (V1) + Keyword Search - Supports keyword-based search for both Weixin Official Accounts and their published articles. It returns matched accounts or posts with details such as account name, article title, publish time, and summary. - - Typical use cases: - - Discovering new accounts related to specific topics. - - Finding historical articles using keywords. + Get WeChat Official Accounts keyword Search data, including account names, titles, and publish times, for content discovery. Args: keyword: The search keyword. @@ -120,13 +104,9 @@ def get_article_detail_v1( article_url: str, ) -> ApiResponse[Any]: """ - Article Details (V1) - - Retrieves core metadata and content details for a specific Weixin Official Account article. + Article Details - Typical use cases: - - Scraping detailed content for archival or analysis. - - Verifying article metadata from a URL. + Get WeChat Official Accounts article Details data, including body content, for article archiving, research, and content analysis. Args: article_url: The URL of the Weixin article. diff --git a/justoneapi/generated/resources/xiaohongshu.py b/justoneapi/generated/resources/xiaohongshu.py index 02004770..89a48c52 100644 --- a/justoneapi/generated/resources/xiaohongshu.py +++ b/justoneapi/generated/resources/xiaohongshu.py @@ -7,7 +7,7 @@ class XiaohongshuResource(BaseResource): - """Generated resource for Xiaohongshu.""" + """Generated resource for Xiaohongshu (RedNote).""" def get_user_v3( self, @@ -15,15 +15,9 @@ def get_user_v3( user_id: str, ) -> ApiResponse[Any]: """ - User Profile (V3) + User Profile - Retrieves Xiaohongshu user profile data, including user identifiers and profile metadata - (e.g., nickname, avatar, bio), as well as public counters such as follower count and like count (when available). - - Typical use cases: - - Identifying creators/KOLs and building creator lists - - Enriching user records for analytics and reporting - - Creator monitoring (profile and counter changes over time) + Get Xiaohongshu (RedNote) user Profile data, including follower counts and bio details, for creator research, account analysis, and competitor monitoring. Args: user_id: Unique user identifier on Xiaohongshu. @@ -41,15 +35,9 @@ def get_user_v4( user_id: str, ) -> ApiResponse[Any]: """ - User Profile (V4) - - Retrieves Xiaohongshu user profile data, including user identifiers and profile metadata - (e.g., nickname, avatar, bio), as well as public counters such as follower count and like count (when available). + User Profile - Typical use cases: - - Identifying creators/KOLs and building creator lists - - Enriching user records for analytics and reporting - - Creator monitoring (profile and counter changes over time) + Get Xiaohongshu (RedNote) user Profile data, including follower counts and bio details, for creator research, account analysis, and competitor monitoring. Args: user_id: Unique user identifier on Xiaohongshu. @@ -68,16 +56,9 @@ def get_user_note_list_v2( last_cursor: str | None = None, ) -> ApiResponse[Any]: """ - User Published Notes (V2) - - Retrieves a paginated list of notes published by a specific Xiaohongshu user. - Each page returns basic note data (e.g., note ID, title/text snippet, publish time, cover/media info when available) - and may include engagement counters depending on availability. + User Published Notes - Typical use cases: - - Building a creator's content timeline and monitoring new posts - - Batch collection for analytics, reporting, and dataset building - - Creator/KOL and competitor monitoring + Get Xiaohongshu (RedNote) user Published Notes data, including note metadata, covers, and publish times, for account monitoring. Args: user_id: Unique user identifier on Xiaohongshu. @@ -98,16 +79,9 @@ def get_user_note_list_v4( last_cursor: str | None = None, ) -> ApiResponse[Any]: """ - User Published Notes (V4) + User Published Notes - Retrieves a paginated list of notes published by a specific Xiaohongshu user. - Each page returns basic note data (e.g., note ID, title/text snippet, publish time, cover/media info when available) - and may include engagement counters depending on availability. - - Typical use cases: - - Building a creator's content timeline and monitoring new posts - - Batch collection for analytics, reporting, and dataset building - - Creator/KOL and competitor monitoring + Get Xiaohongshu (RedNote) user Published Notes data, including note metadata, covers, and publish times, for account monitoring. Args: user_id: Unique user identifier on Xiaohongshu. @@ -127,18 +101,9 @@ def get_note_detail_v1( note_id: str, ) -> ApiResponse[Any]: """ - Note Details (V1) - - Retrieves detailed note data from Xiaohongshu, including the full note description, - engagement metrics (likes, comments, collects, shares), and media information. + Note Details - The response includes media download URLs for images and videos. - - Typical use cases: - - Content analysis and review using full note text - - Engagement tracking for creators, campaigns, and competitors - - Collecting media assets (images/videos) for downstream processing or archiving - - Building datasets for analytics, reporting, and automation + Get Xiaohongshu (RedNote) note Details data, including media and engagement metrics, for content analysis, archiving, and campaign research. Args: note_id: Unique note identifier on Xiaohongshu. @@ -156,18 +121,9 @@ def get_note_detail_v3( note_id: str, ) -> ApiResponse[Any]: """ - Note Details (V3) - - Retrieves detailed note data from Xiaohongshu, including the full note description, - engagement metrics (likes, comments, collects, shares), and media information. - - The response includes media download URLs for images and videos. + Note Details - Typical use cases: - - Content analysis and review using full note text - - Engagement tracking for creators, campaigns, and competitors - - Collecting media assets (images/videos) for downstream processing or archiving - - Building datasets for analytics, reporting, and automation + Get Xiaohongshu (RedNote) note Details data, including media and engagement metrics, for content analysis, archiving, and campaign research. Args: note_id: Unique note identifier on Xiaohongshu. @@ -185,18 +141,9 @@ def get_note_detail_v7( note_id: str, ) -> ApiResponse[Any]: """ - Note Details (V7) - - Retrieves detailed note data from Xiaohongshu, including the full note description, - engagement metrics (likes, comments, collects, shares), and media information. - - The response includes media download URLs for images and videos. + Note Details - Typical use cases: - - Content analysis and review using full note text - - Engagement tracking for creators, campaigns, and competitors - - Collecting media assets (images/videos) for downstream processing or archiving - - Building datasets for analytics, reporting, and automation + Get Xiaohongshu (RedNote) note Details data, including media and engagement metrics, for content analysis, archiving, and campaign research. Args: note_id: Unique note identifier on Xiaohongshu. @@ -216,16 +163,9 @@ def get_note_comment_v2( sort: str | None = "latest", ) -> ApiResponse[Any]: """ - Note Comments (V2) + Note Comments - Retrieves comments for a Xiaohongshu note with pagination. - The response includes comment text, publish time, commenter information (when available), - and other comment metadata. - - Typical use cases: - - Sentiment and public-opinion monitoring based on comment content - - Tracking comment volume and feedback trends over time - - Collecting discussions for analytics, reporting, and dataset building + Get Xiaohongshu (RedNote) note Comments data, including text, authors, and timestamps, for feedback analysis. Args: note_id: Unique note identifier on Xiaohongshu. @@ -247,17 +187,9 @@ def get_note_comment_v4( note_id: str, ) -> ApiResponse[Any]: """ - Note Comments (V4) - - Retrieves comments for a Xiaohongshu note. - - Typical use cases: - - Quick lookup of the latest/top comments for a note - - Comment snapshot for lightweight monitoring + Note Comments - Highlights - - This version only returns the first page of comments; subsequent pages are not available. - - If you need to fetch more pages, use the Note Comments (V2) endpoint. + Get Xiaohongshu (RedNote) note Comments data, including comment text, author profiles, and interaction data, for sentiment analysis and community monitoring. Args: note_id: Unique note identifier on Xiaohongshu. @@ -277,16 +209,9 @@ def get_note_sub_comment_v2( last_cursor: str | None = None, ) -> ApiResponse[Any]: """ - Comment Replies (V2) + Comment Replies - Retrieves replies under a specific Xiaohongshu comment (also known as second-level comments), - with pagination when supported. The response includes reply text, publish time, replier information - (when available), and other metadata. - - Typical use cases: - - Deep sentiment analysis by including comment threads - - Monitoring discussions under key comments - - Collecting reply threads for analytics, reporting, and dataset building + Get Xiaohongshu (RedNote) comment Replies data, including text, authors, and timestamps, for thread analysis and feedback research. Args: note_id: Unique note identifier on Xiaohongshu. @@ -312,16 +237,9 @@ def get_search_note_v2( note_time: str | None = None, ) -> ApiResponse[Any]: """ - Note Search (V2) - - Searches Xiaohongshu notes by keyword and optional filters, returning a paginated result set. - Each result typically includes basic note information (e.g., note ID, title/text snippet, cover/media info), - author signals (when available), and engagement counters (when available). + Note Search - Typical use cases: - - Topic/keyword research and trend analysis - - Discovering notes for monitoring, analytics, and dataset building - - Campaign and competitor content discovery + Get Xiaohongshu (RedNote) note Search data, including snippets, authors, and media, for topic discovery. Args: keyword: Search keyword. @@ -350,16 +268,9 @@ def get_search_note_v3( note_type: str | None = "_0", ) -> ApiResponse[Any]: """ - Note Search (V3) + Note Search - Searches Xiaohongshu notes by keyword and optional filters, returning a paginated result set. - Each result typically includes basic note information (e.g., note ID, title/text snippet, cover/media info), - author signals (when available), and engagement counters (when available). - - Typical use cases: - - Topic/keyword research and trend analysis - - Discovering notes for monitoring, analytics, and dataset building - - Campaign and competitor content discovery + Get Xiaohongshu (RedNote) note Search data, including snippets, authors, and media, for topic discovery. Args: keyword: Search keyword. @@ -384,16 +295,9 @@ def get_search_user_v2( page: int | None = 1, ) -> ApiResponse[Any]: """ - User Search (V2) - - Searches Xiaohongshu users by keyword, returning a paginated result set with basic profile - information (e.g., user ID, nickname, avatar, bio when available) and public counters/signals - (when available). + User Search - Typical use cases: - - Finding creators/KOLs by niche, brand, or topic keywords - - Building creator lists for monitoring and analytics - - Discovering competitor accounts and related profiles + Get Xiaohongshu (RedNote) user Search data, including profile metadata and public signals, for creator discovery and account research. Args: keyword: Search keyword. @@ -413,16 +317,9 @@ def share_url_transfer_v1( share_url: str, ) -> ApiResponse[Any]: """ - Share Link Convert (V3) + Share Link Resolution - Converts a shared RedNote note short link into a normal (resolved) note URL. - This is typically used to extract the note ID from a share link for downstream APIs - (e.g., Note Details or Note Comments). - - Typical use cases: - - Turning user-provided share links into structured identifiers (note ID) - - Normalizing links before fetching note details, media, or comments - - Automating workflows that start from share links + Get Xiaohongshu (RedNote) share Link Resolution data, including helping extract note IDs, for downstream note and comment workflows. Args: share_url: RedNote share link URL to be resolved (short link or shared URL). @@ -440,16 +337,9 @@ def search_recommend_v1( keyword: str, ) -> ApiResponse[Any]: """ - Search Keyword Suggestions (V1) - - Retrieves keyword suggestions for Xiaohongshu search. - Given an input keyword prefix, this endpoint returns a list of recommended/related search terms - that can be used to refine queries. + Keyword Suggestions - Typical use cases: - - Expanding keyword sets for content research and SEO/pSEO workflows - - Improving search coverage by using platform-recommended terms - - Building autocomplete experiences and discovery tools + Get Xiaohongshu (RedNote) keyword Suggestions data, including suggested queries, keyword variants, and query metadata, for expanding keyword sets for content research and seo/pseo workflows and improving search coverage by using platform-recommended terms. Args: keyword: Search keyword. diff --git a/justoneapi/generated/resources/xiaohongshu_pgy.py b/justoneapi/generated/resources/xiaohongshu_pgy.py index 158b7226..fb16ac14 100644 --- a/justoneapi/generated/resources/xiaohongshu_pgy.py +++ b/justoneapi/generated/resources/xiaohongshu_pgy.py @@ -7,7 +7,7 @@ class XiaohongshuPgyResource(BaseResource): - """Generated resource for Xiaohongshu Pgy.""" + """Generated resource for Xiaohongshu Creator Marketplace (Pugongying).""" def api_solar_cooperator_user_blogger_user_id_v1( self, @@ -15,9 +15,9 @@ def api_solar_cooperator_user_blogger_user_id_v1( user_id: str, ) -> ApiResponse[Any]: """ - User Blogger (V1) + Creator Profile - Retrieve blogger profile information. + Get Xiaohongshu Creator Marketplace (Pugongying) creator Profile data, including audience and pricing data, for influencer vetting, benchmark analysis, and campaign planning. Args: user_id: Blogger's user ID. @@ -36,9 +36,9 @@ def api_solar_kol_data_v3_data_summary_v1( business: str | None = "DAILY_NOTE", ) -> ApiResponse[Any]: """ - Data Summary (V1) + Data Summary - Get summary data for a specific KOL. + Get Xiaohongshu Creator Marketplace (Pugongying) Summary data, including activity, engagement, and audience growth, for creator evaluation, campaign planning, and creator benchmarking. Args: user_id: KOL's user ID. @@ -60,9 +60,9 @@ def api_solar_kol_data_user_id_fans_overall_new_history_v1( increase_type: str | None = "FANS_TOTAL", ) -> ApiResponse[Any]: """ - Fans Overall New History (V1) + Follower Growth History - Retrieve historical fans growth data. + Get Xiaohongshu Creator Marketplace (Pugongying) follower Growth History data, including historical points, trend signals, and growth metrics, for trend tracking, audience analysis, and creator performance monitoring. Args: user_id: KOL's user ID. @@ -84,9 +84,9 @@ def api_solar_kol_data_v3_fans_summary_v1( user_id: str, ) -> ApiResponse[Any]: """ - Fans Summary (V1) + Follower Summary - Get summary of fans demographics and stats. + Get Xiaohongshu Creator Marketplace (Pugongying) follower Summary data, including growth and engagement metrics, for audience analysis and creator benchmarking. Args: user_id: KOL's user ID. @@ -105,9 +105,9 @@ def api_solar_kol_get_similar_kol_v1( page_num: int | None = 1, ) -> ApiResponse[Any]: """ - Similar KOL (V1) + Similar Creators - Find similar KOLs based on a given user ID. + Get Xiaohongshu Creator Marketplace (Pugongying) similar Creators data, including audience signals, for creator discovery, benchmarking, and shortlist building. Args: user_id: KOL's user ID. @@ -127,9 +127,9 @@ def api_solar_kol_data_v2_kol_feature_tags_v1( user_id: str, ) -> ApiResponse[Any]: """ - KOL Feature Tags (V1) + Creator Feature Tags - Get feature tags assigned to a KOL. + Get Xiaohongshu Creator Marketplace (Pugongying) creator Feature Tags data, including platform tags, category labels, and classification signals, for segmentation, discovery, and creator classification. Args: user_id: KOL's user ID. @@ -147,9 +147,9 @@ def api_solar_kol_data_v2_kol_content_tags_v1( user_id: str, ) -> ApiResponse[Any]: """ - KOL Content Tags (V1) + Creator Content Tags - Get content-related tags for a KOL. + Get Xiaohongshu Creator Marketplace (Pugongying) creator Content Tags data, including topic labels that describe publishing themes and content focus, for creator evaluation, campaign planning, and creator benchmarking. Args: user_id: KOL's user ID. @@ -171,9 +171,9 @@ def api_solar_kol_data_v3_notes_rate_v1( advertise_switch: str | None = "ALL", ) -> ApiResponse[Any]: """ - Notes Rate (V1) + Note Performance Rates - Get performance rates for notes. + Get Xiaohongshu Creator Marketplace (Pugongying) note Performance Rates data, including core metrics, trend signals, and performance indicators, for content efficiency analysis, creator benchmarking, and campaign planning. Args: user_id: KOL's user ID. @@ -204,18 +204,9 @@ def api_solar_kol_data_v2_notes_detail_v1( page_number: int | None = 1, ) -> ApiResponse[Any]: """ - User Published Notes List (V1) + User Published Notes - Retrieves the list of notes published by a specific Xiaohongshu user. - It returns note items posted by the target account, typically including note IDs, titles/covers (if available), publish-related metadata, and paging information. - - Typical use cases: - - Creator content monitoring: track a user's recently published notes. - - Content collection: build datasets of notes under a specific account. - - Account activity analysis: review posting frequency and content output. - - Highlights - - Some users may not return note data through this endpoint. In general, users enrolled in Pugongying or users with relatively large follower bases are more likely to be supported. + Get Xiaohongshu Creator Marketplace (Pugongying) user Published Notes data, including note metadata and engagement signals, for creator monitoring and campaign research. Args: user_id: KOL's user ID. @@ -243,9 +234,9 @@ def api_solar_kol_data_user_id_fans_profile_v1( user_id: str, ) -> ApiResponse[Any]: """ - Fans Profile (V1) + Follower Profile - Get detailed fans profile for a specific KOL. + Get Xiaohongshu Creator Marketplace (Pugongying) follower Profile data, including audience demographics, interests, and distribution metrics, for creator evaluation, campaign planning, and creator benchmarking. Args: user_id: KOL's user ID. @@ -263,9 +254,9 @@ def api_solar_kol_data_v2_cost_effective_v1( user_id: str, ) -> ApiResponse[Any]: """ - Cost Effective (V1) + Cost Effectiveness Analysis - Analyze cost-effectiveness of a specific KOL. + Get Xiaohongshu Creator Marketplace (Pugongying) cost Effectiveness Analysis data, including pricing, reach, and engagement efficiency indicators, for campaign evaluation. Args: user_id: KOL's user ID. @@ -283,9 +274,9 @@ def api_solar_note_note_id_detail_v1( note_id: str, ) -> ApiResponse[Any]: """ - Note Details (V1) + Note Details - Retrieve details for a specific note. + Get Xiaohongshu Creator Marketplace (Pugongying) note Details data, including media and engagement signals, for content analysis, archiving, and campaign review. Args: note_id: Note's unique ID. @@ -311,9 +302,9 @@ def api_solar_cooperator_blogger_v2_v1( content_tag: str | None = None, ) -> ApiResponse[Any]: """ - KOL Search (V1) + Creator Search - Search for KOLs using various filters. + Get Xiaohongshu Creator Marketplace (Pugongying) creator Search data, including filters, returning profile, and audience, for discovery, comparison, and shortlist building. Args: search_type: Search criteria type. Available Values: - `NICKNAME`: Search by nickname - `NOTE`: Search by note content @@ -351,9 +342,9 @@ def api_pgy_kol_data_core_data_v1( advertise_switch: str | None = "ALL", ) -> ApiResponse[Any]: """ - KOL Data Core (V1) + Creator Core Metrics - Retrieve core performance data for a KOL. + Get Xiaohongshu Creator Marketplace (Pugongying) creator Core Metrics data, including engagement and content metrics, for benchmarking, vetting, and campaign planning. Args: user_id: KOL's user ID. @@ -380,9 +371,9 @@ def get_kol_info_v1( accept_cache: bool | None = False, ) -> ApiResponse[Any]: """ - KOL Profile (V1) [Deprecated] + Creator Profile - Retrieve KOL profile information (Legacy). + Get Xiaohongshu Creator Marketplace (Pugongying) creator Profile data, including audience and pricing data, for influencer vetting, benchmark analysis, and campaign planning. Args: kol_id: KOL ID. @@ -407,9 +398,9 @@ def get_kol_note_rate_v1( accept_cache: bool | None = False, ) -> ApiResponse[Any]: """ - KOL Note Rate (V1) [Deprecated] + Note Performance Rates - Get note performance rate (Legacy). + Get Xiaohongshu Creator Marketplace (Pugongying) note Performance Rates data, including core metrics, trend signals, and performance indicators, for content efficiency analysis, creator benchmarking, and campaign planning. Args: kol_id: KOL ID. @@ -438,9 +429,9 @@ def get_kol_fans_portrait_v1( accept_cache: bool | None = False, ) -> ApiResponse[Any]: """ - KOL Follower Profile (V1) [Deprecated] + Follower Profile - Get fans portrait (Legacy). + Get Xiaohongshu Creator Marketplace (Pugongying) follower Profile data, including audience demographics, interests, and distribution metrics, for creator evaluation, campaign planning, and creator benchmarking. Args: kol_id: KOL ID. @@ -461,9 +452,9 @@ def get_kol_fans_summary_v1( accept_cache: bool | None = False, ) -> ApiResponse[Any]: """ - KOL Follower Analysis (V1) [Deprecated] + Follower Analysis - Get fans summary (Legacy). + Get Xiaohongshu Creator Marketplace (Pugongying) follower Analysis data, including core metrics, trend signals, and performance indicators, for creator evaluation, campaign planning, and creator benchmarking. Args: kol_id: KOL ID. @@ -486,9 +477,9 @@ def get_kol_fans_trend_v1( accept_cache: bool | None = False, ) -> ApiResponse[Any]: """ - KOL Follower Trend (V1) [Deprecated] + Follower Growth Trend - Get fans growth trend (Legacy). + Get Xiaohongshu Creator Marketplace (Pugongying) follower Growth Trend data, including historical audience changes over time, for creator evaluation, campaign planning, and creator benchmarking. Args: kol_id: KOL ID. @@ -517,9 +508,9 @@ def get_kol_note_list_v1( accept_cache: bool | None = False, ) -> ApiResponse[Any]: """ - KOL Note List (V1) + Creator Note List - Retrieve list of notes for a specific KOL. + Get Xiaohongshu Creator Marketplace (Pugongying) creator Note List data, including content metadata, publish time, and engagement indicators, for content analysis. Args: kol_id: KOL ID. @@ -549,9 +540,9 @@ def get_kol_data_summary_v1( accept_cache: bool | None = False, ) -> ApiResponse[Any]: """ - KOL Data Overview (V1) [Deprecated] + Creator Performance Overview - Get data overview (Legacy). + Get Xiaohongshu Creator Marketplace (Pugongying) creator Performance Overview data, including audience, content performance, and commercial indicators, for quick evaluation. Args: kol_id: KOL ID. @@ -575,9 +566,9 @@ def get_kol_data_summary_v2( accept_cache: bool | None = False, ) -> ApiResponse[Any]: """ - KOL Data Overview (V2) [Deprecated] + Creator Performance Overview - Get data overview (Legacy V2). + Get Xiaohongshu Creator Marketplace (Pugongying) creator Performance Overview data, including audience, content performance, and commercial indicators, for quick evaluation. Args: kol_id: KOL ID. @@ -600,9 +591,9 @@ def get_kol_cost_effective_v1( accept_cache: bool | None = False, ) -> ApiResponse[Any]: """ - KOL Cost-Effectiveness (V1) [Deprecated] + Cost Effectiveness Analysis - Get cost-effectiveness data (Legacy). + Get Xiaohongshu Creator Marketplace (Pugongying) cost Effectiveness Analysis data, including pricing, reach, and engagement efficiency indicators, for campaign evaluation. Args: kol_id: KOL ID. @@ -623,9 +614,9 @@ def get_note_detail_v1( accept_cache: bool | None = False, ) -> ApiResponse[Any]: """ - Note Details (V1) [Deprecated] + Note Details - Get note details (Legacy). + Get Xiaohongshu Creator Marketplace (Pugongying) note Details data, including media and engagement signals, for content analysis, archiving, and campaign review. Args: note_id: Note ID. @@ -650,9 +641,9 @@ def get_kol_data_core_v1( accept_cache: bool | None = False, ) -> ApiResponse[Any]: """ - KOL Data Core (V1) [Deprecated] + Creator Core Metrics - Retrieve core performance data (Legacy). + Get Xiaohongshu Creator Marketplace (Pugongying) creator Core Metrics data, including engagement and content metrics, for benchmarking, vetting, and campaign planning. Args: kol_id: KOL ID. diff --git a/justoneapi/generated/resources/youku.py b/justoneapi/generated/resources/youku.py index 49620f5d..4042bad0 100644 --- a/justoneapi/generated/resources/youku.py +++ b/justoneapi/generated/resources/youku.py @@ -7,7 +7,7 @@ class YoukuResource(BaseResource): - """Generated resource for Youku.""" + """Generated resource for YOUKU.""" def search_video_v1( self, @@ -16,15 +16,9 @@ def search_video_v1( page: int | None = 1, ) -> ApiResponse[Any]: """ - Video Search (V1) + Video Search - This API performs a keyword-based search on Youku, returning a list of videos that match the search term. - Returned fields include video ID, title, cover image, duration, play count, publish time, and the video's detail page URL. - - Typical use cases: - - Keyword-based video discovery. - - Monitoring specific topics or trends on Youku. - - Analyzing search results for market research. + Get YOUKU video Search data, including video ID, title, and cover image, for keyword-based video discovery, monitoring specific topics or trends on youku, and analyzing search results for market research. Args: keyword: Keyword to search for. @@ -44,14 +38,9 @@ def get_video_detail_v1( video_id: str, ) -> ApiResponse[Any]: """ - Video Details (V1) - - This API retrieves detailed information of a specific Youku video, including video ID, title, description, cover image, duration, tags, play count, like count, publish time, and the video's detail page URL. + Video Details - Typical use cases: - - Fetching comprehensive metadata for a single video. - - Tracking engagement metrics like play counts and likes. - - Integrating detailed video info into third-party dashboards. + Get YOUKU video Details data, including video ID, title, and description, for fetching comprehensive metadata for a single video, tracking engagement metrics like play counts and likes, and integrating detailed video info into third-party dashboards. Args: video_id: The unique identifier for the video. @@ -69,14 +58,9 @@ def get_user_detail_v1( uid: str, ) -> ApiResponse[Any]: """ - User Profile (V1) - - This API retrieves detailed profile information of a specific Youku creator/user, including user ID, username, avatar, signature/description, follower count, following count, total videos, and verification status. + User Profile - Typical use cases: - - Analyzing creator influence and audience size. - - Monitoring account growth and verification status. - - Fetching basic user info for social CRM. + Get YOUKU user Profile data, including user ID, username, and avatar, for analyzing creator influence and audience size, monitoring account growth and verification status, and fetching basic user info for social crm. Args: uid: The unique identifier for the user. diff --git a/justoneapi/generated/resources/youtube.py b/justoneapi/generated/resources/youtube.py index 9b588e57..47ddd2c4 100644 --- a/justoneapi/generated/resources/youtube.py +++ b/justoneapi/generated/resources/youtube.py @@ -15,15 +15,9 @@ def get_video_detail_v1( video_id: str, ) -> ApiResponse[Any]: """ - Video Details (V1) + Video Details - Retrieves detailed metadata for a specific YouTube video, including its title, description, - view counts, channel information, and media assets. - - Typical use cases - - Tracking video engagement and statistics - - Extracting video metadata for content analysis - - Verifying video availability and status + Get YouTube video Details data, including its title, description, and view counts, for tracking video engagement and statistics, extracting video metadata for content analysis, and verifying video availability and status. Args: video_id: The unique identifier for a YouTube video. @@ -34,3 +28,26 @@ def get_video_detail_v1( "videoId": video_id, }, ) + + def get_channel_videos_v1( + self, + *, + channel_id: str, + cursor: str | None = None, + ) -> ApiResponse[Any]: + """ + Channel Videos + + Retrieve a list of videos from a specific YouTube channel, providing detailed insights into content performance and upload history. + + Args: + channel_id: The unique identifier for a YouTube channel. + cursor: The cursor for pagination. + """ + return self._get( + "/api/youtube/get-channel-videos/v1", + { + "channelId": channel_id, + "cursor": cursor, + }, + ) diff --git a/justoneapi/generated/resources/zhihu.py b/justoneapi/generated/resources/zhihu.py index 85a3b389..2478c208 100644 --- a/justoneapi/generated/resources/zhihu.py +++ b/justoneapi/generated/resources/zhihu.py @@ -15,13 +15,9 @@ def get_column_article_detail_v1( id_: str, ) -> ApiResponse[Any]: """ - Column Article Details (V1) + Column Article Details - Retrieve detailed information for a specific Zhihu Column article by its article ID. - - Typical use cases: - - In-depth content analysis of professional articles. - - Creator performance evaluation and topic trend monitoring. + Get Zhihu column Article Details data, including title, author, and content, for article archiving and content research. Args: id_: Article ID @@ -43,13 +39,9 @@ def get_answer_list_v1( session_id: str | None = "", ) -> ApiResponse[Any]: """ - Answer List (V1) - - Retrieve the list of answers under a specific Zhihu question by its question ID. + Answer List - Typical use cases: - - Analyzing user opinions and extracting high-quality responses. - - Studying community engagement and topic discussions. + Get Zhihu answer List data, including answer content, author profiles, and interaction metrics, for question analysis and answer research. Args: question_id: Question ID @@ -76,13 +68,9 @@ def search_v1( offset: int | None = 0, ) -> ApiResponse[Any]: """ - Search (V1) + Keyword Search - Search for Zhihu content (including questions, answers, and articles) by keyword. - - Typical use cases: - - Topic discovery and competitive brand monitoring. - - Identifying trending discussions and high-value creators. + Get Zhihu keyword Search data, including matched results, metadata, and ranking signals, for topic discovery and content research. Args: keyword: Search keywords. @@ -103,13 +91,9 @@ def get_column_article_list_v1( offset: int | None = 0, ) -> ApiResponse[Any]: """ - Column Article List (V1) - - Retrieve the list of articles published under a specific Zhihu Column by its column ID. + Column Article List - Typical use cases: - - Tracking creator output and analyzing column performance. - - Knowledge aggregation based on specific topics. + Get Zhihu column Article List data, including article metadata and list ordering, for column monitoring and content collection. Args: column_id: Column ID diff --git a/openapi/public-api.json b/openapi/public-api.json index 2ce02035..4e56ad33 100644 --- a/openapi/public-api.json +++ b/openapi/public-api.json @@ -42,7 +42,7 @@ "paths": { "/api/amazon/get-best-sellers/v1": { "get": { - "description": "Retrieves top performing products for a given category on Amazon.\nSupports top level best sellers categories (e.g. software). In addition, subcategories / category path can be specified.\n\nTypical use cases:\n- Identifying trending products in specific categories\n- Market share analysis and category research\n- Tracking sales rank and popularity over time\n", + "description": "Get Amazon best Sellers data, including rank positions, product metadata, and pricing, for identifying trending products in specific categories, market share analysis and category research, and tracking sales rank and popularity over time.", "operationId": "getBestSellersV1", "parameters": [ { @@ -681,7 +681,7 @@ "description": "default response" } }, - "summary": "Best Sellers (V1)", + "summary": "Best Sellers", "tags": [ "Amazon" ], @@ -690,7 +690,7 @@ }, "/api/amazon/get-category-products/v1": { "get": { - "description": " Retrieves products under a specified Amazon category.\n Supports category-based product discovery and returns product information such as title, price, rating, review count, and other available marketplace fields.\n\n Typical use cases:\n - Discovering products within a specific category\n - Category research and competitor analysis\n - Monitoring product assortment, pricing, and popularity trends\n", + "description": "Get Amazon products By Category data, including title, price, and rating, for category-based product discovery and returns product information such as title, price, and rating.", "operationId": "getProductsByCategoryV1", "parameters": [ { @@ -787,7 +787,7 @@ "description": "default response" } }, - "summary": "Products By Category (V1)", + "summary": "Products By Category", "tags": [ "Amazon" ], @@ -796,7 +796,7 @@ }, "/api/amazon/get-product-detail/v1": { "get": { - "description": "Retrieves detailed product information from Amazon based on the provided ASIN.\nIt returns core product data such as title, brand, price, availability, rating,\nreview count, product images, category information, and other publicly available details.\n\nTypical use cases:\n- Building product catalogs and enriching item content (e.g., images)\n- Price monitoring and availability tracking\n- E-commerce analytics and competitor tracking\n", + "description": "Get Amazon product Details data, including title, brand, and price, for building product catalogs and enriching item content (e.g., images), price monitoring and availability tracking, and e-commerce analytics and competitor tracking.", "operationId": "getProductDetailV1", "parameters": [ { @@ -1234,7 +1234,7 @@ "description": "default response" } }, - "summary": "Product Details (V1)", + "summary": "Product Details", "tags": [ "Amazon" ], @@ -1243,7 +1243,7 @@ }, "/api/amazon/get-product-top-reviews/v1": { "get": { - "description": "Retrieves top (most relevant or most helpful) public reviews for an Amazon product based on the provided ASIN.\nIt returns review details such as review ID, reviewer name, rating score,\nreview title, review content, publish time, and helpful vote count (if available).\n\nTypical use cases:\n- Sentiment analysis and consumer feedback tracking\n- Product research and quality assessment\n- Monitoring competitor customer experience\n", + "description": "Get Amazon product Top Reviews data, including most helpful) public reviews, for sentiment analysis and consumer feedback tracking, product research and quality assessment, and monitoring competitor customer experience.", "operationId": "getProductTopReviewsV1", "parameters": [ { @@ -1459,7 +1459,7 @@ "description": "default response" } }, - "summary": "Product Top Reviews (V1)", + "summary": "Product Top Reviews", "tags": [ "Amazon" ], @@ -1468,7 +1468,7 @@ }, "/api/beike/community/list/v1": { "get": { - "description": "Retrieves a list of residential communities (Xiaoqu) from Beike (Lianjia) within a specified city.\n\nThe data includes:\n- Community name and unique ID.\n- Average listing price and historical price trends.\n- Build year and architectural details.\n- Geographical coordinates and location information.\n\nTypical use cases:\n- Identifying popular residential areas in a city.\n- Comparing average housing prices across different communities.\n- Spatial analysis of property development patterns.\n", + "description": "Get Beike community List data, including - Community name and unique ID and Average listing price and historical price trends, for identifying popular residential areas in a city and comparing average housing prices across different communities.", "operationId": "communityListV1", "parameters": [ { @@ -2031,7 +2031,7 @@ "description": "default response" } }, - "summary": "Community List (V1)", + "summary": "Community List", "tags": [ "Beike" ], @@ -2040,7 +2040,7 @@ }, "/api/beike/ershoufang/detail/v1": { "get": { - "description": "Retrieves comprehensive information for a specific second-hand property listing on Beike (Lianjia).\n\nThe data includes:\n- Pricing (total and unit price).\n- Physical attributes (area, layout, floor, orientation).\n- Listing metadata (tags, listing date).\n- Agent contact information.\n\nTypical use cases:\n- Displaying a full property profile to users.\n- Detailed price comparison between specific listings.\n", + "description": "Get Beike resale Housing Details data, including - Pricing (total and unit price), Physical attributes (area, and layout, for displaying a full property profile to users and detailed price comparison between specific listings.", "operationId": "ershoufangDetailV1", "parameters": [ { @@ -2324,7 +2324,7 @@ "description": "default response" } }, - "summary": "Resale Housing Details (V1)", + "summary": "Resale Housing Details", "tags": [ "Beike" ], @@ -2333,7 +2333,7 @@ }, "/api/beike/get-ershoufang-list/v1": { "get": { - "description": "Fetches a list of second-hand property listings from Beike (Lianjia) based on specified filters.\n\nKey features:\n- Supports filtering by city/region, price range, layout, and area.\n- Returns core listing details such as title, total price, unit price, and community info.\n- Provides house codes for fetching full details via the detail API.\n\nTypical use cases:\n- Building search result pages for property portals.\n- Aggregating market data for regional housing trends.\n", + "description": "Get Beike resale Housing List data, including - Supports filtering by city/region, price range, and layout, for building search result pages for property portals and aggregating market data for regional housing trends.", "operationId": "getErshoufangListV1", "parameters": [ { @@ -2625,7 +2625,7 @@ "description": "default response" } }, - "summary": "Resale Housing List (V1)", + "summary": "Resale Housing List", "tags": [ "Beike" ], @@ -2634,7 +2634,7 @@ }, "/api/bilibili/get-user-detail/v2": { "get": { - "description": "Retrieve detailed profile information of a specific Bilibili user, including username, avatar, level, and verification status.\n\nTypical use cases:\n- Analyzing creator's profile, level, and verification status.\n- Verifying user identity and social presence on Bilibili.\n", + "description": "Get Bilibili user Profile data, including account metadata, audience metrics, and verification-related fields, for analyzing creator's profile, level, and verification status and verifying user identity and social presence on bilibili.", "operationId": "getUserDetailV2", "parameters": [ { @@ -3213,7 +3213,7 @@ "description": "default response" } }, - "summary": "User Profile (V2)", + "summary": "User Profile", "tags": [ "Bilibili" ], @@ -3222,7 +3222,7 @@ }, "/api/bilibili/get-user-relation-stat/v1": { "get": { - "description": "Retrieve follower count and following count for a specific Bilibili user.\n\nTypical use cases:\n- Tracking creator's follower growth and audience reach.\n- Analyzing social influence and account popularity.\n", + "description": "Get Bilibili user Relation Stats data, including following counts, for creator benchmarking and audience growth tracking.", "operationId": "getUserRelationStat", "parameters": [ { @@ -3270,7 +3270,7 @@ "description": "default response" } }, - "summary": "User Relation Stats (V1)", + "summary": "User Relation Stats", "tags": [ "Bilibili" ], @@ -3279,7 +3279,7 @@ }, "/api/bilibili/get-user-video-list/v2": { "get": { - "description": "Retrieve a list of videos published by a specific Bilibili user, including video metadata, cover images, and engagement metrics.\n\nTypical use cases:\n- Monitoring creator's content updates and publishing patterns.\n- Building user-specific video catalogs for analysis.\n", + "description": "Get Bilibili user Published Videos data, including titles, covers, and publish times, for creator monitoring and content performance analysis.", "operationId": "getUserVideoListV2", "parameters": [ { @@ -3400,7 +3400,7 @@ "description": "default response" } }, - "summary": "User Published Videos (V2)", + "summary": "User Published Videos", "tags": [ "Bilibili" ], @@ -3409,7 +3409,7 @@ }, "/api/bilibili/get-video-caption/v2": { "get": { - "description": "Retrieve subtitle/caption information for a specific Bilibili video.\n\nTypical use cases:\n- Extracting textual content from video subtitles for indexing or analysis.\n- Multi-language content processing and accessibility analysis.\n", + "description": "Get Bilibili video Captions data, including caption data, for transcript extraction and multilingual content analysis.", "operationId": "getVideoCaptionV1", "parameters": [ { @@ -3470,7 +3470,7 @@ "description": "default response" } }, - "summary": "Video Captions (V2)", + "summary": "Video Captions", "tags": [ "Bilibili" ], @@ -3479,7 +3479,7 @@ }, "/api/bilibili/get-video-comment/v2": { "get": { - "description": "Retrieve top-level comments for a specific Bilibili video, including commenter info, text, likes, and timestamps.\n\nTypical use cases:\n- Gathering detailed viewer feedback and community discussions.\n- Sentiment analysis and public opinion monitoring.\n", + "description": "Get Bilibili video Comments data, including commenter profiles, text, and likes, for sentiment analysis and comment moderation workflows.", "operationId": "getVideoCommentV2", "parameters": [ { @@ -4418,7 +4418,7 @@ "description": "default response" } }, - "summary": "Video Comments (V2)", + "summary": "Video Comments", "tags": [ "Bilibili" ], @@ -4427,7 +4427,7 @@ }, "/api/bilibili/get-video-danmu/v2": { "get": { - "description": "Retrieve danmaku (rolling comments) for a specific Bilibili video.\n\nTypical use cases:\n- Analyzing real-time viewer reactions and community trends.\n- Sentiment analysis based on rolling comments.\n", + "description": "Get Bilibili video Danmaku data, including timeline positions and comment text, for audience reaction analysis and subtitle-style comment review.", "operationId": "getVideoDanmuV2", "parameters": [ { @@ -4480,7 +4480,7 @@ "description": "default response" } }, - "summary": "Video Danmaku (V2)", + "summary": "Video Danmaku", "tags": [ "Bilibili" ], @@ -4489,7 +4489,7 @@ }, "/api/bilibili/get-video-detail/v2": { "get": { - "description": "Retrieve comprehensive details about a specific Bilibili video, including metadata (title, tags, publishing time), statistics (views, likes, danmaku count), and uploader profile information.\n\nTypical use cases:\n- Tracking video performance and engagement metrics.\n- Analyzing content metadata and uploader information.\n", + "description": "Get Bilibili video Details data, including metadata (title, tags, and publishing time), for tracking video performance and engagement metrics and analyzing content metadata and uploader information.", "operationId": "getVideoDetailV2", "parameters": [ { @@ -5625,7 +5625,7 @@ "description": "default response" } }, - "summary": "Video Details (V2)", + "summary": "Video Details", "tags": [ "Bilibili" ], @@ -5634,7 +5634,7 @@ }, "/api/bilibili/search-video/v2": { "get": { - "description": "Search for Bilibili videos based on keywords, returning matched videos with metadata, author information, and engagement stats.\n\nTypical use cases:\n- Discovering trending videos or creators by specific keywords.\n- Competitive analysis and market research on Bilibili.\n", + "description": "Get Bilibili video Search data, including matched videos, creators, and engagement metrics, for topic research and content discovery.", "operationId": "searchVideoV2", "parameters": [ { @@ -7174,7 +7174,7 @@ "description": "default response" } }, - "summary": "Video Search (V2)", + "summary": "Video Search", "tags": [ "Bilibili" ], @@ -7183,7 +7183,7 @@ }, "/api/bilibili/share-url-transfer/v1": { "get": { - "description": "Resolve Bilibili share URLs (e.g., https://b23.tv/...) to get the original content metadata.\n\nTypical use cases:\n- Converting shortened mobile share links to standard BVID/metadata.\n- Automating content extraction from shared social media links.\n\nHighlights\n- Only supports share URLs starting with 'https://b23.tv/'.\n", + "description": "Get Bilibili share Link Resolution data, including resolved video and page identifier, for converting shortened mobile share links to standard bvid/metadata and automating content extraction from shared social media links.", "operationId": "shareUrlTransferV1", "parameters": [ { @@ -7220,7 +7220,7 @@ "description": "default response" } }, - "summary": "Share Link Resolution (V1)", + "summary": "Share Link Resolution", "tags": [ "Bilibili" ], @@ -7229,7 +7229,7 @@ }, "/api/douban/get-movie-comments/v1": { "get": { - "description": "Retrieves short user comments (short reviews) for a specific movie subject (identified by subjectId).\n\nTypical use cases:\n- Fast-paced sentiment analysis using quick viewer comments.\n- Monitoring initial audience reaction upon movie release.\n", + "description": "Get Douban movie Comments data, including ratings, snippets, and interaction counts, for quick sentiment sampling and review monitoring.", "operationId": "getMovieCommentsV1", "parameters": [ { @@ -7292,16 +7292,16 @@ "description": "default response" } }, - "summary": "Movie Comments (V1)", + "summary": "Comments", "tags": [ - "Douban" + "Douban Movie" ], "x-order": "21001200" } }, "/api/douban/get-movie-review-detail/v1": { "get": { - "description": "Retrieves the full content and metadata of a specific movie review (identified by reviewId).\n\nTypical use cases:\n- Fetching the complete text of a single long review.\n- Analyzing the structured data and user engagement (likes, replies) of a specific review.\n", + "description": "Get Douban movie Review Details data, including metadata, content fields, and engagement signals, for review archiving and detailed opinion analysis.", "operationId": "getMovieReviewDetailsV1", "parameters": [ { @@ -7344,16 +7344,16 @@ "description": "default response" } }, - "summary": "Movie Review Details (V1)", + "summary": "Review Details", "tags": [ - "Douban" + "Douban Movie" ], "x-order": "21001100" } }, "/api/douban/get-movie-reviews/v1": { "get": { - "description": "Retrieves long-form user reviews for a specific movie subject (identified by subjectId).\n\nTypical use cases:\n- Analyzing detailed audience feedback for movies.\n- Long-term trend analysis of viewer sentiment.\n", + "description": "Get Douban movie Reviews data, including review titles, ratings, and snippets, for audience sentiment analysis and review research.", "operationId": "getMovieReviewsV1", "parameters": [ { @@ -7677,16 +7677,16 @@ "description": "default response" } }, - "summary": "Movie Reviews (V1)", + "summary": "Movie Reviews", "tags": [ - "Douban" + "Douban Movie" ], "x-order": "21001000" } }, "/api/douban/get-recent-hot-movie/v1": { "get": { - "description": "Retrieves the latest hot movies currently trending on the platform.\n\nTypical use cases:\n- Discovering recently popular movies.\n- Tracking current movie trends for content analysis or recommendation.\n", + "description": "Get Douban recent Hot Movie data, including ratings, posters, and subject metadata, for movie discovery and trend monitoring.", "operationId": "getRecentHotMovieV1", "parameters": [ { @@ -8289,16 +8289,16 @@ "description": "default response" } }, - "summary": "Recent Hot Movie (V1)", + "summary": "Recent Hot Movie", "tags": [ - "Douban" + "Douban Movie" ], "x-order": "21001300" } }, "/api/douban/get-recent-hot-tv/v1": { "get": { - "description": "Retrieves the latest hot TV shows currently trending on the platform.\n\nTypical use cases:\n- Discovering recently popular TV shows.\n- Tracking current TV trends for content analysis or recommendation.\n", + "description": "Get Douban recent Hot Tv data, including ratings, posters, and subject metadata, for series discovery and trend monitoring.", "operationId": "getRecentHotTvV1", "parameters": [ { @@ -8837,16 +8837,16 @@ "description": "default response" } }, - "summary": "Recent Hot Tv (V1)", + "summary": "Recent Hot Tv", "tags": [ - "Douban" + "Douban Movie" ], "x-order": "21001400" } }, "/api/douban/get-subject-detail/v1": { "get": { - "description": "Retrieves detailed information for a specific subject identified by subjectId.\n\nTypical use cases:\n- Displaying complete subject metadata in applications or websites.\n- Supporting content analysis, cataloging, or detail page rendering.\n", + "description": "Get Douban subject Details data, including title, rating, and cast, for title enrichment and catalog research.", "operationId": "getSubjectDetailV1", "parameters": [ { @@ -8898,16 +8898,16 @@ "description": "default response" } }, - "summary": "Subject Details (V1)", + "summary": "Subject Details", "tags": [ - "Douban" + "Douban Movie" ], "x-order": "21001200" } }, "/api/douyin-xingtu/get-author-commerce-seed-base-info/v1": { "get": { - "description": "Get author's commercial seeding data.", + "description": "Get Douyin Creator Marketplace (Xingtu) author Commerce Seeding Base Info data, including baseline metrics, commercial signals, and seeding indicators, for product seeding analysis, creator vetting, and campaign planning.", "operationId": "getAuthorCommerceSeedingBaseInfoV1", "parameters": [ { @@ -8978,16 +8978,16 @@ "description": "default response" } }, - "summary": "Author Commerce Seeding Base Info (V1)", + "summary": "Author Commerce Seeding Base Info", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15005100" } }, "/api/douyin-xingtu/get-author-commerce-spread-info/v1": { "get": { - "description": "Get author's commercial spread metrics.", + "description": "Get Douyin Creator Marketplace (Xingtu) author Commerce Spread Info data, including spread metrics, for creator evaluation for campaign planning and media buying.", "operationId": "getAuthorCommerceSpreadInfoV1", "parameters": [ { @@ -9053,16 +9053,16 @@ "description": "default response" } }, - "summary": "Author Commerce Spread Info (V1)", + "summary": "Author Commerce Spread Info", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15005000" } }, "/api/douyin-xingtu/get-author-content-hot-keywords/v1": { "get": { - "description": "Get analytical keywords from author's content.", + "description": "Get Douyin Creator Marketplace (Xingtu) kOL Content Keyword Analysis data, including core metrics, trend signals, and performance indicators, for content theme analysis and creator positioning research.", "operationId": "getAuthorContentHotKeywordsV1", "parameters": [ { @@ -9124,16 +9124,16 @@ "description": "default response" } }, - "summary": "KOL Content Keyword Analysis (V1)", + "summary": "KOL Content Keyword Analysis", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15004900" } }, "/api/douyin-xingtu/get-author-hot-comment-tokens/v1": { "get": { - "description": "Get analytical tokens from author's top comments.", + "description": "Get Douyin Creator Marketplace (Xingtu) kOL Comment Keyword Analysis data, including core metrics, trend signals, and performance indicators, for audience language analysis and comment-topic research.", "operationId": "getAuthorHotCommentTokensV1", "parameters": [ { @@ -9225,9 +9225,9 @@ "description": "default response" } }, - "summary": "KOL Comment Keyword Analysis (V1)", + "summary": "KOL Comment Keyword Analysis", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15004800" } @@ -9235,7 +9235,7 @@ "/api/douyin-xingtu/get-kol-audience-distribution/v1": { "get": { "deprecated": true, - "description": "Get fans audience distribution (Legacy).", + "description": "Get Douyin Creator Marketplace (Xingtu) audience Distribution data, including demographic and interest-based audience segmentation, for creator evaluation, campaign planning, and marketplace research.", "operationId": "getKolAudienceDistributionV1", "parameters": [ { @@ -9696,9 +9696,9 @@ "description": "default response" } }, - "summary": "KOL Audience Profile (V1) [Deprecated]", + "summary": "Audience Distribution", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15003200" } @@ -9706,7 +9706,7 @@ "/api/douyin-xingtu/get-kol-convert-ability/v1": { "get": { "deprecated": true, - "description": "Get conversion capability analysis (Legacy).", + "description": "Get Douyin Creator Marketplace (Xingtu) conversion Analysis data, including conversion efficiency and commercial performance indicators, for creator evaluation, campaign planning, and marketplace research.", "operationId": "getKolConvertAbilityV1", "parameters": [ { @@ -9777,9 +9777,9 @@ "description": "default response" } }, - "summary": "KOL Conversion Analysis (V1) [Deprecated]", + "summary": "Conversion Analysis", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15003800" } @@ -9787,7 +9787,7 @@ "/api/douyin-xingtu/get-kol-convert-videos-or-products/v1": { "get": { "deprecated": true, - "description": "Get detailed conversion resource list (Legacy).", + "description": "Get Douyin Creator Marketplace (Xingtu) conversion Resources data, including products tied to a Douyin Xingtu creator's conversion activity, for commerce analysis and campaign optimization.", "operationId": "getKolConvertVideosOrProductsV1", "parameters": [ { @@ -9868,9 +9868,9 @@ "description": "default response" } }, - "summary": "KOL Conversion Video Display (V1) [Deprecated]", + "summary": "Conversion Resources", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15004100" } @@ -9878,7 +9878,7 @@ "/api/douyin-xingtu/get-kol-cp-info/v1": { "get": { "deprecated": true, - "description": "Get cost-effectiveness analysis data (Legacy).", + "description": "Get Douyin Creator Marketplace (Xingtu) cost Performance Analysis data, including pricing, exposure, and engagement efficiency indicators, for creator evaluation, campaign planning, and marketplace research.", "operationId": "getKolCpInfoV1", "parameters": [ { @@ -9944,16 +9944,16 @@ "description": "default response" } }, - "summary": "KOL Cost-Effectiveness Analysis (V1) [Deprecated]", + "summary": "Cost Performance Analysis", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15004400" } }, "/api/douyin-xingtu/get-kol-daily-fans/v1": { "get": { - "description": "Get author's historical daily fans growth trend.", + "description": "Get Douyin Creator Marketplace (Xingtu) follower Growth Trend data, including historical audience changes over time, for creator evaluation, campaign planning, and marketplace research.", "operationId": "getKolDailyFansV1", "parameters": [ { @@ -10276,9 +10276,9 @@ "description": "default response" } }, - "summary": "KOL Follower Trend (V1)", + "summary": "Follower Growth Trend", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15004700" } @@ -10286,7 +10286,7 @@ "/api/douyin-xingtu/get-kol-fans-distribution/v1": { "get": { "deprecated": true, - "description": "Get fans portrait (Legacy).", + "description": "Get Douyin Creator Marketplace (Xingtu) follower Profile data, including audience demographics, interests, and distribution metrics, for creator evaluation, campaign planning, and marketplace research.", "operationId": "getKolFansDistributionV1", "parameters": [ { @@ -10763,9 +10763,9 @@ "description": "default response" } }, - "summary": "KOL Follower Profile (V1) [Deprecated]", + "summary": "Follower Profile", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15003300" } @@ -10773,7 +10773,7 @@ "/api/douyin-xingtu/get-kol-info/v1": { "get": { "deprecated": true, - "description": "Retrieve KOL profile information (Legacy).", + "description": "Get Douyin Creator Marketplace (Xingtu) creator Profile data, including audience and pricing data, for influencer vetting, benchmark analysis, and campaign planning.", "operationId": "getKolInfoV1", "parameters": [ { @@ -10916,9 +10916,9 @@ "description": "default response" } }, - "summary": "KOL Profile (V1) [Deprecated]", + "summary": "Creator Profile", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15003100" } @@ -10926,7 +10926,7 @@ "/api/douyin-xingtu/get-kol-link-info/v1": { "get": { "deprecated": true, - "description": "Get author link index (Legacy).", + "description": "Get Douyin Creator Marketplace (Xingtu) creator Link Metrics data, including creator ranking, traffic structure, and related performance indicators, for creator evaluation, campaign planning, and marketplace research.", "operationId": "getKolLinkInfoV1", "parameters": [ { @@ -11028,9 +11028,9 @@ "description": "default response" } }, - "summary": "KOL Xingtu Index (V1) [Deprecated]", + "summary": "Creator Link Metrics", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15004000" } @@ -11038,7 +11038,7 @@ "/api/douyin-xingtu/get-kol-link-struct/v1": { "get": { "deprecated": true, - "description": "Get author link structure (Legacy).", + "description": "Get Douyin Creator Marketplace (Xingtu) creator Link Structure data, including engagement and conversion metrics, for creator performance analysis.", "operationId": "getKolLinkStructV1", "parameters": [ { @@ -11116,9 +11116,9 @@ "description": "default response" } }, - "summary": "KOL Link Struct (V1) [Deprecated]", + "summary": "Creator Link Structure", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15004200" } @@ -11126,7 +11126,7 @@ "/api/douyin-xingtu/get-kol-marketing-info/v1": { "get": { "deprecated": true, - "description": "Get marketing pricing info (Legacy).", + "description": "Get Douyin Creator Marketplace (Xingtu) marketing Rates data, including rate card details and commercial service metrics, for creator evaluation, campaign planning, and marketplace research.", "operationId": "getKolMarketingInfoV1", "parameters": [ { @@ -11365,9 +11365,9 @@ "description": "default response" } }, - "summary": "KOL Service Pricing (V1) [Deprecated]", + "summary": "Marketing Rates", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15003400" } @@ -11375,7 +11375,7 @@ "/api/douyin-xingtu/get-kol-rec-videos/v1": { "get": { "deprecated": true, - "description": "Get author content and video performance (Legacy).", + "description": "Get Douyin Creator Marketplace (Xingtu) kOL Content Performance data, including video performance metrics, for creator evaluation, campaign planning, and marketplace research.", "operationId": "getKolRecVideosV1", "parameters": [ { @@ -11714,9 +11714,9 @@ "description": "default response" } }, - "summary": "KOL Content Performance (V1) [Deprecated]", + "summary": "KOL Content Performance", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15004500" } @@ -11724,7 +11724,7 @@ "/api/douyin-xingtu/get-kol-show-items-v2/v1": { "get": { "deprecated": true, - "description": "Get showcased items or videos performance (Legacy).", + "description": "Get Douyin Creator Marketplace (Xingtu) video Performance data, including core metrics, trend signals, and performance indicators, for creator evaluation, campaign planning, and marketplace research.", "operationId": "getKolShowItemsV2V1", "parameters": [ { @@ -12221,9 +12221,9 @@ "description": "default response" } }, - "summary": "KOL Video Performance (V1) [Deprecated]", + "summary": "Video Performance", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15003900" } @@ -12231,7 +12231,7 @@ "/api/douyin-xingtu/get-kol-spread-info/v1": { "get": { "deprecated": true, - "description": "Get spread performance metrics (Legacy).", + "description": "Get Douyin Creator Marketplace (Xingtu) creator Performance Overview data, including audience, content performance, and commercial indicators, for quick evaluation.", "operationId": "getKolSpreadInfoV1", "parameters": [ { @@ -12380,9 +12380,9 @@ "description": "default response" } }, - "summary": "KOL Data Overview (V1) [Deprecated]", + "summary": "Creator Performance Overview", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15003500" } @@ -12390,7 +12390,7 @@ "/api/douyin-xingtu/get-kol-touch-distribution/v1": { "get": { "deprecated": true, - "description": "Get connected user source distribution (Legacy).", + "description": "Get Douyin Creator Marketplace (Xingtu) audience Source Distribution data, including segment breakdowns, audience composition, and distribution signals, for traffic analysis and existing integration compatibility.", "operationId": "getKolTouchDistributionV1", "parameters": [ { @@ -12546,9 +12546,9 @@ "description": "default response" } }, - "summary": "KOL Connected User Sources (V1) [Deprecated]", + "summary": "Audience Source Distribution", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15004300" } @@ -12556,7 +12556,7 @@ "/api/douyin-xingtu/get-video-detail/v1": { "get": { "deprecated": true, - "description": "Get detailed video data (Legacy).", + "description": "Get Douyin Creator Marketplace (Xingtu) video Details data, including performance fields from the legacy Douyin Xingtu endpoint, for content review and integration compatibility.", "operationId": "getVideoDetailV1", "parameters": [ { @@ -12606,16 +12606,16 @@ "description": "default response" } }, - "summary": "Video Details (V1) [Deprecated]", + "summary": "Video Details", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15005200" } }, "/api/douyin-xingtu/gw/api/aggregator/get_author_order_experience/v1": { "get": { - "description": "Get author's transaction experience summary.", + "description": "Get Douyin Creator Marketplace (Xingtu) creator Order Experience data, including commercial history and transaction-related indicators, for creator evaluation, campaign planning, and marketplace research.", "operationId": "gwApiAggregatorGetAuthorOrderExperienceV1", "parameters": [ { @@ -12671,16 +12671,16 @@ "description": "default response" } }, - "summary": "Author Order Experience (V1)", + "summary": "Creator Order Experience", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15001400" } }, "/api/douyin-xingtu/gw/api/author/get_author_base_info/v1": { "get": { - "description": "Retrieve basic information for a specific author.", + "description": "Get Douyin Creator Marketplace (Xingtu) creator Profile data, including audience and pricing data, for influencer vetting, benchmark analysis, and campaign planning.", "operationId": "gwApiAuthorGetAuthorBaseInfoV1", "parameters": [ { @@ -12815,16 +12815,16 @@ "description": "default response" } }, - "summary": "Author Base Info (V1)", + "summary": "Creator Profile", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15001000" } }, "/api/douyin-xingtu/gw/api/author/get_author_marketing_info/v1": { "get": { - "description": "Get author's marketing pricing and stats.", + "description": "Get Douyin Creator Marketplace (Xingtu) marketing Rates data, including rate card details and commercial service metrics, for creator evaluation, campaign planning, and marketplace research.", "operationId": "gwApiAuthorGetAuthorMarketingInfoV1", "parameters": [ { @@ -13055,16 +13055,16 @@ "description": "default response" } }, - "summary": "Author Marketing Info (V1)", + "summary": "Marketing Rates", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15001800" } }, "/api/douyin-xingtu/gw/api/author/get_author_platform_channel_info_v2/v1": { "get": { - "description": "Retrieve author's platform channel data.", + "description": "Get Douyin Creator Marketplace (Xingtu) creator Channel Metrics data, including platform distribution and channel performance data used, for creator evaluation.", "operationId": "gwApiAuthorGetAuthorPlatformChannelInfoV2V1", "parameters": [ { @@ -13122,16 +13122,16 @@ "description": "default response" } }, - "summary": "Author Platform Channel Info (V1)", + "summary": "Creator Channel Metrics", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15001300" } }, "/api/douyin-xingtu/gw/api/author/get_author_show_items_v2/v1": { "get": { - "description": "Get author's showcased items or videos.", + "description": "Get Douyin Creator Marketplace (Xingtu) showcase Items data, including products and videos associated with the account, for creator evaluation, campaign planning, and marketplace research.", "operationId": "gwApiAuthorGetAuthorShowItemsV2V1", "parameters": [ { @@ -13650,16 +13650,16 @@ "description": "default response" } }, - "summary": "Author Show Items (V1)", + "summary": "Showcase Items", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15002100" } }, "/api/douyin-xingtu/gw/api/data_sp/author_audience_distribution/v1": { "get": { - "description": "Get author's audience demographics.", + "description": "Get Douyin Creator Marketplace (Xingtu) audience Distribution data, including demographic and interest-based audience segmentation, for creator evaluation, campaign planning, and marketplace research.", "operationId": "gwApiDataSpAuthorAudienceDistributionV1", "parameters": [ { @@ -14145,16 +14145,16 @@ "description": "default response" } }, - "summary": "Author Audience Distribution (V1)", + "summary": "Audience Distribution", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15001700" } }, "/api/douyin-xingtu/gw/api/data_sp/author_cp_info/v1": { "get": { - "description": "Get author's cost-performance analysis.", + "description": "Get Douyin Creator Marketplace (Xingtu) cost Performance Analysis data, including pricing, exposure, and engagement efficiency indicators, for creator evaluation, campaign planning, and marketplace research.", "operationId": "gwApiDataSpAuthorCpInfoV1", "parameters": [ { @@ -14227,16 +14227,16 @@ "description": "default response" } }, - "summary": "Author CP Info (V1)", + "summary": "Cost Performance Analysis", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15002300" } }, "/api/douyin-xingtu/gw/api/data_sp/author_link_struct/v1": { "get": { - "description": "Get structure of author links.", + "description": "Get Douyin Creator Marketplace (Xingtu) creator Link Structure data, including engagement and conversion metrics, for creator performance analysis.", "operationId": "gwApiDataSpAuthorLinkStructV1", "parameters": [ { @@ -14321,16 +14321,16 @@ "description": "default response" } }, - "summary": "Author Link Struct (V1)", + "summary": "Creator Link Structure", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15001100" } }, "/api/douyin-xingtu/gw/api/data_sp/author_rec_videos_v2/v1": { "get": { - "description": "Get author's high-performance recommended videos.", + "description": "Get Douyin Creator Marketplace (Xingtu) recommended Videos data, including content references used, for creator evaluation.", "operationId": "gwApiDataSpAuthorRecVideosV2V1", "parameters": [ { @@ -14676,16 +14676,16 @@ "description": "default response" } }, - "summary": "Author Recommended Videos (V1)", + "summary": "Recommended Videos", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15002500" } }, "/api/douyin-xingtu/gw/api/data_sp/author_touch_distribution/v1": { "get": { - "description": "Get author's user touchpoints and distribution.", + "description": "Get Douyin Creator Marketplace (Xingtu) audience Touchpoint Distribution data, including segment breakdowns, audience composition, and distribution signals, for creator evaluation, campaign planning, and marketplace research.", "operationId": "gwApiDataSpAuthorTouchDistributionV1", "parameters": [ { @@ -14848,16 +14848,16 @@ "description": "default response" } }, - "summary": "Author Touch Distribution (V1)", + "summary": "Audience Touchpoint Distribution", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15002400" } }, "/api/douyin-xingtu/gw/api/data_sp/author_video_distribution/v1": { "get": { - "description": "Get author's video performance distribution.", + "description": "Get Douyin Creator Marketplace (Xingtu) video Distribution data, including content performance breakdowns across published videos, for creator evaluation, campaign planning, and marketplace research.", "operationId": "gwApiDataSpAuthorVideoDistributionV1", "parameters": [ { @@ -14931,16 +14931,16 @@ "description": "default response" } }, - "summary": "Author Video Distribution (V1)", + "summary": "Video Distribution", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15001600" } }, "/api/douyin-xingtu/gw/api/data_sp/check_author_display/v1": { "get": { - "description": "Check visibility status of an author.", + "description": "Get Douyin Creator Marketplace (Xingtu) creator Visibility Status data, including availability status, discovery eligibility, and campaign display signals, for creator evaluation, campaign planning, and marketplace research.", "operationId": "gwApiDataSpCheckAuthorDisplayV1", "parameters": [ { @@ -15001,16 +15001,16 @@ "description": "default response" } }, - "summary": "Check Author Display (V1)", + "summary": "Creator Visibility Status", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15001200" } }, "/api/douyin-xingtu/gw/api/data_sp/get_author_convert_ability/v1": { "get": { - "description": "Get author's conversion capability analysis.", + "description": "Get Douyin Creator Marketplace (Xingtu) conversion Analysis data, including conversion efficiency and commercial performance indicators, for creator evaluation, campaign planning, and marketplace research.", "operationId": "gwApiDataSpGetAuthorConvertAbilityV1", "parameters": [ { @@ -15088,16 +15088,16 @@ "description": "default response" } }, - "summary": "Author Convert Ability (V1)", + "summary": "Conversion Analysis", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15002000" } }, "/api/douyin-xingtu/gw/api/data_sp/get_author_convert_videos_or_products/v1": { "get": { - "description": "Get detailed conversion data for videos or products.", + "description": "Get Douyin Creator Marketplace (Xingtu) conversion Resources data, including products tied to a Douyin Xingtu creator's conversion activity, for commerce analysis and campaign optimization.", "operationId": "gwApiDataSpGetAuthorConvertVideosOrProductsV1", "parameters": [ { @@ -15249,16 +15249,16 @@ "description": "default response" } }, - "summary": "Author Convert Videos or Products (V1)", + "summary": "Conversion Resources", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15002200" } }, "/api/douyin-xingtu/gw/api/data_sp/get_author_fans_distribution/v1": { "get": { - "description": "Get author's fans demographics and distribution.", + "description": "Get Douyin Creator Marketplace (Xingtu) follower Distribution data, including audience segmentation and location and demographic breakdowns, for creator evaluation, campaign planning, and marketplace research.", "operationId": "gwApiDataSpGetAuthorFansDistributionV1", "parameters": [ { @@ -15724,16 +15724,16 @@ "description": "default response" } }, - "summary": "Author Fans Distribution (V1)", + "summary": "Follower Distribution", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15002600" } }, "/api/douyin-xingtu/gw/api/data_sp/get_author_link_info/v1": { "get": { - "description": "Get author's link index and stats.", + "description": "Get Douyin Creator Marketplace (Xingtu) creator Link Metrics data, including creator ranking, traffic structure, and related performance indicators, for creator evaluation, campaign planning, and marketplace research.", "operationId": "gwApiDataSpGetAuthorLinkInfoV1", "parameters": [ { @@ -15879,16 +15879,16 @@ "description": "default response" } }, - "summary": "Author Link Info (V1)", + "summary": "Creator Link Metrics", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15001500" } }, "/api/douyin-xingtu/gw/api/data_sp/get_author_spread_info/v1": { "get": { - "description": "Get author's spread performance metrics.", + "description": "Get Douyin Creator Marketplace (Xingtu) distribution Metrics data, including exposure, spread, and related performance indicators, for creator evaluation, campaign planning, and marketplace research.", "operationId": "gwApiDataSpGetAuthorSpreadInfoV1", "parameters": [ { @@ -16049,16 +16049,16 @@ "description": "default response" } }, - "summary": "Author Spread Info (V1)", + "summary": "Distribution Metrics", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15001900" } }, "/api/douyin-xingtu/gw/api/data_sp/item_report_detail/v1": { "get": { - "description": "Get detailed item report data.", + "description": "Get Douyin Creator Marketplace (Xingtu) item Report Details data, including key metrics and report fields used, for item performance analysis.", "operationId": "gwApiDataSpItemReportDetailV1", "parameters": [ { @@ -16154,16 +16154,16 @@ "description": "default response" } }, - "summary": "Item Report Details (V1)", + "summary": "Item Report Details", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15002900" } }, "/api/douyin-xingtu/gw/api/data_sp/item_report_th_analysis/v1": { "get": { - "description": "Get analytical insights for an item report.", + "description": "Get Douyin Creator Marketplace (Xingtu) item Report Analysis data, including performance interpretation, for creator evaluation, campaign planning, and marketplace research.", "operationId": "gwApiDataSpItemReportThAnalysisV1", "parameters": [ { @@ -16373,16 +16373,16 @@ "description": "default response" } }, - "summary": "Item Report Analysis (V1)", + "summary": "Item Report Analysis", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15003000" } }, "/api/douyin-xingtu/gw/api/data_sp/item_report_trend/v1": { "get": { - "description": "Get trend analysis for an item report.", + "description": "Get Douyin Creator Marketplace (Xingtu) item Report Trend data, including time-based changes in item performance metrics, for creator evaluation, campaign planning, and marketplace research.", "operationId": "gwApiDataSpItemReportTrendV1", "parameters": [ { @@ -17644,16 +17644,16 @@ "description": "default response" } }, - "summary": "Item Report Trend (V1)", + "summary": "Item Report Trend", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15002800" } }, "/api/douyin-xingtu/gw/api/gsearch/search_for_author_square/v1": { "get": { - "description": "Search for authors using filters.", + "description": "Get Douyin Creator Marketplace (Xingtu) creator Search data, including filters, returning profile, and audience, for discovery, comparison, and shortlist building.", "operationId": "gwApiGsearchSearchForAuthorSquareV1", "parameters": [ { @@ -17915,9 +17915,9 @@ "description": "default response" } }, - "summary": "Author Search (V1)", + "summary": "Creator Search", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15002700" } @@ -17925,7 +17925,7 @@ "/api/douyin-xingtu/search-douyin-kol/v1": { "get": { "deprecated": true, - "description": "Search for Douyin KOLs (Legacy JSON body).", + "description": "Get Douyin Creator Marketplace (Xingtu) legacy KOL Search data, including preserving the request format, for creator evaluation, campaign planning, and marketplace research.", "operationId": "searchDouyinKolV1", "parameters": [ { @@ -17969,9 +17969,9 @@ "description": "OK" } }, - "summary": "Douyin KOL Search (V1) [Deprecated]", + "summary": "Legacy KOL Search", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15003600" } @@ -17979,7 +17979,7 @@ "/api/douyin-xingtu/search-for-author-square/v3": { "get": { "deprecated": true, - "description": "Search for creators by fans range (Legacy).", + "description": "Get Douyin Creator Marketplace (Xingtu) creator Search data, including filters, returning profile, and audience, for discovery, comparison, and shortlist building.", "operationId": "searchForAuthorSquareV3", "parameters": [ { @@ -18034,16 +18034,16 @@ "description": "OK" } }, - "summary": "Creator List Search (V3) [Deprecated]", + "summary": "Creator Search", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15004600" } }, "/api/douyin-xingtu/search-kol-simple/v1": { "get": { - "description": "Simple keyword-based KOL search.", + "description": "Get Douyin Creator Marketplace (Xingtu) kOL Keyword Search data, including matching creators and discovery data, for creator sourcing and shortlist building.", "operationId": "searchKolSimpleV1", "parameters": [ { @@ -18269,16 +18269,16 @@ "description": "default response" } }, - "summary": "KOL Keyword Search (V1)", + "summary": "KOL Keyword Search", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15003700" } }, "/api/douyin/get-user-detail/v3": { "get": { - "description": "Retrieves detailed profile information of a Douyin user, including nickname, avatar,\nfollower count, verification status, bio, and other user statistics.\n\nTypical use cases:\n- Identifying creators and building creator lists\n- Enriching user records for analytics and reporting\n- Monitoring profile changes and audience growth\n", + "description": "Get Douyin (TikTok China) user Profile data, including follower counts, verification status, and bio details, for creator research and account analysis.", "operationId": "getUserDetailV3", "parameters": [ { @@ -18772,9 +18772,9 @@ "description": "default response" } }, - "summary": "User Profile (V3)", + "summary": "User Profile", "tags": [ - "Douyin" + "Douyin (TikTok China)" ], "x-order": "14001000" } @@ -18782,7 +18782,7 @@ "/api/douyin/get-user-video-list/v1": { "get": { "deprecated": true, - "description": "Retrieves a list of videos published by a specific Douyin user, including video ID,\ncover image, title/caption, publish time, and engagement metrics.\n\nHighlights:\n- Capable of retrieving the latest published videos.\n\nTypical use cases:\n- Creator monitoring and content tracking\n- Building content timelines for specific accounts\n", + "description": "Get Douyin (TikTok China) user Published Videos data, including captions, covers, and publish times, for account monitoring.", "operationId": "getUserVideoListV1", "parameters": [ { @@ -19623,16 +19623,16 @@ "description": "default response" } }, - "summary": "User Published Videos (V1)", + "summary": "User Published Videos", "tags": [ - "Douyin" + "Douyin (TikTok China)" ], "x-order": "14001100" } }, "/api/douyin/get-user-video-list/v3": { "get": { - "description": "Retrieves a list of videos published by a specific Douyin user. This version may offer\ndifferent data structure or coverage compared to V1.\n\nHighlights:\n- Not capable of retrieving the latest published videos.\n\nTypical use cases:\n- Creator monitoring and content tracking\n- Building content timelines for specific accounts\n", + "description": "Get Douyin (TikTok China) user Published Videos data, including captions, covers, and publish times, for account monitoring.", "operationId": "getUserVideoListV3", "parameters": [ { @@ -20506,16 +20506,16 @@ "description": "default response" } }, - "summary": "User Published Videos (V3)", + "summary": "User Published Videos", "tags": [ - "Douyin" + "Douyin (TikTok China)" ], "x-order": "14001200" } }, "/api/douyin/get-video-comment/v1": { "get": { - "description": "Retrieves the comment list of a Douyin video by awemeId.\nReturns comment content, author info, like count, reply count, and publish time.\n\nTypical use cases:\n- Sentiment analysis and community feedback monitoring\n- Gathering user engagement data for specific videos\n", + "description": "Get Douyin (TikTok China) video Comments data, including authors, text, and likes, for sentiment analysis and engagement review.", "operationId": "getVideoCommentV1", "parameters": [ { @@ -20862,16 +20862,16 @@ "description": "default response" } }, - "summary": "Video Comments (V1)", + "summary": "Video Comments", "tags": [ - "Douyin" + "Douyin (TikTok China)" ], "x-order": "14001600" } }, "/api/douyin/get-video-detail/v2": { "get": { - "description": "Provides detailed information about a specific Douyin video, including video URL,\ndescription, author info, publish time, and engagement metrics (likes, comments, shares).\n\nTypical use cases:\n- Content analysis and performance tracking\n- Retrieving high-quality video assets and metadata\n", + "description": "Get Douyin (TikTok China) video Details data, including author details, publish time, and engagement counts, for video research, archiving, and performance analysis.", "operationId": "getVideoDetailV2", "parameters": [ { @@ -22105,16 +22105,16 @@ "description": "default response" } }, - "summary": "Video Details (V2)", + "summary": "Video Details", "tags": [ - "Douyin" + "Douyin (TikTok China)" ], "x-order": "14001300" } }, "/api/douyin/get-video-sub-comment/v1": { "get": { - "description": "Retrieves replies to a specific top-level comment under a Douyin video,\nincluding reply content, user information, timestamp, and like count.\n\nTypical use cases:\n- Deep-dive into specific discussion threads\n- Detailed community feedback analysis\n", + "description": "Get Douyin (TikTok China) comment Replies data, including text, authors, and timestamps, for thread analysis and feedback research.", "operationId": "getVideoSubCommentV1", "parameters": [ { @@ -22448,16 +22448,16 @@ "description": "default response" } }, - "summary": "Comment Replies (V1)", + "summary": "Comment Replies", "tags": [ - "Douyin" + "Douyin (TikTok China)" ], "x-order": "14001700" } }, "/api/douyin/search-user/v2": { "get": { - "description": "Enables searching for Douyin users by keyword, returning profiles with nickname,\navatar, follower count, and other metadata.\n\nTypical use cases:\n- Identifying creators and influencers\n- Competitive analysis and creator discovery\n", + "description": "Get Douyin (TikTok China) user Search data, including profile metadata and follower signals, for creator discovery and account research.", "operationId": "searchUserV2", "parameters": [ { @@ -22650,16 +22650,16 @@ "description": "default response" } }, - "summary": "User Search (V2)", + "summary": "User Search", "tags": [ - "Douyin" + "Douyin (TikTok China)" ], "x-order": "14001500" } }, "/api/douyin/search-video/v4": { "get": { - "description": "Allows searching for Douyin videos based on keywords, returning matched results with\nvideo metadata and engagement metrics. Supports filtering by sort type, publish time, and duration.\n\nTypical use cases:\n- Trend analysis and keyword monitoring\n- Discovery of relevant content for specific topics\n", + "description": "Get Douyin (TikTok China) video Search data, including metadata and engagement signals, for content discovery, trend research, and competitive monitoring.", "operationId": "searchVideoV4", "parameters": [ { @@ -24043,16 +24043,16 @@ "description": "default response" } }, - "summary": "Video Search (V4)", + "summary": "Video Search", "tags": [ - "Douyin" + "Douyin (TikTok China)" ], "x-order": "14001400" } }, "/api/douyin/share-url-transfer/v1": { "get": { - "description": "Converts a Douyin short share URL (e.g., https://v.douyin.com/...) into structured video data.\n\nTypical use cases:\n- Resolving shared links from users or social media posts\n- Automating content ingestion from shared URLs\n", + "description": "Get Douyin (TikTok China) share Link Resolution data, including helping extract canonical IDs, for downstream video and comment workflows.", "operationId": "shareUrlTransferV1", "parameters": [ { @@ -24089,16 +24089,104 @@ "description": "default response" } }, - "summary": "Share Link Resolution (V1)", + "summary": "Share Link Resolution", "tags": [ - "Douyin" + "Douyin (TikTok China)" ], "x-order": "14001800" } }, + "/api/facebook/get-profile-id/v1": { + "get": { + "description": "Retrieve the unique Facebook profile ID from a given profile URL.", + "operationId": "getProfileIdV1", + "parameters": [ + { + "description": "User security token for API access authentication.", + "in": "query", + "name": "token", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The path part of the Facebook profile URL. Do not include `https://www.facebook.com`. Example: `/people/To-Bite/pfbid021XLeDjjZjsoWse1H43VEgb3i1uCLTpBvXSvrnL2n118YPtMF5AZkBrZobhWWdHTHl/`", + "in": "query", + "name": "url", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "content": { + "application/json": {} + }, + "description": "default response" + } + }, + "summary": "Get Profile ID", + "tags": [ + "Facebook" + ], + "x-order": "30001010" + } + }, + "/api/facebook/get-profile-posts/v1": { + "get": { + "description": "Get public posts from a specific Facebook profile using its profile ID.", + "operationId": "getProfilePostsV1", + "parameters": [ + { + "description": "User security token for API access authentication.", + "in": "query", + "name": "token", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The unique Facebook profile ID.", + "in": "query", + "name": "profileId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Pagination cursor for fetching the next set of results.", + "in": "query", + "name": "cursor", + "required": false, + "schema": { + "default": "", + "type": "string" + } + } + ], + "responses": { + "default": { + "content": { + "application/json": {} + }, + "description": "default response" + } + }, + "summary": "Get Profile Posts", + "tags": [ + "Facebook" + ], + "x-order": "30001020" + } + }, "/api/facebook/search-post/v1": { "get": { - "description": "Search for public posts on Facebook based on keywords.\n\nThe results include post metadata, content, author information, publication time,\nengagement metrics (reactions, comments, shares), and media URLs.\n\nTypical use cases:\n- Discovering relevant public posts for specific keywords.\n- Analyzing engagement and reach of public content on Facebook.\n", + "description": "Get Facebook post Search data, including matched results, metadata, and ranking signals, for discovering relevant public posts for specific keywords and analyzing engagement and reach of public content on facebook.", "operationId": "searchV1", "parameters": [ { @@ -24381,7 +24469,7 @@ "description": "default response" } }, - "summary": "Search Posts (V1)", + "summary": "Post Search", "tags": [ "Facebook" ], @@ -24390,7 +24478,7 @@ }, "/api/imdb/main-search-query/v1": { "get": { - "description": "Perform a general search on IMDb for titles, people, and more.\n\nTypical use cases:\n- Search for a movie by name or find a celebrity's profile.\n", + "description": "Get IMDb keyword Search data, including matched results, metadata, and ranking signals, for entity discovery and entertainment research.", "operationId": "mainSearchQuery", "parameters": [ { @@ -27296,7 +27384,7 @@ "description": "default response" } }, - "summary": "Main Search (V1)", + "summary": "Keyword Search", "tags": [ "IMDb" ], @@ -27305,7 +27393,7 @@ }, "/api/imdb/news-by-category-query/v1": { "get": { - "description": "Retrieve entertainment news articles filtered by category.\n\nTypical use cases:\n- Stay updated on movie, TV, or celebrity news.\n", + "description": "Get IMDb news by Category data, including headlines, summaries, and source metadata, for media monitoring and news research.", "operationId": "newsByCategoryQuery", "parameters": [ { @@ -27411,7 +27499,7 @@ "description": "default response" } }, - "summary": "News by Category (V1)", + "summary": "News by Category", "tags": [ "IMDb" ], @@ -27420,7 +27508,7 @@ }, "/api/imdb/streaming-picks-query/v1": { "get": { - "description": "Retrieve streaming recommendations curated by IMDb.\n\nTypical use cases:\n- Browse popular and recommended content available on streaming services.\n", + "description": "Get IMDb streaming Picks data, including curated titles available across streaming surfaces, for content discovery and watchlist research.", "operationId": "streamingPicksQuery", "parameters": [ { @@ -27653,7 +27741,7 @@ "description": "default response" } }, - "summary": "Streaming Picks (V1)", + "summary": "Streaming Picks", "tags": [ "IMDb" ], @@ -27662,7 +27750,7 @@ }, "/api/imdb/title-awards-summary-query/v1": { "get": { - "description": "Retrieve a summary of awards and nominations for a specific title.\n\nTypical use cases:\n- List Oscar wins, Golden Globe nominations, and other accolades.\n", + "description": "Get IMDb title Awards Summary data, including nominations, for title benchmarking and awards research.", "operationId": "titleAwardsSummaryQuery", "parameters": [ { @@ -27738,7 +27826,7 @@ "description": "default response" } }, - "summary": "Title Awards Summary (V1)", + "summary": "Awards Summary", "tags": [ "IMDb" ], @@ -27747,7 +27835,7 @@ }, "/api/imdb/title-base-query/v1": { "get": { - "description": "Retrieve basic metadata for a specific title.\n\nTypical use cases:\n- Get essential information like title, year, and genre.\n", + "description": "Get IMDb title Base Info data, including title text, release year, and type, for catalog enrichment and title lookup workflows.", "operationId": "titleBaseQuery", "parameters": [ { @@ -27864,7 +27952,7 @@ "description": "default response" } }, - "summary": "Title Base Info (V1)", + "summary": "Base Info", "tags": [ "IMDb" ], @@ -27873,7 +27961,7 @@ }, "/api/imdb/title-box-office-summary/v1": { "get": { - "description": "Retrieve box office summary for a specific title.\n\nTypical use cases:\n- Analyze financial performance including budget, opening weekend, and worldwide gross.\n", + "description": "Get IMDb title Box Office Summary data, including grosses and related performance indicators, for revenue tracking and title comparison.", "operationId": "titleBoxOfficeSummary", "parameters": [ { @@ -27988,7 +28076,7 @@ "description": "default response" } }, - "summary": "Title Box Office Summary (V1)", + "summary": "Box Office Summary", "tags": [ "IMDb" ], @@ -27997,7 +28085,7 @@ }, "/api/imdb/title-chart-rankings/v1": { "get": { - "description": "Retrieve title rankings from IMDb charts (e.g., Top 250).\n\nTypical use cases:\n- View the highest-rated movies and TV shows of all time.\n", + "description": "Get IMDb title Chart Rankings data, including positions in lists such as Top 250 and related charts, for ranking monitoring and title benchmarking.", "operationId": "titleChartRankings", "parameters": [ { @@ -28139,7 +28227,7 @@ "description": "default response" } }, - "summary": "Title Chart Rankings (V1)", + "summary": "Chart Rankings", "tags": [ "IMDb" ], @@ -28148,7 +28236,7 @@ }, "/api/imdb/title-contribution-questions/v1": { "get": { - "description": "Retrieve contribution questions for a specific title.\n\nTypical use cases:\n- Facilitate user contributions by providing relevant metadata questions for a movie or TV show.\n", + "description": "Get IMDb title Contribution Questions data, including specific IMDb title, for data maintenance workflows and title metadata review.", "operationId": "titleContributionQuestions", "parameters": [ { @@ -28266,7 +28354,7 @@ "description": "default response" } }, - "summary": "Title Contribution Questions (V1)", + "summary": "Contribution Questions", "tags": [ "IMDb" ], @@ -28275,7 +28363,7 @@ }, "/api/imdb/title-countries-of-origin/v1": { "get": { - "description": "Retrieve the countries of origin for a specific title.\n\nTypical use cases:\n- Identify the production locations and international roots of a movie or TV show.\n", + "description": "Get IMDb title Countries of Origin data, including country names and regional metadata, for catalog enrichment and regional content analysis.", "operationId": "titleCountriesOfOrigin", "parameters": [ { @@ -28350,7 +28438,7 @@ "description": "default response" } }, - "summary": "Title Countries of Origin (V1)", + "summary": "Countries of Origin", "tags": [ "IMDb" ], @@ -28359,7 +28447,7 @@ }, "/api/imdb/title-critics-review-summary-query/v1": { "get": { - "description": "Retrieve a summary of critical reviews for a specific title.\n\nTypical use cases:\n- Display Metacritic scores and a compilation of professional critic feedback.\n", + "description": "Get IMDb title Critics Review Summary data, including review highlights, for review analysis and title comparison.", "operationId": "titleCriticsReviewSummaryQuery", "parameters": [ { @@ -28600,7 +28688,7 @@ "description": "default response" } }, - "summary": "Title Critics Review Summary (V1)", + "summary": "Critics Review Summary", "tags": [ "IMDb" ], @@ -28609,7 +28697,7 @@ }, "/api/imdb/title-details-query/v1": { "get": { - "description": "Retrieve comprehensive details for a specific title.\n\nTypical use cases:\n- Get all standard information for a movie or TV show including summary, ratings, and more.\n", + "description": "Get IMDb title Details data, including metadata, release info, and cast, for deep title research and catalog enrichment.", "operationId": "titleDetailsQuery", "parameters": [ { @@ -28874,7 +28962,7 @@ "description": "default response" } }, - "summary": "Title Details (V1)", + "summary": "Details", "tags": [ "IMDb" ], @@ -28883,7 +28971,7 @@ }, "/api/imdb/title-did-you-know-query/v1": { "get": { - "description": "Retrieve interesting 'Did You Know' facts and trivia for a title.\n\nTypical use cases:\n- Enhance user engagement with fun facts and behind-the-scenes trivia.\n", + "description": "Get IMDb title 'Did You Know' Insights data, including trivia, for editorial research and title insight enrichment.", "operationId": "titleDidYouKnowQuery", "parameters": [ { @@ -29073,7 +29161,7 @@ "description": "default response" } }, - "summary": "Title 'Did You Know' Insights (V1)", + "summary": "'Did You Know' Insights", "tags": [ "IMDb" ], @@ -29082,7 +29170,7 @@ }, "/api/imdb/title-extended-details-query/v1": { "get": { - "description": "Retrieve comprehensive extended details for a specific title.\n\nTypical use cases:\n- Get in-depth metadata including production details, alternate titles, and more.\n", + "description": "Get IMDb title Extended Details data, including title info, images, and genres, for title enrichment and catalog research.", "operationId": "titleExtendedDetailsQuery", "parameters": [ { @@ -29275,7 +29363,7 @@ "description": "default response" } }, - "summary": "Title Extended Details (V1)", + "summary": "Extended Details", "tags": [ "IMDb" ], @@ -29284,7 +29372,7 @@ }, "/api/imdb/title-more-like-this-query/v1": { "get": { - "description": "Retrieve title recommendations (More Like This) for a specific title.\n\nTypical use cases:\n- Provide users with similar content recommendations based on their interest in a specific title.\n", + "description": "Get IMDb title Recommendations data, including related titles and suggestion metadata, for content discovery and recommendation analysis.", "operationId": "titleMoreLikeThisQuery", "parameters": [ { @@ -29439,7 +29527,7 @@ "description": "default response" } }, - "summary": "Title Recommendations (V1)", + "summary": "Recommendations", "tags": [ "IMDb" ], @@ -29448,7 +29536,7 @@ }, "/api/imdb/title-plot-query/v1": { "get": { - "description": "Retrieve the plot summary for a specific title.\n\nTypical use cases:\n- Display a detailed description of the storyline for a movie or TV show.\n", + "description": "Get IMDb title Plot Summary data, including core metrics, trend signals, and performance indicators, for displaying a detailed description of the storyline for a movie or TV show.", "operationId": "titlePlotQuery", "parameters": [ { @@ -29536,7 +29624,7 @@ "description": "default response" } }, - "summary": "Title Plot Summary (V1)", + "summary": "Plot Summary", "tags": [ "IMDb" ], @@ -29545,7 +29633,7 @@ }, "/api/imdb/title-redux-overview-query/v1": { "get": { - "description": "Retrieve a redux overview of a specific title.\n\nTypical use cases:\n- Get a concise summary and overview of a movie or TV show's key attributes.\n", + "description": "Get IMDb title Redux Overview data, including key summary fields and linked metadata, for get a concise summary and overview of a movie or TV show's key attributes.", "operationId": "titleReduxOverviewQuery", "parameters": [ { @@ -31353,7 +31441,7 @@ "description": "default response" } }, - "summary": "Title Redux Overview (V1)", + "summary": "Redux Overview", "tags": [ "IMDb" ], @@ -31362,7 +31450,7 @@ }, "/api/imdb/title-release-expectation-query/v1": { "get": { - "description": "Retrieve release expectation data for a specific title.\n\nTypical use cases:\n- Analyze audience anticipation for upcoming movie or TV show releases.\n", + "description": "Get IMDb title Release Expectation data, including production status, release dates, and anticipation signals, for release monitoring and title research.", "operationId": "titleReleaseExpectationQuery", "parameters": [ { @@ -32530,7 +32618,7 @@ "description": "default response" } }, - "summary": "Title Release Expectation (V1)", + "summary": "Release Expectation", "tags": [ "IMDb" ], @@ -32539,7 +32627,7 @@ }, "/api/imdb/title-top-cast-and-crew/v1": { "get": { - "description": "Retrieve information about the top cast and crew members of a title.\n\nTypical use cases:\n- List directors, writers, and main actors for a movie or TV show.\n", + "description": "Get IMDb title Top Cast and Crew data, including names, roles, and profile references, for talent research and title enrichment.", "operationId": "titleTopCastAndCrew", "parameters": [ { @@ -33119,7 +33207,7 @@ "description": "default response" } }, - "summary": "Title Top Cast and Crew (V1)", + "summary": "Top Cast and Crew", "tags": [ "IMDb" ], @@ -33128,7 +33216,7 @@ }, "/api/imdb/title-user-reviews-summary-query/v1": { "get": { - "description": "Retrieve a summary of user-submitted reviews for a specific title.\n\nTypical use cases:\n- Get average user ratings and a snapshot of audience sentiment.\n", + "description": "Get IMDb title User Reviews Summary data, including aggregated review content and counts, for audience sentiment analysis.", "operationId": "titleUserReviewsSummaryQuery", "parameters": [ { @@ -33355,7 +33443,7 @@ "description": "default response" } }, - "summary": "Title User Reviews Summary (V1)", + "summary": "User Reviews Summary", "tags": [ "IMDb" ], @@ -33364,7 +33452,7 @@ }, "/api/instagram/get-post-detail/v1": { "get": { - "description": "Retrieves detailed information of a public Instagram post by post code, including post caption, media content (images/videos), publish time, and engagement metrics such as likes and comments.\n\nTypical use cases:\n- Analyzing engagement metrics (likes/comments) for a specific post\n- Archiving post content and media assets for content analysis\n- Verifying post details via the unique shortcode\n", + "description": "Get Instagram post Details data, including post caption, media content (images/videos), and publish time, for analyzing engagement metrics (likes/comments) for a specific post and archiving post content and media assets for content analysis.", "operationId": "getPostDetailV1", "parameters": [ { @@ -33872,7 +33960,7 @@ "description": "default response" } }, - "summary": "Post Details (V1)", + "summary": "Post Details", "tags": [ "Instagram" ], @@ -33881,7 +33969,7 @@ }, "/api/instagram/get-user-detail/v1": { "get": { - "description": "Retrieves public profile information of an Instagram user, including follower count, following count, post count, and basic profile details.\n\nTypical use cases:\n- Obtaining basic account metadata for influencer vetting\n- Tracking follower growth and audience reach over time\n- Mapping user handles to specific profile stats\n", + "description": "Get Instagram user Profile data, including follower count, following count, and post count, for obtaining basic account metadata for influencer vetting, tracking follower growth and audience reach over time, and mapping user handles to specific profile stats.", "operationId": "getUserDetailV1", "parameters": [ { @@ -34271,7 +34359,7 @@ "description": "default response" } }, - "summary": "User Details (V1)", + "summary": "User Profile", "tags": [ "Instagram" ], @@ -34280,7 +34368,7 @@ }, "/api/instagram/get-user-posts/v1": { "get": { - "description": "Retrieves a list of public posts published by an Instagram user, including post code, caption, media type, publish time, and basic engagement metrics.\n\nTypical use cases:\n- Monitoring recent publishing activity of a specific user\n- Building a historical record of content for auditing or analysis\n- Collecting post identifiers for deeper engagement analysis\n", + "description": "Get Instagram user Published Posts data, including post code, caption, and media type, for monitoring recent publishing activity of a specific user and building a historical record of content for auditing or analysis.", "operationId": "getUserPostsV1", "parameters": [ { @@ -34609,7 +34697,7 @@ "description": "default response" } }, - "summary": "User Published Posts (V1)", + "summary": "User Published Posts", "tags": [ "Instagram" ], @@ -34618,7 +34706,7 @@ }, "/api/instagram/search-hashtag-posts/v1": { "get": { - "description": "Searches public Instagram posts by keyword or hashtag. It returns a list of matched posts with metadata including caption, author profile, publish time, and media links.\n\nTypical use cases:\n- Competitive analysis of trending topics and hashtags\n- Monitoring community discussions and public opinion on specific tags\n- Aggregating user-generated content for specific campaigns\n", + "description": "Get Instagram hashtag Posts Search data, including caption, author profile, and publish time, for competitive analysis of trending topics and hashtags and monitoring community discussions and public opinion on specific tags.", "operationId": "searchHashtagPostsV1", "parameters": [ { @@ -34785,7 +34873,7 @@ "description": "default response" } }, - "summary": "Hashtag Posts Search (V1)", + "summary": "Hashtag Posts Search", "tags": [ "Instagram" ], @@ -34794,7 +34882,7 @@ }, "/api/instagram/search-reels/v1": { "get": { - "description": "Allows you to search public Instagram Reels by keyword or hashtag. It returns detailed information for each matched post, including post ID, caption, author profile, publish time, and engagement metrics.\n\nTypical use cases:\n- Tracking trends and viral content via specific keywords or hashtags\n- Discovering high-engagement Reels within a particular niche\n- Monitoring brand mentions and campaign hashtags\n", + "description": "Get Instagram reels Search data, including post ID, caption, and author profile, for tracking trends and viral content via specific keywords or hashtags and discovering high-engagement reels within a particular niche.", "operationId": "searchReelsV1", "parameters": [ { @@ -35265,7 +35353,7 @@ "description": "default response" } }, - "summary": "Reels Search (V1)", + "summary": "Reels Search", "tags": [ "Instagram" ], @@ -35274,7 +35362,7 @@ }, "/api/jd/get-item-comments/v1": { "get": { - "description": "Retrieves customer reviews (comments) for a specific JD.com (China) product by item ID.\nIt returns review content, rating/score, review time, user/display info (if available), and paging data.\n\nTypical use cases:\n- Review & sentiment monitoring: track comment volume and rating shifts.\n- Public opinion analysis: analyze negative/positive feedback signals.\n\nHighlights\n- Page limit: The maximum page number supported is 8.\n", + "description": "Get JD.com product Comments data, including ratings, timestamps, and reviewer signals, for customer feedback analysis and product research.", "operationId": "getItemCommentsV1", "parameters": [ { @@ -35564,16 +35652,16 @@ "description": "default response" } }, - "summary": "Product Comments (V1)", + "summary": "Product Comments", "tags": [ - "JD" + "JD.com" ], "x-order": "19001100" } }, "/api/jd/get-item-detail/v1": { "get": { - "description": "Retrieves product detail data for JD.com items, including basic metadata (title, item ID),\nmedia assets (images), shop information, item status, and pricing.\n\nTypical use cases:\n- Building product catalogs and enriching item content\n- E-commerce analytics and competitor tracking\n- General product lookup and verification\n\nHighlights\n- Price accuracy: The after-coupon (coupon-discounted) price is not accurate(Non-login version).\n", + "description": "Get JD.com product Details data, including pricing, images, and shop information, for catalog analysis, product monitoring, and ecommerce research.", "operationId": "getItemDetailV1", "parameters": [ { @@ -36689,16 +36777,16 @@ "description": "default response" } }, - "summary": "Product Details (V1)", + "summary": "Product Details", "tags": [ - "JD" + "JD.com" ], "x-order": "19001000" } }, "/api/jd/get-shop-item-list/v1": { "get": { - "description": " Retrieves the product list for a specific JD.com (China) shop.\n It returns items available in the shop, typically including basic product information such as item ID, title, price, sales-related data, image, and paging data.\n\n Typical use cases:\n - Shop catalog monitoring: track product assortments and newly listed items for a target shop.\n - Competitive analysis: analyze a shop’s product lineup, pricing, and listing changes over time.\n", + "description": "Get JD.com shop Product List data, including item titles, prices, and images, for catalog tracking and seller research.", "operationId": "getShopItemListV1", "parameters": [ { @@ -36737,16 +36825,16 @@ "description": "default response" } }, - "summary": "Shop Product List (V1)", + "summary": "Shop Product List", "tags": [ - "JD" + "JD.com" ], "x-order": "19001200" } }, "/api/kuaishou/get-user-detail/v1": { "get": { - "description": "Retrieves detailed profile information of a Kuaishou user, including nickname,\navatar, follower count, verification status, and bio.\n\nTypical use cases:\n- Creator research and building creator profiles\n- Monitoring audience growth and account status\n", + "description": "Get Kuaishou user Profile data, including account metadata, audience metrics, and verification-related fields, for creator research and building creator profiles and monitoring audience growth and account status.", "operationId": "getUserProfileV1", "parameters": [ { @@ -36900,7 +36988,7 @@ "description": "default response" } }, - "summary": "User Profile (V1)", + "summary": "User Profile", "tags": [ "Kuaishou" ], @@ -36909,7 +36997,7 @@ }, "/api/kuaishou/get-user-video-list/v2": { "get": { - "description": "Retrieves a list of videos posted by a specific Kuaishou user, including video ID,\ncover image, publish time, and engagement metrics.\n\nTypical use cases:\n- Content analysis for specific creators\n- Monitoring video performance and engagement trends\n", + "description": "Get Kuaishou user Published Videos data, including covers, publish times, and engagement metrics, for creator monitoring and content performance analysis.", "operationId": "getUserVideoListV2", "parameters": [ { @@ -37183,7 +37271,7 @@ "description": "default response" } }, - "summary": "User Published Videos (V2)", + "summary": "User Published Videos", "tags": [ "Kuaishou" ], @@ -37205,9 +37293,9 @@ } }, { - "description": "The unique numeric photo ID of the video.", + "description": "The unique ID of the Kuaishou video, e.g. `3xbknvct79h46h9`", "in": "query", - "name": "photoId", + "name": "videoId", "required": true, "schema": { "type": "string" @@ -39066,7 +39154,7 @@ "description": "default response" } }, - "summary": "Video Comments (V1)", + "summary": "Video Comments", "tags": [ "Kuaishou" ], @@ -39075,7 +39163,7 @@ }, "/api/kuaishou/get-video-detail/v2": { "get": { - "description": "Provides detailed information about a specific Kuaishou video, including video URL,\ncaption, author info, publish time, and engagement metrics (likes, comments, shares).\n\nTypical use cases:\n- In-depth content performance analysis\n- Building databases of viral videos\n", + "description": "Get Kuaishou video Details data, including video URL, caption, and author info, for in-depth content performance analysis and building databases of viral videos.", "operationId": "getVideoDetailsV2", "parameters": [ { @@ -39088,7 +39176,7 @@ } }, { - "description": "The unique ID of the Kuaishou video.", + "description": "The unique ID of the Kuaishou video, e.g. `3xg9avuebhtfcku`", "in": "query", "name": "videoId", "required": true, @@ -39484,7 +39572,7 @@ "description": "default response" } }, - "summary": "Video Details (V2)", + "summary": "Video Details", "tags": [ "Kuaishou" ], @@ -39493,7 +39581,7 @@ }, "/api/kuaishou/search-user/v2": { "get": { - "description": "Enhanced user search for Kuaishou, returning detailed user profiles with nickname,\navatar, follower count, and bio.\n\nTypical use cases:\n- Creator discovery and influencer analytics\n- Market research on specific content domains\n", + "description": "Get Kuaishou user Search data, including profile names, avatars, and follower counts, for creator discovery and account research.", "operationId": "searchUserV2", "parameters": [ { @@ -40632,7 +40720,7 @@ "description": "default response" } }, - "summary": "User Search (V2)", + "summary": "User Search", "tags": [ "Kuaishou" ], @@ -40641,7 +40729,7 @@ }, "/api/kuaishou/search-video/v2": { "get": { - "description": "Enables searching for Kuaishou videos by keyword, returning matched results with video ID,\ncover image, description, author info, publish time, and engagement metrics.\n\nTypical use cases:\n- Competitive analysis and market trends\n- Keywords monitoring and brand tracking\n", + "description": "Get Kuaishou video Search data, including video ID, cover image, and description, for competitive analysis and market trends and keywords monitoring and brand tracking.", "operationId": "searchVideoV2", "parameters": [ { @@ -40937,7 +41025,7 @@ "description": "default response" } }, - "summary": "Video Search (V2)", + "summary": "Video Search", "tags": [ "Kuaishou" ], @@ -40946,7 +41034,7 @@ }, "/api/kuaishou/share-url-transfer/v1": { "get": { - "description": "Converts Kuaishou short share URLs to structured data.\n\nTypical use cases:\n- Resolving shared links for automated content processing\n", + "description": "Get Kuaishou share Link Resolution data, including resolved content identifier and target object data, for resolving shared links for automated content processing.", "operationId": "shareLinkResolutionV1", "parameters": [ { @@ -40983,7 +41071,7 @@ "description": "default response" } }, - "summary": "Share Link Resolution (V1)", + "summary": "Share Link Resolution", "tags": [ "Kuaishou" ], @@ -40992,7 +41080,7 @@ }, "/api/reddit/get-post-comments/v1": { "get": { - "description": "Fetches the discussion thread (comments) for a specific Reddit post by its ID.\nThe results are returned as a paginated list of comment objects, including the text,\nauthor, and other metadata for each response.\n\nTypical use cases\n- Mining customer feedback and reviews\n- Understanding community sentiment through detailed discussions\n- Tracking the evolution of topics within a thread\n\nHighlights\n- Pagination is supported via the 'cursor' parameter.\n", + "description": "Get Reddit post Comments data, including text, authors, and timestamps, for discussion analysis and moderation research.", "operationId": "getPostCommentsV1", "parameters": [ { @@ -41709,7 +41797,7 @@ "description": "default response" } }, - "summary": "Post Comments (V1)", + "summary": "Post Comments", "tags": [ "Reddit" ], @@ -41718,7 +41806,7 @@ }, "/api/reddit/get-post-detail/v1": { "get": { - "description": "Retrieves comprehensive information of a specific Reddit post by its unique ID.\nIncludes the post content (text or link), author details, subreddit information,\nand engagement statistics like upvotes, downvotes, and comment counts.\n\nTypical use cases\n- Sentiment analysis for brands, products, or topics\n- Tracking public engagement with specific pieces of content\n- Content archiving and metadata analysis\n", + "description": "Get Reddit post Details data, including author details, subreddit info, and engagement counts, for content analysis, moderation research, and monitoring.", "operationId": "getPostDetailV1", "parameters": [ { @@ -41948,7 +42036,7 @@ "description": "default response" } }, - "summary": "Post Details (V1)", + "summary": "Post Details", "tags": [ "Reddit" ], @@ -41957,7 +42045,7 @@ }, "/api/reddit/search/v1": { "get": { - "description": "Performs a search for posts on Reddit based on specified keywords.\nRetrieves matching posts along with their metadata and basic engagement metrics.\n\nTypical use cases\n- Discovering new discussions or trends on specific topics\n- Competitive intelligence and brand monitoring\n- Researching community activity across the platform\n\nHighlights\n- Results can be paginated using the 'after' parameter.\n", + "description": "Get Reddit keyword Search data, including titles, authors, and subreddit context, for topic discovery and monitoring.", "operationId": "searchV1", "parameters": [ { @@ -42610,7 +42698,7 @@ "description": "default response" } }, - "summary": "Search (V1)", + "summary": "Keyword Search", "tags": [ "Reddit" ], @@ -42619,7 +42707,7 @@ }, "/api/search/v1": { "get": { - "description": "Retrieves social media data across all supported platforms (Weibo, Weixin, Douyin, Xiaohongshu, etc.)\nbased on the provided keyword and time range. This non-real-time search provides a\ncomprehensive view of cross-platform social sentiment and trends.\n\nTypical use cases:\n- Analyzing brand mentions across different social ecosystems\n- Comparative sentiment monitoring between platforms\n- Historical keyword tracking within an 84-day window\n\nHighlights\n- Time range limit: Data is restricted to the last 84 days from the current date.\n- Non-real-time: Results are not indexed in real-time and may have a delay.\n", + "description": "Get cross-platform social media search data, including Xiaohongshu, Douyin, Kuaishou, WeChat, Bilibili, Weibo and Zhihu results, for trend research and monitoring.", "operationId": "searchV1", "parameters": [ { @@ -42953,16 +43041,16 @@ "description": "default response" } }, - "summary": "Unified Search (V1)", + "summary": "Cross-Platform Search", "tags": [ - "Search" + "Social Media" ], "x-order": "10001000" } }, "/api/taobao/get-item-comment/v3": { "get": { - "description": "Retrieves user reviews for a Taobao/Tmall item, including review text, publish time,\nauthor info (when available), rating/likes (if present), and other review metadata. Supports pagination.\n\nTypical use cases:\n- Review and sentiment monitoring\n- Tracking rating/review volume changes over time\n- Collecting feedback for product/competitor analysis\n- Building datasets for NLP or customer-insight workflows\n", + "description": "Get Taobao and Tmall product Reviews data, including ratings, timestamps, and reviewer signals, for feedback analysis and product research.", "operationId": "getItemCommentV3", "parameters": [ { @@ -44306,16 +44394,16 @@ "description": "default response" } }, - "summary": "Product Reviews (V3)", + "summary": "Product Reviews", "tags": [ - "Taobao & Tmall" + "Taobao and Tmall" ], "x-order": "11001500" } }, "/api/taobao/get-item-detail/v1": { "get": { - "description": "Retrieves product detail data for Taobao/Tmall items, including basic metadata (title, item ID, category),\nmedia assets (images), shop information, item status, and pricing.\n\nTypical use cases:\n- Building product catalogs and enriching item content (e.g., images)\n- E-commerce analytics and competitor tracking\n- General product lookup and verification\n\nHighlights\n- Some items are not supported; in that case the response business code is 202 and retrying will not help.\n- After-coupon (coupon-discounted) price is not guaranteed: some items may miss it or return an imprecise value.\n", + "description": "Get Taobao and Tmall product Details data, including pricing, images, and shop details, for product research, catalog monitoring, and ecommerce analysis.", "operationId": "getItemDetailV1", "parameters": [ { @@ -45529,322 +45617,16 @@ "description": "default response" } }, - "summary": "Product Details (V1)", + "summary": "Product Details", "tags": [ - "Taobao & Tmall" + "Taobao and Tmall" ], "x-order": "11001000" } }, - "/api/taobao/get-item-detail/v3": { - "get": { - "description": "Retrieves product detail data for Taobao/Tmall items, including basic metadata (title, item ID, category),\nmedia assets (images), shop information, item status, and pricing.\n\nTypical use cases:\n- Price monitoring and promotion tracking\n- Building product catalogs and enriching item content (e.g., images)\n- E-commerce analytics and competitor tracking\n\nHighlights\n- App-based data source.\n- Accurate after-coupon (coupon-discounted) price.\n- Works across all items supported by this endpoint.\n", - "operationId": "getItemDetailV3", - "parameters": [ - { - "description": "Access token for this API service.", - "in": "query", - "name": "token", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "AUnique product identifier on Taobao/Tmall (item ID).", - "in": "query", - "name": "itemId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "content": { - "application/json": { - "example": { - "code": 0, - "data": { - "apiStack": [ - { - "name": "esi", - "value": "{\"item\":{\"sellCount\":\"3000+\",\"skuText\":\"配送至:罗湖区,请选择商品规格\",\"images\":[\"https://img.alicdn.com/imgextra/..." - } - ], - "debug": { - "app": "detailcache", - "cachedTimestamp": "2026-02-26T03:01:54", - "dataFrom": "tair", - "host": "detailcache011081147178.center.na620@11.81.147.178" - }, - "feature": { - "isOnLine": "true", - "tcloudToH5": "true" - }, - "item": { - "brandValueId": "3300940", - "businessId": "default", - "cartUrl": "https://h5.m.taobao.com/awp/base/cart.htm", - "categoryId": "50011993", - "commentCount": "0", - "countMultiple": [], - "exParams": {}, - "favcount": "119", - "h5DescV6": "false", - "h5ItemUrl": "https://new.m.taobao.com/detail.htm?id=1019694598833&hybrid=true", - "h5moduleDescUrl": "//mdetail.tmall.com/templates/pages/itemDesc?id=1019694598833", - "images": [ - "//img.alicdn.com/imgextra/i1/379424083/O1CN01OJockE1g24GDEQgbN_!!4611686018427383123-2-item_pic.png" - ], - "itemId": "1019694598833", - "moduleDescParams": { - "f": "desc/icoss156110212570d8d7f9e784afa0", - "id": "1019694598833" - }, - "moduleDescUrl": "//hws.m.taobao.com/d/modulet/v5/WItemMouldDesc.do?id=1019694598833&f=icoss156110212570d8d7f9e784afa0", - "newTaobaoH5DescUrl": "https://market.m.taobao.com/app/detail-project/desc/index.html?id=1019694598833&descVersion=7.0&type...", - "openDecoration": "false", - "pcADescUrl": "//market.m.taobao.com/app/detail-project/desc/index.html?id=1019694598833&descVersion=7.0&type=1&f=i...", - "rootCategoryId": "1801", - "skuText": "请选择商品规格 ", - "subtitle": "", - "taobaoDescUrl": "https://market.m.taobao.com/app/detail-project/desc/index.html?id=1019694598833&descVersion=7.0&type...", - "taobaoPcDescUrl": "https://market.m.taobao.com/app/detail-project/desc/index.html?id=1019694598833&descVersion=6.0&type...", - "title": "【李佳琦直播间爆品日付定金】珀莱雅红宝石水乳2.0套装紧致抗皱", - "tmallDescUrl": "//mdetail.tmall.com/templates/pages/desc?id=1019694598833" - }, - "mockData": "{\"delivery\":{},\"trade\":{\"buyEnable\":true,\"cartEnable\":true},\"feature\":{\"hasSku\":true,\"showSku\":true}...", - "params": { - "trackParams": { - "BC_type": "B", - "brandId": "3300940", - "categoryId": "50011993" - } - }, - "props": { - "groupProps": [ - { - "基本信息": [ - { - "品牌": "PROYA/珀莱雅" - } - ] - } - ] - }, - "props2": {}, - "propsCut": "品牌 面部护理套装 化妆品备案编号/注册证号 功效 注册信息 产地 适用人群 保质期 包装种类 是否为特殊用途化妆品 生产厂家信息 产品类别 单品数量 ", - "rate": { - "goodRateInfo": { - "goodRateRatio3m": "0.0", - "goodRateRatioAll": "0.0", - "rateCnt3m": "0", - "rateCntAll": "0" - }, - "invite": { - "inviteText": "", - "showInvite": "false" - } - }, - "resource": { - "entrances": { - "askAll": { - "icon": "https://img.alicdn.com/tps/TB1tVU6PpXXXXXFaXXXXXXXXXXX-102-60.png", - "link": "https://meta.m.taobao.com/app/mtb/taobao-ugc/ask/list?disableNav=YES&refId=1019694598833", - "text": "对宝贝有疑问？可以向已买的人求助" - } - } - }, - "seller": { - "allItemCount": "379", - "atmophereMask": "true", - "atmosphereColor": "#ffffff", - "atmosphereImg": "https://img.alicdn.com/imgextra/i2/379424083/O1CN01Seo8Tn1g23k80lTm6_!!379424083.jpg", - "atmosphereMaskColor": "#59000000", - "backgroundPic": "https://img.alicdn.com/imgextra/i3/O1CN01xTAR63288IdQsnpY9_!!6000000007887-0-tps-750-750.jpg", - "brandIcon": "//gw.alicdn.com/tfs/TB1lkPnjeH2gK0jSZFEXXcqMpXa-368-52.png?getAvatar=avatar", - "brandIconRatio": "7.3", - "creditLevel": "20", - "creditLevelIcon": "//gw.alicdn.com/imgextra/i1/O1CN01VD9Iap25oweneR31D_!!6000000007574-2-tps-120-60.png", - "dataTypeLabels": [ - { - "labelCode": "threshold_repurchase_rate", - "outputName": "超43%的人复购", - "processedValue": "43%" - } - ], - "detail4ShopLabelInfo": { - "dataTypeLabels": [ - { - "labelCode": "new_shop_open_year", - "outputName": "15年老店", - "processedValue": "15" - } - ], - "dsrLabels": [ - { - "labelCode": "goods_label_1", - "outputName": "88VIP好评率98%", - "processedValue": "88VIP好评率98%" - } - ], - "featureMap": { - "bc_type": "tm", - "experience_desc": "99", - "experience_level": "高", - "experience_ork": "99", - "goods_level": "高", - "goods_ork": "99", - "goods_value": "5.0", - "is_db": "Y", - "logistics_level": "高", - "logistics_ork": "99", - "logistics_value": "5.0", - "nps_star_num_out": "5.0", - "nps_value": "5.0", - "service_level": "高", - "service_ork": "99", - "service_value": "5.0" - }, - "goodDynamicLabels": [], - "overallScore": "5.0", - "serviceTypeLabels": [], - "stylizedTypeLabels": [] - }, - "entranceList": [ - { - "action": [ - { - "key": "open_url", - "params": { - "url": "//shop.m.taobao.com/shop/shop_index.htm?user_id=379424083&item_id=1019694598833¤tClickTime=-1" - } - } - ], - "backgroundColor": "#59000000", - "borderColor": "#59ffffff", - "text": "进店逛逛", - "textColor": "#ffffff" - } - ], - "evaluates": [ - { - "level": "1", - "levelBackgroundColor": "#EEEEEE", - "levelText": "高", - "levelTextColor": "#999999", - "score": "4.8 ", - "title": "宝贝描述", - "tmallLevelBackgroundColor": "#EEEEEE", - "tmallLevelTextColor": "#999999", - "type": "desc" - } - ], - "evaluates2": [ - { - "level": "1", - "levelText": "高", - "levelTextColor": "#f0f0f0", - "score": "4.8 ", - "scoreTextColor": "#ffffff", - "title": "宝贝描述", - "titleColor": "#ffffff", - "type": "desc" - } - ], - "fans": "2496万", - "fbt2User": "珀莱雅官方旗舰店", - "goodDynamicLabels": [ - { - "labelCode": "threshold_repurchase_rate", - "outputName": "超43%的人复购", - "processedValue": "43%" - } - ], - "goodRatePercentage": "100.00%", - "newItemCount": "45", - "overallScore": "5.0", - "pcShopUrl": "//shop60637940.taobao.com", - "rankLevelPic": "//img.alicdn.com/imgextra/i2/O1CN01BqRQGe28GXgm1qhik_!!6000000007905-2-tps-133-24.png", - "sellerNick": "珀莱雅官方旗舰店", - "sellerType": "B", - "serviceTypeLabels": [ - { - "labelCode": "threshold_ww_good_cst_eva_rate_30d", - "outputName": "客服满意度97%", - "processedValue": "97%" - } - ], - "shopCard": "掌柜近期上新45件宝贝，速览", - "shopIcon": "//img.alicdn.com/imgextra//i4/379424083/O1CN01ocORhv1g23s1B1Y7i_!!379424083.png", - "shopId": "60637940", - "shopName": "珀莱雅官方旗舰店", - "shopTextColor": "#ffffff", - "shopType": "B", - "shopUrl": "tmall://page.tm/shop?item_id=1019694598833&shopId=60637940", - "shopVersion": "0", - "showShopLinkIcon": "false", - "simpleShopDOStatus": "1", - "startsIcon": "https://img.alicdn.com/imgextra/i4/O1CN018GrFIW1Zx7vwjt3Jg_!!6000000003260-2-tps-91-14.png", - "stylizedTypeLabels": [], - "taoShopUrl": "//shop.m.taobao.com/shop/shop_index.htm?user_id=379424083&item_id=1019694598833", - "useFallbackImage": "true", - "userId": "379424083" - }, - "skuBase": { - "props": [ - { - "name": "商品规格", - "pid": "-1", - "values": [ - { - "image": "//img.alicdn.com/imgextra/i3/379424083/O1CN01IndZtP1g24GEdq67U_!!379424083.jpg", - "name": "水120ml+乳120ml", - "vid": "-1" - } - ] - } - ], - "skus": [ - { - "propPath": "-1:-1", - "skuId": "6196136571178" - } - ] - }, - "vertical": { - "askAll": { - "answerIcon": null, - "answerText": null, - "askIcon": "https://img.alicdn.com/tps/TB1tVU6PpXXXXXFaXXXXXXXXXXX-102-60.png", - "askText": "宝贝好不好，问问已买的人", - "linkUrl": "https://meta.m.taobao.com/app/mtb/taobao-ugc/ask/list?disableNav=YES&refId=1019694598833", - "model4XList": null, - "modelList": null, - "questNum": "0", - "showNum": "2", - "title": "问大家" - } - } - } - } - } - }, - "description": "default response" - } - }, - "summary": "Product Details (V3)", - "tags": [ - "Taobao & Tmall" - ], - "x-order": "11001100" - } - }, "/api/taobao/get-item-detail/v4": { "get": { - "description": "Retrieves product detail data for Taobao/Tmall items, including basic metadata (title, item ID, category),\nmedia assets (images), shop information, item status, and pricing.\n\nTypical use cases:\n- Building product catalogs and enriching item content (e.g., images)\n- E-commerce analytics and competitor tracking\n- General product lookup and verification\n\nHighlights\n- Accurate after-coupon price is available, but detailed coupon information is not included.\n", + "description": "Get Taobao and Tmall product Details data, including pricing, images, and shop details, for product research, catalog monitoring, and ecommerce analysis.", "operationId": "getItemDetailV4", "parameters": [ { @@ -45922,16 +45704,16 @@ "description": "default response" } }, - "summary": "Product Details (V4)", + "summary": "Product Details", "tags": [ - "Taobao & Tmall" + "Taobao and Tmall" ], "x-order": "11001200" } }, "/api/taobao/get-item-detail/v5": { "get": { - "description": "Retrieves product detail data for Taobao/Tmall items, including basic metadata (title, item ID, category),\nmedia assets (images), shop information, item status, and pricing.\n\nTypical use cases:\n- Building product catalogs and enriching item content (e.g., images)\n- E-commerce analytics and competitor tracking\n- General product lookup and verification\n\nHighlights\n- Some items are not supported. Unsupported items and transient collection failures may both return business code = 301.\n- Retry is not meant to be unlimited. A small number of retries (e.g., up to 5 attempts) is recommended.\n If it still returns code = 301, treat the item as unsupported and switch to another item or endpoint.\n", + "description": "Get Taobao and Tmall product Details data, including pricing, images, and shop details, for product research, catalog monitoring, and ecommerce analysis.", "operationId": "getItemDetailV5", "parameters": [ { @@ -46690,16 +46472,16 @@ "description": "default response" } }, - "summary": "Product Details (V5)", + "summary": "Product Details", "tags": [ - "Taobao & Tmall" + "Taobao and Tmall" ], "x-order": "11001300" } }, "/api/taobao/get-item-detail/v9": { "get": { - "description": "Retrieves product detail data for Taobao/Tmall items, including basic metadata (title, item ID, category),\nmedia assets (images), shop information, item status, and pricing.\n\nTypical use cases:\n- Building product catalogs and enriching item content (e.g., images)\n- E-commerce analytics and competitor tracking\n- General product lookup and verification\n\nHighlights\n- Some items are not supported; in that case the response business code is 202 and retrying will not help.\n- After-coupon (coupon-discounted) price is not guaranteed: some items may miss it or return an imprecise value.\n", + "description": "Get Taobao and Tmall product Details data, including pricing, images, and shop details, for product research, catalog monitoring, and ecommerce analysis.", "operationId": "getItemDetailV9", "parameters": [ { @@ -47476,16 +47258,16 @@ "description": "default response" } }, - "summary": "Product Details (V9)", + "summary": "Product Details", "tags": [ - "Taobao & Tmall" + "Taobao and Tmall" ], "x-order": "11001400" } }, "/api/taobao/get-shop-item-list/v1": { "get": { - "description": "Retrieves a paginated list of products under a Taobao/Tmall shop, including basic product metadata\n(e.g., item ID, title, price, images when available) and listing status.\n\nTypical use cases:\n- Monitoring a shop's assortment and new/removed products\n- Building shop-level catalogs and scheduled collection pipelines\n- Competitor shop tracking and e-commerce analytics\n\nHighlights\n- An empty product list may mean either: the shop has no products, or the shop is not supported by this endpoint.\n If the list is empty, verify with another shop or use an alternative endpoint if available.\n", + "description": "Get Taobao and Tmall shop Product List data, including item titles, prices, and images, for seller research and catalog tracking.", "operationId": "getShopItemListV1", "parameters": [ { @@ -47548,16 +47330,16 @@ "description": "default response" } }, - "summary": "Shop Product List (V1)", + "summary": "Shop Product List", "tags": [ - "Taobao & Tmall" + "Taobao and Tmall" ], "x-order": "11001600" } }, "/api/taobao/get-shop-item-list/v2": { "get": { - "description": "Retrieves a paginated list of products under a Taobao/Tmall shop, including basic product metadata\n(e.g., item ID, title, price, images when available) and listing status.\n\nTypical use cases:\n- Monitoring a shop's assortment and new/removed products\n- Building shop-level catalogs and scheduled collection pipelines\n- Competitor shop tracking and e-commerce analytics\n\nHighlights\n- An empty product list may mean either: the shop has no products, or the shop is not supported by this endpoint.\n If the list is empty, verify with another shop or use an alternative endpoint if available.\n", + "description": "Get Taobao and Tmall shop Product List data, including item titles, prices, and images, for seller research and catalog tracking.", "operationId": "getShopItemListV2", "parameters": [ { @@ -49242,16 +49024,16 @@ "description": "default response" } }, - "summary": "Shop Product List (V2)", + "summary": "Shop Product List", "tags": [ - "Taobao & Tmall" + "Taobao and Tmall" ], "x-order": "11001700" } }, "/api/taobao/get-shop-item-list/v3": { "get": { - "description": "Retrieves a paginated list of products under a Taobao/Tmall shop, including basic product metadata\n(e.g., item ID, title, price, images when available) and listing status.\n\nTypical use cases:\n- Monitoring a shop's assortment and new/removed products\n- Building shop-level catalogs and scheduled collection pipelines\n- Competitor shop tracking and e-commerce analytics\n\nHighlights\n- Works across all shops supported by this endpoint.\n", + "description": "Get Taobao and Tmall shop Product List data, including item titles, prices, and images, for seller research and catalog tracking.", "operationId": "getShopItemListV3", "parameters": [ { @@ -49399,16 +49181,16 @@ "description": "default response" } }, - "summary": "Shop Product List (V3)", + "summary": "Shop Product List", "tags": [ - "Taobao & Tmall" + "Taobao and Tmall" ], "x-order": "11001800" } }, "/api/taobao/search-item-list/v1": { "get": { - "description": "Searches Taobao/Tmall products by keyword and optional filters, returning a paginated result set\nwith basic product metadata (e.g., item ID, title, price, images when available) and listing status.\n\nTypical use cases:\n- Discovering products for analysis or monitoring\n- Building watchlists by keyword/category\n- Market and competitor research\n- Feeding downstream pipelines (detail collection, price tracking)\n", + "description": "Get Taobao and Tmall product Search data, including titles, prices, and images, for product discovery.", "operationId": "searchItemListV1", "parameters": [ { @@ -49601,16 +49383,16 @@ "description": "default response" } }, - "summary": "Product Search (V1)", + "summary": "Product Search", "tags": [ - "Taobao & Tmall" + "Taobao and Tmall" ], "x-order": "11001900" } }, "/api/tiktok-shop/get-product-detail/v1": { "get": { - "description": "Retrieves detailed information for a specific product on TikTok Shop based on the provided product ID and region.\nIt returns comprehensive product data including title, description, price, stock, and media.\n\nTypical use cases:\n- Building product catalogs\n- Price and stock monitoring\n- In-depth product analysis\n", + "description": "Get TikTok Shop product Details data, including title, description, and price, for building product catalogs, price and stock monitoring, and in-depth product analysis.", "operationId": "getProductDetailV1", "parameters": [ { @@ -49665,7 +49447,7 @@ "description": "OK" } }, - "summary": "Product Detail (V1)", + "summary": "Product Details", "tags": [ "TikTok Shop" ], @@ -49674,7 +49456,7 @@ }, "/api/tiktok-shop/search-products/v1": { "get": { - "description": "Searches for products on TikTok Shop based on the provided keyword and region.\nIt returns a list of products including title, price, sales, and other metadata.\n\nTypical use cases:\n- Market research and trend analysis\n- Competitor product discovery\n- Monitoring product popularity in specific regions\n", + "description": "Get TikTok Shop product Search data, including title, price, and sales, for market research and trend analysis, competitor product discovery, and monitoring product popularity in specific regions.", "operationId": "searchProductsV1", "parameters": [ { @@ -49749,7 +49531,7 @@ "description": "OK" } }, - "summary": "Search Products (V1)", + "summary": "Product Search", "tags": [ "TikTok Shop" ], @@ -49758,7 +49540,7 @@ }, "/api/tiktok/get-post-comment/v1": { "get": { - "description": "Retrieve a list of comments under a specific TikTok post by post ID.\nThe API returns detailed information for each comment, including comment ID, user information,\ntext content, like count, reply count, and publish time.\n\nTypical use cases:\n- Sentiment analysis of the audience's reaction to specific content.\n- Engagement measurement via comment volume and quality.\n- Community interaction research and feedback collection.\n", + "description": "Get TikTok post Comments data, including comment ID, user information, and text content, for sentiment analysis of the audience's reaction to specific content and engagement measurement via comment volume and quality.", "operationId": "getPostCommentV1", "parameters": [ { @@ -49906,7 +49688,7 @@ "description": "default response" } }, - "summary": "Post Comments (V1)", + "summary": "Post Comments", "tags": [ "TikTok" ], @@ -49915,7 +49697,7 @@ }, "/api/tiktok/get-post-detail/v1": { "get": { - "description": "Retrieve detailed information for a specific TikTok post by its post ID.\nThe API returns complete metadata including video ID, author information, description text, publish time,\nengagement metrics (likes, comments, shares, views), and available download URLs for both the video and cover image.\n\nTypical use cases:\n- Content performance analysis and metadata extraction.\n- Influencer evaluation via specific post metrics.\n- Verifying post authenticity and downloading media for offline analysis.\n", + "description": "Get TikTok post Details data, including video ID, author information, and description text, for content performance analysis and metadata extraction and influencer evaluation via specific post metrics.", "operationId": "getPostDetailV1", "parameters": [ { @@ -50344,7 +50126,7 @@ "description": "default response" } }, - "summary": "Post Details (V1)", + "summary": "Post Details", "tags": [ "TikTok" ], @@ -50353,7 +50135,7 @@ }, "/api/tiktok/get-post-sub-comment/v1": { "get": { - "description": "Retrieve a list of replies under a specific TikTok comment by comment ID.\nThe API returns detailed information for each reply, including reply ID, user information,\ntext content, like count, and publish time.\n\nTypical use cases:\n- Understanding detailed user interactions and threaded discussions.\n- Identifying influencers or active participants within a comment section.\n- Tracking sentiment propagation within comment threads.\n", + "description": "Get TikTok comment Replies data, including reply ID, user information, and text content, for understanding detailed user interactions and threaded discussions and identifying influencers or active participants within a comment section.", "operationId": "getPostSubCommentV1", "parameters": [ { @@ -50580,7 +50362,7 @@ "description": "default response" } }, - "summary": "Comment Replies (V1)", + "summary": "Comment Replies", "tags": [ "TikTok" ], @@ -50589,7 +50371,7 @@ }, "/api/tiktok/get-user-detail/v1": { "get": { - "description": "Retrieve detailed profile information for a specific TikTok user by user ID.\nThe API returns comprehensive data including nickname, unique ID, avatar, bio, follower/following counts,\ntotal likes, and other engagement indicators.\n\nTypical use cases:\n- Influencer profiling and audience analysis.\n- Account performance tracking and growth monitoring.\n- Identifying verified status and official accounts.\n\nNotes:\n- You must provide either 'uniqueId' or 'secUid'.\n", + "description": "Get TikTok user Profile data, including nickname, unique ID, and avatar, for influencer profiling and audience analysis, account performance tracking and growth monitoring, and identifying verified status and official accounts.", "operationId": "getUserDetailV1", "parameters": [ { @@ -50763,7 +50545,7 @@ "description": "default response" } }, - "summary": "User Profile (V1)", + "summary": "User Profile", "tags": [ "TikTok" ], @@ -50772,7 +50554,7 @@ }, "/api/tiktok/get-user-post/v1": { "get": { - "description": "Retrieve a list of posts published by a specific TikTok user.\nThe API returns detailed information about each post, including video ID, description, publish time,\nstatistics (likes, comments, shares, views), and video download URL if available.\n\nTypical use cases:\n- User activity analysis and posting frequency tracking.\n- Influencer performance evaluation.\n- Content trend monitoring for specific creators.\n", + "description": "Get TikTok user Published Posts data, including video ID, description, and publish time, for user activity analysis and posting frequency tracking, influencer performance evaluation, and content trend monitoring for specific creators.", "operationId": "getUserPostV1", "parameters": [ { @@ -51090,7 +50872,7 @@ "description": "default response" } }, - "summary": "User Published Posts (V1)", + "summary": "User Published Posts", "tags": [ "TikTok" ], @@ -51099,7 +50881,7 @@ }, "/api/tiktok/search-post/v1": { "get": { - "description": "Search for TikTok posts by keyword.\nThe API returns a list of matching posts with key details such as video ID, description,\nauthor information, publish time, and engagement metrics (likes, comments, shares, views).\n\nTypical use cases:\n- Trend monitoring and content discovery.\n- Keyword-based market analysis and sentiment tracking.\n- Identifying viral content related to specific topics.\n", + "description": "Get TikTok post Search data, including key details such as video ID, description, and author information, for trend monitoring and content discovery and keyword-based market analysis and sentiment tracking.", "operationId": "searchPostV1", "parameters": [ { @@ -52511,7 +52293,7 @@ "description": "default response" } }, - "summary": "Post Search (V1)", + "summary": "Post Search", "tags": [ "TikTok" ], @@ -52520,7 +52302,7 @@ }, "/api/tiktok/search-user/v1": { "get": { - "description": "Search for TikTok users by keyword.\nThe API returns a list of matching users along with basic profile information such as user ID,\nnickname, unique handle, avatar, bio, follower count, and verification status.\n\nTypical use cases:\n- Discovering influencers in specific niches via keywords.\n- Identifying target audiences and conducting competitor research.\n- Finding official brand accounts.\n", + "description": "Get TikTok user Search data, including basic profile information such as user ID, nickname, and unique handle, for discovering influencers in specific niches via keywords and identifying target audiences and conducting competitor research.", "operationId": "searchUserV1", "parameters": [ { @@ -53190,7 +52972,7 @@ "description": "default response" } }, - "summary": "User Search (V1)", + "summary": "User Search", "tags": [ "TikTok" ], @@ -53199,7 +52981,7 @@ }, "/api/toutiao/get-article-detail/v1": { "get": { - "description": "Retrieve detailed information for a specific Toutiao (Jinri Toutiao) article by its article ID.\n\nThe API returns complete metadata including article ID, title, author information, publish time, content text or summary, engagement metrics (views, comments, likes, shares), and the article URL.\n\nTypical use cases:\n- Content performance analysis and media monitoring.\n- Verifying article authenticity and metadata retrieval.\n", + "description": "Get Toutiao article Details data, including article ID, title, and author information, for content performance analysis and media monitoring and verifying article authenticity and metadata retrieval.", "operationId": "getArticleDetailV1", "parameters": [ { @@ -53707,7 +53489,7 @@ "description": "default response" } }, - "summary": "Article Details (V1)", + "summary": "Article Details", "tags": [ "Toutiao" ], @@ -53716,7 +53498,7 @@ }, "/api/toutiao/get-user-detail/v1": { "get": { - "description": "Retrieve detailed information for a specific Toutiao (Jinri Toutiao) user by their user ID.\n\nThe API returns comprehensive profile metadata including user ID, nickname, avatar, bio/description, verification status, follower and following counts, total likes, and total published articles or videos.\n\nTypical use cases:\n- Influencer profiling and audience analysis.\n- Monitoring creator performance and growth.\n", + "description": "Get Toutiao user Profile data, including user ID, nickname, and avatar, for influencer profiling and audience analysis and monitoring creator performance and growth.", "operationId": "getUserDetailV1", "parameters": [ { @@ -53798,7 +53580,7 @@ "description": "default response" } }, - "summary": "User Profile (V1)", + "summary": "User Profile", "tags": [ "Toutiao" ], @@ -53808,7 +53590,7 @@ "/api/toutiao/search/v1": { "get": { "deprecated": true, - "description": "Perform a keyword-based search on Toutiao (Jinri Toutiao) App to retrieve a list of matching articles, videos, and other content.\n\nThe API returns detailed search results including title, summary, author, publish time, and engagement metrics such as likes, comments, and shares.\n\nTypical use cases:\n- Content aggregation and trend analysis.\n- Media monitoring and keyword intelligence.\n", + "description": "Get Toutiao app Keyword Search data, including matching articles, videos, and authors, for topic discovery and monitoring.", "operationId": "searchV1", "parameters": [ { @@ -54248,7 +54030,7 @@ "description": "default response" } }, - "summary": "Search (V1)", + "summary": "App Keyword Search", "tags": [ "Toutiao" ], @@ -54257,7 +54039,7 @@ }, "/api/toutiao/search/v2": { "get": { - "description": "Perform a keyword-based search on Toutiao (Jinri Toutiao) PC version to retrieve a list of matching articles, videos, and other content.\n\nThe API returns detailed search results including title, summary, author, publish time, and engagement metrics such as likes, comments, and shares.\n\nTypical use cases:\n- Content aggregation and trend analysis.\n- Media monitoring and keyword intelligence.\n\nHighlights\n- This is the PC version of the search API. Note that it currently only supports retrieving the first page of results.\n", + "description": "Get Toutiao web Keyword Search data, including this is the PC version of the search API. Note that it currently only supports retrieving the first page of results, for first-page discovery of articles, videos, and authors for trend research and monitoring.", "operationId": "searchV2", "parameters": [ { @@ -54287,7 +54069,7 @@ "description": "default response" } }, - "summary": "Search (V2)", + "summary": "Web Keyword Search", "tags": [ "Toutiao" ], @@ -54296,7 +54078,7 @@ }, "/api/twitter/get-user-detail/v1": { "get": { - "description": "Retrieves basic public information for a specific X (Twitter) user using their Rest ID.\n\nTypical use cases:\n- Accessing user profile metadata (e.g., description, location, verification status).\n- Collecting follower and following counts.\n- Verifying account details for identity confirmation.\n", + "description": "Get Twitter user Profile data, including account metadata, audience metrics, and verification-related fields, for accessing user profile metadata (e.g., description, location, verification status) and collecting follower and following counts.", "operationId": "getUserDetailV1", "parameters": [ { @@ -54367,16 +54149,16 @@ "description": "default response" } }, - "summary": "User Details (V1)", + "summary": "User Profile", "tags": [ - "X(Twitter)" + "Twitter" ], "x-order": 31001000 } }, "/api/twitter/get-user-posts/v1": { "get": { - "description": "Retrieves the public tweet timeline (posts) for a specific X (Twitter) user.\n\nTypical use cases:\n- Monitoring recent activity of influential accounts.\n- Collecting tweets for archival or content analysis.\n- Tracking engagement on specific user-generated content.\n\nHighlights:\n- Supports pagination via cursor for large datasets.\n", + "description": "Get Twitter user Published Posts data, including post content, timestamps, and engagement data, for account monitoring and content analysis.", "operationId": "getUserPostsV1", "parameters": [ { @@ -56655,16 +56437,145 @@ "description": "default response" } }, - "summary": "User Published Posts (V1)", + "summary": "User Published Posts", "tags": [ - "X(Twitter)" + "Twitter" ], "x-order": 31001100 } }, + "/api/web/html/v1": { + "get": { + "description": "Get the HTML content of a web page.", + "operationId": "htmlV1", + "parameters": [ + { + "description": "Authentication token for this API service.", + "in": "query", + "name": "token", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The URL of the web page to fetch.", + "in": "query", + "name": "url", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/Result" + } + } + }, + "description": "OK" + } + }, + "summary": "HTML Content", + "tags": [ + "Web Page" + ], + "x-order": "35001000" + } + }, + "/api/web/markdown/v1": { + "get": { + "description": "Get the Markdown content of a web page.", + "operationId": "markdownV1", + "parameters": [ + { + "description": "Authentication token for this API service.", + "in": "query", + "name": "token", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The URL of the web page to fetch.", + "in": "query", + "name": "url", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/Result" + } + } + }, + "description": "OK" + } + }, + "summary": "Markdown Content", + "tags": [ + "Web Page" + ], + "x-order": "35001200" + } + }, + "/api/web/rendered-html/v1": { + "get": { + "description": "Get the Rendered HTML content of a web page.", + "operationId": "renderedHtmlV1", + "parameters": [ + { + "description": "Authentication token for this API service.", + "in": "query", + "name": "token", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The URL of the web page to fetch.", + "in": "query", + "name": "url", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/Result" + } + } + }, + "description": "OK" + } + }, + "summary": "Rendered HTML Content", + "tags": [ + "Web Page" + ], + "x-order": "35001100" + } + }, "/api/weibo/get-fans/v1": { "get": { - "description": "Retrieves the follower list (fans) of a specified Weibo user with pagination.\nIncludes user IDs, nicknames, avatars, and verification status of followers.\n\nTypical use cases:\n- Audience analysis and demographic research\n- Monitoring follower growth and community engagement\n", + "description": "Get Weibo user Fans data, including profile metadata and verification signals, for audience analysis and influencer research.", "operationId": "getFansV1", "parameters": [ { @@ -56861,7 +56772,7 @@ "description": "default response" } }, - "summary": "User Fans (V1)", + "summary": "User Fans", "tags": [ "Weibo" ], @@ -56870,7 +56781,7 @@ }, "/api/weibo/get-followers/v1": { "get": { - "description": "Retrieves the list of accounts that a specified Weibo user is following.\nIncludes user IDs, nicknames, avatars, and verification status of the followed accounts.\n\nTypical use cases:\n- Relationship mapping and network analysis\n- Identifying interests and associations of specific users\n", + "description": "Get Weibo user Followers data, including profile metadata and verification signals, for network analysis and creator research.", "operationId": "getFollowersV1", "parameters": [ { @@ -57067,7 +56978,7 @@ "description": "default response" } }, - "summary": "User Followers (V1)", + "summary": "User Followers", "tags": [ "Weibo" ], @@ -57076,7 +56987,7 @@ }, "/api/weibo/get-post-comments/v1": { "get": { - "description": " Retrieves comments for a specified Weibo post with pagination.\n Returns comment content, comment ID, author information, publish time, and related engagement data when available.\n\n Typical use cases:\n - Collecting comment threads for a specific post\n - Sentiment analysis and audience feedback research\n - Monitoring engagement and discussion around a post\n", + "description": "Get Weibo post Comments data, including text, authors, and timestamps, for feedback analysis.", "operationId": "getPostCommentsV1", "parameters": [ { @@ -57130,7 +57041,7 @@ "description": "default response" } }, - "summary": "Post Comments (V1)", + "summary": "Post Comments", "tags": [ "Weibo" ], @@ -57139,7 +57050,7 @@ }, "/api/weibo/get-user-detail/v3": { "get": { - "description": "Retrieves detailed profile information for a specified Weibo user, including nickname, avatar,\nuser ID, follower/following counts, bio, and verification status.\n\nTypical use cases:\n- Creator/KOL identification and monitoring\n- Enriching user records for analytics and reporting\n", + "description": "Get Weibo user Profile data, including follower counts, verification status, and bio details, for creator research and account analysis.", "operationId": "getUserProfileV3", "parameters": [ { @@ -57257,7 +57168,7 @@ "description": "default response" } }, - "summary": "User Profile (V3)", + "summary": "User Profile", "tags": [ "Weibo" ], @@ -57266,7 +57177,7 @@ }, "/api/weibo/get-user-post/v1": { "get": { - "description": "Retrieves the post list of a specified Weibo user with pagination.\nEach entry includes status ID, text, media assets, publish time, and engagement metrics.\n\nTypical use cases:\n- Creator monitoring and content tracking\n- Building content timelines for specific accounts\n", + "description": "Get Weibo user Published Posts data, including text, media, and publish times, for account monitoring.", "operationId": "getUserPublishedPostsV1", "parameters": [ { @@ -58026,7 +57937,7 @@ "description": "default response" } }, - "summary": "User Published Posts (V1)", + "summary": "User Published Posts", "tags": [ "Weibo" ], @@ -58035,7 +57946,7 @@ }, "/api/weibo/get-weibo-detail/v1": { "get": { - "description": "Retrieves detailed information about a specific Weibo post, including full text content,\nmedia assets (images/videos), author information, publish time, and engagement metrics (likes, comments, and reposts).\n\nTypical use cases:\n- Detailed analysis of specific social media posts\n- Content archival and monitoring\n", + "description": "Get Weibo post Details data, including media, author metadata, and engagement counts, for post analysis, archiving, and campaign monitoring.", "operationId": "getWeiboDetailsV1", "parameters": [ { @@ -58274,7 +58185,7 @@ "description": "default response" } }, - "summary": "Post Details (V1)", + "summary": "Post Details", "tags": [ "Weibo" ], @@ -58283,7 +58194,7 @@ }, "/api/weibo/hot-search/v1": { "get": { - "description": "Retrieves the current hot search (trending) topics from Weibo.\n\nTypical use cases:\n- Real-time trend monitoring\n- Identifying viral topics and news\n", + "description": "Get Weibo hot Search data, including ranking data, for trend monitoring, newsroom workflows, and topic discovery.", "operationId": "hotSearchV1", "parameters": [ { @@ -59156,7 +59067,7 @@ "description": "default response" } }, - "summary": "Hot Search (V1)", + "summary": "Hot Search", "tags": [ "Weibo" ], @@ -59165,7 +59076,7 @@ }, "/api/weibo/search-all/v2": { "get": { - "description": "Enables advanced keyword-based search on Weibo posts, supporting filters such as time range.\nReturns matching posts with content, author info, publish time, and engagement metrics (likes, reposts, comments).\n\nTypical use cases:\n- Tracking discussions around specific brands or events\n- Gathering public opinion data for a specific time period\n", + "description": "Get Weibo keyword Search data, including authors, publish times, and engagement signals, for trend monitoring.", "operationId": "searchAllV2", "parameters": [ { @@ -59262,7 +59173,7 @@ "description": "default response" } }, - "summary": "Keyword Search (V2)", + "summary": "Keyword Search", "tags": [ "Weibo" ], @@ -59271,7 +59182,7 @@ }, "/api/weibo/search-profile/v1": { "get": { - "description": "Search Weibo posts published by a specific user by keywords and time range.\n", + "description": "Get Weibo search User Published Posts data, including matched results, metadata, and ranking signals, for author research and historical content discovery.", "operationId": "searchProfileV1", "parameters": [ { @@ -59339,7 +59250,7 @@ "description": "default response" } }, - "summary": "Search User Published Posts (V1)", + "summary": "Search User Published Posts", "tags": [ "Weibo" ], @@ -59348,7 +59259,7 @@ }, "/api/weibo/tv-component/v1": { "get": { - "description": "Retrieves detailed information of a single Weibo TV video by its object ID.\nIncludes video metadata, media URLs, cover images, author info, and engagement metrics.\n\nTypical use cases:\n- Video content analysis and archival\n- Monitoring performance of Weibo TV videos\n", + "description": "Get Weibo tV Video Details data, including media URLs, author details, and engagement counts, for video research, archiving, and performance analysis.", "operationId": "tvComponentV1", "parameters": [ { @@ -59613,7 +59524,7 @@ "description": "default response" } }, - "summary": "TV Video Details (V1)", + "summary": "TV Video Details", "tags": [ "Weibo" ], @@ -59622,7 +59533,7 @@ }, "/api/weixin/get-article-comment/v1": { "get": { - "description": "Retrieves user comments from a specific Weixin Official Account article, including commenter name, comment content, like count, and timestamp.\n\nTypical use cases:\n- Analyzing community sentiment and feedback.\n- Identifying popular discussion points.\n", + "description": "Get WeChat Official Accounts article Comments data, including commenter details, comment text, and timestamps, for feedback analysis.", "operationId": "getArticleComment", "parameters": [ { @@ -59657,16 +59568,16 @@ "description": "default response" } }, - "summary": "Article Comments (V1)", + "summary": "Article Comments", "tags": [ - "Weixin" + "WeChat Official Accounts" ], "x-order": 20001200 } }, "/api/weixin/get-article-detail/v1": { "get": { - "description": "Retrieves core metadata and content details for a specific Weixin Official Account article.\n\nTypical use cases:\n- Scraping detailed content for archival or analysis.\n- Verifying article metadata from a URL.\n", + "description": "Get WeChat Official Accounts article Details data, including body content, for article archiving, research, and content analysis.", "operationId": "getArticleDetailV1", "parameters": [ { @@ -59709,16 +59620,16 @@ "description": "default response" } }, - "summary": "Article Details (V1)", + "summary": "Article Details", "tags": [ - "Weixin" + "WeChat Official Accounts" ], "x-order": 20001400 } }, "/api/weixin/get-article-feedback/v1": { "get": { - "description": "Retrieves engagement metrics for a specific Weixin Official Account article, including read count, like count, share count, and comment count.\n\nTypical use cases:\n- Tracking performance of a specific post.\n- Comparing engagement levels across different articles.\n", + "description": "Get WeChat Official Accounts article Engagement Metrics data, including like, share, and comment metrics, for article performance tracking and benchmarking.", "operationId": "getArticleFeedback", "parameters": [ { @@ -59760,16 +59671,16 @@ "description": "default response" } }, - "summary": "Article Engagement Metrics (V1)", + "summary": "Article Engagement Metrics", "tags": [ - "Weixin" + "WeChat Official Accounts" ], "x-order": 20001100 } }, "/api/weixin/get-user-post/v1": { "get": { - "description": "Retrieves posts published by a specific Weixin Official Account, including title, author, publish time, content summary, and engagement metrics such as reads, likes, and shares.\n\nTypical use cases:\n- Monitoring recent activity of a specific account.\n- Analyzing publishing frequency and content types.\n", + "description": "Get WeChat Official Accounts user Published Posts data, including titles, publish times, and summaries, for account monitoring.", "operationId": "getUserPost", "parameters": [ { @@ -59917,16 +59828,16 @@ "description": "default response" } }, - "summary": "User Published Posts (V1)", + "summary": "User Published Posts", "tags": [ - "Weixin" + "WeChat Official Accounts" ], "x-order": 20001000 } }, "/api/weixin/search/v1": { "get": { - "description": "Supports keyword-based search for both Weixin Official Accounts and their published articles. It returns matched accounts or posts with details such as account name, article title, publish time, and summary.\n\nTypical use cases:\n- Discovering new accounts related to specific topics.\n- Finding historical articles using keywords.\n", + "description": "Get WeChat Official Accounts keyword Search data, including account names, titles, and publish times, for content discovery.", "operationId": "searchV1", "parameters": [ { @@ -60069,16 +59980,16 @@ "description": "default response" } }, - "summary": "Search (V1)", + "summary": "Keyword Search", "tags": [ - "Weixin" + "WeChat Official Accounts" ], "x-order": 20001300 } }, "/api/xiaohongshu-pgy/api/pgy/kol/data/core_data/v1": { "get": { - "description": "Retrieve core performance data for a KOL.", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) creator Core Metrics data, including engagement and content metrics, for benchmarking, vetting, and campaign planning.", "operationId": "apiPgyKolDataCoreDataV1", "parameters": [ { @@ -60174,16 +60085,16 @@ "description": "default response" } }, - "summary": "KOL Data Core (V1)", + "summary": "Creator Core Metrics", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13002300" } }, "/api/xiaohongshu-pgy/api/solar/cooperator/blogger/v2/v1": { "get": { - "description": "Search for KOLs using various filters.", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) creator Search data, including filters, returning profile, and audience, for discovery, comparison, and shortlist building.", "operationId": "apiSolarCooperatorBloggerV2V1", "parameters": [ { @@ -60507,16 +60418,16 @@ "description": "default response" } }, - "summary": "KOL Search (V1)", + "summary": "Creator Search", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13002200" } }, "/api/xiaohongshu-pgy/api/solar/cooperator/user/blogger/userId/v1": { "get": { - "description": "Retrieve blogger profile information.", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) creator Profile data, including audience and pricing data, for influencer vetting, benchmark analysis, and campaign planning.", "operationId": "apiSolarCooperatorUserBloggerUserIdV1", "parameters": [ { @@ -60719,16 +60630,16 @@ "description": "default response" } }, - "summary": "User Blogger (V1)", + "summary": "Creator Profile", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13001000" } }, "/api/xiaohongshu-pgy/api/solar/kol/data/userId/fans_overall_new_history/v1": { "get": { - "description": "Retrieve historical fans growth data.", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) follower Growth History data, including historical points, trend signals, and growth metrics, for trend tracking, audience analysis, and creator performance monitoring.", "operationId": "apiSolarKolDataUserIdFansOverallNewHistoryV1", "parameters": [ { @@ -60918,16 +60829,16 @@ "description": "default response" } }, - "summary": "Fans Overall New History (V1)", + "summary": "Follower Growth History", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13001200" } }, "/api/xiaohongshu-pgy/api/solar/kol/data/userId/fans_profile/v1": { "get": { - "description": "Get detailed fans profile for a specific KOL.", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) follower Profile data, including audience demographics, interests, and distribution metrics, for creator evaluation, campaign planning, and creator benchmarking.", "operationId": "apiSolarKolDataUserIdFansProfileV1", "parameters": [ { @@ -61308,16 +61219,16 @@ "description": "default response" } }, - "summary": "Fans Profile (V1)", + "summary": "Follower Profile", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13001900" } }, "/api/xiaohongshu-pgy/api/solar/kol/dataV2/costEffective/v1": { "get": { - "description": "Analyze cost-effectiveness of a specific KOL.", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) cost Effectiveness Analysis data, including pricing, reach, and engagement efficiency indicators, for campaign evaluation.", "operationId": "apiSolarKolDataV2CostEffectiveV1", "parameters": [ { @@ -61368,16 +61279,16 @@ "description": "default response" } }, - "summary": "Cost Effective (V1)", + "summary": "Cost Effectiveness Analysis", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13002000" } }, "/api/xiaohongshu-pgy/api/solar/kol/dataV2/kolContentTags/v1": { "get": { - "description": "Get content-related tags for a KOL.", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) creator Content Tags data, including topic labels that describe publishing themes and content focus, for creator evaluation, campaign planning, and creator benchmarking.", "operationId": "apiSolarKolDataV2KolContentTagsV1", "parameters": [ { @@ -61412,16 +61323,16 @@ "description": "default response" } }, - "summary": "KOL Content Tags (V1)", + "summary": "Creator Content Tags", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13001600" } }, "/api/xiaohongshu-pgy/api/solar/kol/dataV2/kolFeatureTags/v1": { "get": { - "description": "Get feature tags assigned to a KOL.", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) creator Feature Tags data, including platform tags, category labels, and classification signals, for segmentation, discovery, and creator classification.", "operationId": "apiSolarKolDataV2KolFeatureTagsV1", "parameters": [ { @@ -61456,16 +61367,16 @@ "description": "default response" } }, - "summary": "KOL Feature Tags (V1)", + "summary": "Creator Feature Tags", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13001500" } }, "/api/xiaohongshu-pgy/api/solar/kol/dataV2/notesDetail/v1": { "get": { - "description": "Retrieves the list of notes published by a specific Xiaohongshu user.\nIt returns note items posted by the target account, typically including note IDs, titles/covers (if available), publish-related metadata, and paging information.\n\nTypical use cases:\n- Creator content monitoring: track a user's recently published notes.\n- Content collection: build datasets of notes under a specific account.\n- Account activity analysis: review posting frequency and content output.\n\nHighlights\n- Some users may not return note data through this endpoint. In general, users enrolled in Pugongying or users with relatively large follower bases are more likely to be supported.\n", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) user Published Notes data, including note metadata and engagement signals, for creator monitoring and campaign research.", "operationId": "apiSolarKolDataV2NotesDetailV1", "parameters": [ { @@ -61682,16 +61593,16 @@ "description": "default response" } }, - "summary": "User Published Notes List (V1)", + "summary": "User Published Notes", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13001800" } }, "/api/xiaohongshu-pgy/api/solar/kol/dataV3/dataSummary/v1": { "get": { - "description": "Get summary data for a specific KOL.", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) Summary data, including activity, engagement, and audience growth, for creator evaluation, campaign planning, and creator benchmarking.", "operationId": "apiSolarKolDataV3DataSummaryV1", "parameters": [ { @@ -61763,16 +61674,16 @@ "description": "default response" } }, - "summary": "Data Summary (V1)", + "summary": "Data Summary", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13001100" } }, "/api/xiaohongshu-pgy/api/solar/kol/dataV3/fansSummary/v1": { "get": { - "description": "Get summary of fans demographics and stats.", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) follower Summary data, including growth and engagement metrics, for audience analysis and creator benchmarking.", "operationId": "apiSolarKolDataV3FansSummaryV1", "parameters": [ { @@ -61823,16 +61734,16 @@ "description": "default response" } }, - "summary": "Fans Summary (V1)", + "summary": "Follower Summary", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13001300" } }, "/api/xiaohongshu-pgy/api/solar/kol/dataV3/notesRate/v1": { "get": { - "description": "Get performance rates for notes.", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) note Performance Rates data, including core metrics, trend signals, and performance indicators, for content efficiency analysis, creator benchmarking, and campaign planning.", "operationId": "apiSolarKolDataV3NotesRateV1", "parameters": [ { @@ -62301,16 +62212,16 @@ "description": "default response" } }, - "summary": "Notes Rate (V1)", + "summary": "Note Performance Rates", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13001700" } }, "/api/xiaohongshu-pgy/api/solar/kol/get_similar_kol/v1": { "get": { - "description": "Find similar KOLs based on a given user ID.", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) similar Creators data, including audience signals, for creator discovery, benchmarking, and shortlist building.", "operationId": "apiSolarKolGetSimilarKolV1", "parameters": [ { @@ -62363,16 +62274,16 @@ "description": "default response" } }, - "summary": "Similar KOL (V1)", + "summary": "Similar Creators", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13001400" } }, "/api/xiaohongshu-pgy/api/solar/note/noteId/detail/v1": { "get": { - "description": "Retrieve details for a specific note.", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) note Details data, including media and engagement signals, for content analysis, archiving, and campaign review.", "operationId": "apiSolarNoteNoteIdDetailV1", "parameters": [ { @@ -62506,9 +62417,9 @@ "description": "default response" } }, - "summary": "Note Details (V1)", + "summary": "Note Details", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13002100" } @@ -62516,7 +62427,7 @@ "/api/xiaohongshu-pgy/get-kol-core-data/v1": { "get": { "deprecated": true, - "description": "Retrieve core performance data (Legacy).", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) creator Core Metrics data, including engagement and content metrics, for benchmarking, vetting, and campaign planning.", "operationId": "getKolDataCoreV1", "parameters": [ { @@ -62622,9 +62533,9 @@ "description": "default response" } }, - "summary": "KOL Data Core (V1) [Deprecated]", + "summary": "Creator Core Metrics", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13003400" } @@ -62632,7 +62543,7 @@ "/api/xiaohongshu-pgy/get-kol-cost-effective/v1": { "get": { "deprecated": true, - "description": "Get cost-effectiveness data (Legacy).", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) cost Effectiveness Analysis data, including pricing, reach, and engagement efficiency indicators, for campaign evaluation.", "operationId": "getKolCostEffectiveV1", "parameters": [ { @@ -62677,9 +62588,9 @@ "description": "default response" } }, - "summary": "KOL Cost-Effectiveness (V1) [Deprecated]", + "summary": "Cost Effectiveness Analysis", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13003200" } @@ -62687,7 +62598,7 @@ "/api/xiaohongshu-pgy/get-kol-data-summary/v1": { "get": { "deprecated": true, - "description": "Get data overview (Legacy).", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) creator Performance Overview data, including audience, content performance, and commercial indicators, for quick evaluation.", "operationId": "getKolDataSummaryV1", "parameters": [ { @@ -62768,9 +62679,9 @@ "description": "default response" } }, - "summary": "KOL Data Overview (V1) [Deprecated]", + "summary": "Creator Performance Overview", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13003000" } @@ -62778,7 +62689,7 @@ "/api/xiaohongshu-pgy/get-kol-data-summary/v2": { "get": { "deprecated": true, - "description": "Get data overview (Legacy V2).", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) creator Performance Overview data, including audience, content performance, and commercial indicators, for quick evaluation.", "operationId": "getKolDataSummaryV2", "parameters": [ { @@ -62859,9 +62770,9 @@ "description": "default response" } }, - "summary": "KOL Data Overview (V2) [Deprecated]", + "summary": "Creator Performance Overview", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13003100" } @@ -62869,7 +62780,7 @@ "/api/xiaohongshu-pgy/get-kol-fans-portrait/v1": { "get": { "deprecated": true, - "description": "Get fans portrait (Legacy).", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) follower Profile data, including audience demographics, interests, and distribution metrics, for creator evaluation, campaign planning, and creator benchmarking.", "operationId": "getKolFansPortraitV1", "parameters": [ { @@ -63260,9 +63171,9 @@ "description": "default response" } }, - "summary": "KOL Follower Profile (V1) [Deprecated]", + "summary": "Follower Profile", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13002600" } @@ -63270,7 +63181,7 @@ "/api/xiaohongshu-pgy/get-kol-fans-summary/v1": { "get": { "deprecated": true, - "description": "Get fans summary (Legacy).", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) follower Analysis data, including core metrics, trend signals, and performance indicators, for creator evaluation, campaign planning, and creator benchmarking.", "operationId": "getKolFansSummaryV1", "parameters": [ { @@ -63331,9 +63242,9 @@ "description": "default response" } }, - "summary": "KOL Follower Analysis (V1) [Deprecated]", + "summary": "Follower Analysis", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13002700" } @@ -63341,7 +63252,7 @@ "/api/xiaohongshu-pgy/get-kol-fans-trend/v1": { "get": { "deprecated": true, - "description": "Get fans growth trend (Legacy).", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) follower Growth Trend data, including historical audience changes over time, for creator evaluation, campaign planning, and creator benchmarking.", "operationId": "getKolFansTrendV1", "parameters": [ { @@ -63539,9 +63450,9 @@ "description": "default response" } }, - "summary": "KOL Follower Trend (V1) [Deprecated]", + "summary": "Follower Growth Trend", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13002800" } @@ -63549,7 +63460,7 @@ "/api/xiaohongshu-pgy/get-kol-info/v1": { "get": { "deprecated": true, - "description": "Retrieve KOL profile information (Legacy).", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) creator Profile data, including audience and pricing data, for influencer vetting, benchmark analysis, and campaign planning.", "operationId": "getKolInfoV1", "parameters": [ { @@ -63741,16 +63652,16 @@ "description": "default response" } }, - "summary": "KOL Profile (V1) [Deprecated]", + "summary": "Creator Profile", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13002400" } }, "/api/xiaohongshu-pgy/get-kol-note-list/v1": { "get": { - "description": "Retrieve list of notes for a specific KOL.", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) creator Note List data, including content metadata, publish time, and engagement indicators, for content analysis.", "operationId": "getKolNoteListV1", "parameters": [ { @@ -63855,9 +63766,9 @@ "description": "default response" } }, - "summary": "KOL Note List (V1)", + "summary": "Creator Note List", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13002900" } @@ -63865,7 +63776,7 @@ "/api/xiaohongshu-pgy/get-kol-note-rate/v1": { "get": { "deprecated": true, - "description": "Get note performance rate (Legacy).", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) note Performance Rates data, including core metrics, trend signals, and performance indicators, for content efficiency analysis, creator benchmarking, and campaign planning.", "operationId": "getKolNoteRateV1", "parameters": [ { @@ -64036,9 +63947,9 @@ "description": "default response" } }, - "summary": "KOL Note Rate (V1) [Deprecated]", + "summary": "Note Performance Rates", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13002500" } @@ -64046,7 +63957,7 @@ "/api/xiaohongshu-pgy/get-note-detail/v1": { "get": { "deprecated": true, - "description": "Get note details (Legacy).", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) note Details data, including media and engagement signals, for content analysis, archiving, and campaign review.", "operationId": "getNoteDetailV1", "parameters": [ { @@ -64162,16 +64073,16 @@ "description": "default response" } }, - "summary": "Note Details (V1) [Deprecated]", + "summary": "Note Details", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13003300" } }, "/api/xiaohongshu/get-note-comment/v2": { "get": { - "description": "Retrieves comments for a Xiaohongshu note with pagination.\nThe response includes comment text, publish time, commenter information (when available),\nand other comment metadata.\n\nTypical use cases:\n- Sentiment and public-opinion monitoring based on comment content\n- Tracking comment volume and feedback trends over time\n- Collecting discussions for analytics, reporting, and dataset building\n", + "description": "Get Xiaohongshu (RedNote) note Comments data, including text, authors, and timestamps, for feedback analysis.", "operationId": "getNoteCommentV2", "parameters": [ { @@ -65115,16 +65026,16 @@ "description": "default response" } }, - "summary": "Note Comments (V2)", + "summary": "Note Comments", "tags": [ - "Xiaohongshu" + "Xiaohongshu (RedNote)" ], "x-order": "12001700" } }, "/api/xiaohongshu/get-note-comment/v4": { "get": { - "description": "Retrieves comments for a Xiaohongshu note.\n\nTypical use cases:\n- Quick lookup of the latest/top comments for a note\n- Comment snapshot for lightweight monitoring\n\nHighlights\n- This version only returns the first page of comments; subsequent pages are not available.\n- If you need to fetch more pages, use the Note Comments (V2) endpoint.\n", + "description": "Get Xiaohongshu (RedNote) note Comments data, including comment text, author profiles, and interaction data, for sentiment analysis and community monitoring.", "operationId": "getNoteCommentV4", "parameters": [ { @@ -65603,16 +65514,16 @@ "description": "default response" } }, - "summary": "Note Comments (V4)", + "summary": "Note Comments", "tags": [ - "Xiaohongshu" + "Xiaohongshu (RedNote)" ], "x-order": "12001800" } }, "/api/xiaohongshu/get-note-detail/v1": { "get": { - "description": "Retrieves detailed note data from Xiaohongshu, including the full note description,\nengagement metrics (likes, comments, collects, shares), and media information.\n\nThe response includes media download URLs for images and videos.\n\nTypical use cases:\n- Content analysis and review using full note text\n- Engagement tracking for creators, campaigns, and competitors\n- Collecting media assets (images/videos) for downstream processing or archiving\n- Building datasets for analytics, reporting, and automation\n", + "description": "Get Xiaohongshu (RedNote) note Details data, including media and engagement metrics, for content analysis, archiving, and campaign research.", "operationId": "getNoteDetailV1", "parameters": [ { @@ -66015,9 +65926,9 @@ "description": "default response" } }, - "summary": "Note Details (V1)", + "summary": "Note Details", "tags": [ - "Xiaohongshu" + "Xiaohongshu (RedNote)" ], "x-order": "12001400" } @@ -66025,7 +65936,7 @@ "/api/xiaohongshu/get-note-detail/v3": { "get": { "deprecated": true, - "description": "Retrieves detailed note data from Xiaohongshu, including the full note description,\nengagement metrics (likes, comments, collects, shares), and media information.\n\nThe response includes media download URLs for images and videos.\n\nTypical use cases:\n- Content analysis and review using full note text\n- Engagement tracking for creators, campaigns, and competitors\n- Collecting media assets (images/videos) for downstream processing or archiving\n- Building datasets for analytics, reporting, and automation\n", + "description": "Get Xiaohongshu (RedNote) note Details data, including media and engagement metrics, for content analysis, archiving, and campaign research.", "operationId": "getNoteDetailV3", "parameters": [ { @@ -66469,9 +66380,9 @@ "description": "default response" } }, - "summary": "Note Details (V3)", + "summary": "Note Details", "tags": [ - "Xiaohongshu" + "Xiaohongshu (RedNote)" ], "x-order": "12001500" } @@ -66479,7 +66390,7 @@ "/api/xiaohongshu/get-note-detail/v7": { "get": { "deprecated": true, - "description": "Retrieves detailed note data from Xiaohongshu, including the full note description,\nengagement metrics (likes, comments, collects, shares), and media information.\n\nThe response includes media download URLs for images and videos.\n\nTypical use cases:\n- Content analysis and review using full note text\n- Engagement tracking for creators, campaigns, and competitors\n- Collecting media assets (images/videos) for downstream processing or archiving\n- Building datasets for analytics, reporting, and automation\n", + "description": "Get Xiaohongshu (RedNote) note Details data, including media and engagement metrics, for content analysis, archiving, and campaign research.", "operationId": "getNoteDetailV7", "parameters": [ { @@ -66949,16 +66860,16 @@ "description": "default response" } }, - "summary": "Note Details (V7)", + "summary": "Note Details", "tags": [ - "Xiaohongshu" + "Xiaohongshu (RedNote)" ], "x-order": "12001600" } }, "/api/xiaohongshu/get-note-sub-comment/v2": { "get": { - "description": "Retrieves replies under a specific Xiaohongshu comment (also known as second-level comments),\nwith pagination when supported. The response includes reply text, publish time, replier information\n(when available), and other metadata.\n\nTypical use cases:\n- Deep sentiment analysis by including comment threads\n- Monitoring discussions under key comments\n- Collecting reply threads for analytics, reporting, and dataset building\n", + "description": "Get Xiaohongshu (RedNote) comment Replies data, including text, authors, and timestamps, for thread analysis and feedback research.", "operationId": "getNoteSubCommentV2", "parameters": [ { @@ -67286,9 +67197,9 @@ "description": "default response" } }, - "summary": "Comment Replies (V2)", + "summary": "Comment Replies", "tags": [ - "Xiaohongshu" + "Xiaohongshu (RedNote)" ], "x-order": "12001900" } @@ -67296,7 +67207,7 @@ "/api/xiaohongshu/get-user-note-list/v2": { "get": { "deprecated": true, - "description": "Retrieves a paginated list of notes published by a specific Xiaohongshu user.\nEach page returns basic note data (e.g., note ID, title/text snippet, publish time, cover/media info when available)\nand may include engagement counters depending on availability.\n\nTypical use cases:\n- Building a creator's content timeline and monitoring new posts\n- Batch collection for analytics, reporting, and dataset building\n- Creator/KOL and competitor monitoring\n", + "description": "Get Xiaohongshu (RedNote) user Published Notes data, including note metadata, covers, and publish times, for account monitoring.", "operationId": "getUserNoteListV2", "parameters": [ { @@ -67344,16 +67255,16 @@ "description": "default response" } }, - "summary": "User Published Notes (V2)", + "summary": "User Published Notes", "tags": [ - "Xiaohongshu" + "Xiaohongshu (RedNote)" ], "x-order": "12001200" } }, "/api/xiaohongshu/get-user-note-list/v4": { "get": { - "description": "Retrieves a paginated list of notes published by a specific Xiaohongshu user.\nEach page returns basic note data (e.g., note ID, title/text snippet, publish time, cover/media info when available)\nand may include engagement counters depending on availability.\n\nTypical use cases:\n- Building a creator's content timeline and monitoring new posts\n- Batch collection for analytics, reporting, and dataset building\n- Creator/KOL and competitor monitoring\n", + "description": "Get Xiaohongshu (RedNote) user Published Notes data, including note metadata, covers, and publish times, for account monitoring.", "operationId": "getUserNoteListV4", "parameters": [ { @@ -67466,16 +67377,16 @@ "description": "default response" } }, - "summary": "User Published Notes (V4)", + "summary": "User Published Notes", "tags": [ - "Xiaohongshu" + "Xiaohongshu (RedNote)" ], "x-order": "12001300" } }, "/api/xiaohongshu/get-user/v3": { "get": { - "description": "Retrieves Xiaohongshu user profile data, including user identifiers and profile metadata\n(e.g., nickname, avatar, bio), as well as public counters such as follower count and like count (when available).\n\nTypical use cases:\n- Identifying creators/KOLs and building creator lists\n- Enriching user records for analytics and reporting\n- Creator monitoring (profile and counter changes over time)\n", + "description": "Get Xiaohongshu (RedNote) user Profile data, including follower counts and bio details, for creator research, account analysis, and competitor monitoring.", "operationId": "getUserV3", "parameters": [ { @@ -67672,9 +67583,9 @@ "description": "default response" } }, - "summary": "User Profile (V3)", + "summary": "User Profile", "tags": [ - "Xiaohongshu" + "Xiaohongshu (RedNote)" ], "x-order": "12001000" } @@ -67682,7 +67593,7 @@ "/api/xiaohongshu/get-user/v4": { "get": { "deprecated": true, - "description": "Retrieves Xiaohongshu user profile data, including user identifiers and profile metadata\n(e.g., nickname, avatar, bio), as well as public counters such as follower count and like count (when available).\n\nTypical use cases:\n- Identifying creators/KOLs and building creator lists\n- Enriching user records for analytics and reporting\n- Creator monitoring (profile and counter changes over time)\n", + "description": "Get Xiaohongshu (RedNote) user Profile data, including follower counts and bio details, for creator research, account analysis, and competitor monitoring.", "operationId": "getUserV4", "parameters": [ { @@ -67919,16 +67830,16 @@ "description": "default response" } }, - "summary": "User Profile (V4)", + "summary": "User Profile", "tags": [ - "Xiaohongshu" + "Xiaohongshu (RedNote)" ], "x-order": "12001100" } }, "/api/xiaohongshu/search-note/v2": { "get": { - "description": "Searches Xiaohongshu notes by keyword and optional filters, returning a paginated result set.\nEach result typically includes basic note information (e.g., note ID, title/text snippet, cover/media info),\nauthor signals (when available), and engagement counters (when available).\n\nTypical use cases:\n- Topic/keyword research and trend analysis\n- Discovering notes for monitoring, analytics, and dataset building\n- Campaign and competitor content discovery\n", + "description": "Get Xiaohongshu (RedNote) note Search data, including snippets, authors, and media, for topic discovery.", "operationId": "getSearchNoteV2", "parameters": [ { @@ -68134,9 +68045,9 @@ "description": "default response" } }, - "summary": "Note Search (V2)", + "summary": "Note Search", "tags": [ - "Xiaohongshu" + "Xiaohongshu (RedNote)" ], "x-order": "12002000" } @@ -68144,7 +68055,7 @@ "/api/xiaohongshu/search-note/v3": { "get": { "deprecated": true, - "description": "Searches Xiaohongshu notes by keyword and optional filters, returning a paginated result set.\nEach result typically includes basic note information (e.g., note ID, title/text snippet, cover/media info),\nauthor signals (when available), and engagement counters (when available).\n\nTypical use cases:\n- Topic/keyword research and trend analysis\n- Discovering notes for monitoring, analytics, and dataset building\n- Campaign and competitor content discovery\n", + "description": "Get Xiaohongshu (RedNote) note Search data, including snippets, authors, and media, for topic discovery.", "operationId": "getSearchNoteV3", "parameters": [ { @@ -68222,16 +68133,16 @@ "description": "default response" } }, - "summary": "Note Search (V3)", + "summary": "Note Search", "tags": [ - "Xiaohongshu" + "Xiaohongshu (RedNote)" ], "x-order": "12002100" } }, "/api/xiaohongshu/search-recommend/v1": { "get": { - "description": "Retrieves keyword suggestions for Xiaohongshu search.\nGiven an input keyword prefix, this endpoint returns a list of recommended/related search terms\nthat can be used to refine queries.\n\nTypical use cases:\n- Expanding keyword sets for content research and SEO/pSEO workflows\n- Improving search coverage by using platform-recommended terms\n- Building autocomplete experiences and discovery tools\n", + "description": "Get Xiaohongshu (RedNote) keyword Suggestions data, including suggested queries, keyword variants, and query metadata, for expanding keyword sets for content research and seo/pseo workflows and improving search coverage by using platform-recommended terms.", "operationId": "searchRecommendV1", "parameters": [ { @@ -68525,16 +68436,16 @@ "description": "default response" } }, - "summary": "Search Keyword Suggestions (V1)", + "summary": "Keyword Suggestions", "tags": [ - "Xiaohongshu" + "Xiaohongshu (RedNote)" ], "x-order": "12002500" } }, "/api/xiaohongshu/search-user/v2": { "get": { - "description": "Searches Xiaohongshu users by keyword, returning a paginated result set with basic profile\ninformation (e.g., user ID, nickname, avatar, bio when available) and public counters/signals\n(when available).\n\nTypical use cases:\n- Finding creators/KOLs by niche, brand, or topic keywords\n- Building creator lists for monitoring and analytics\n- Discovering competitor accounts and related profiles\n", + "description": "Get Xiaohongshu (RedNote) user Search data, including profile metadata and public signals, for creator discovery and account research.", "operationId": "getSearchUserV2", "parameters": [ { @@ -69025,16 +68936,16 @@ "description": "default response" } }, - "summary": "User Search (V2)", + "summary": "User Search", "tags": [ - "Xiaohongshu" + "Xiaohongshu (RedNote)" ], "x-order": "12002200" } }, "/api/xiaohongshu/share-url-transfer/v1": { "get": { - "description": "Converts a shared RedNote note short link into a normal (resolved) note URL.\nThis is typically used to extract the note ID from a share link for downstream APIs\n(e.g., Note Details or Note Comments).\n\nTypical use cases:\n- Turning user-provided share links into structured identifiers (note ID)\n- Normalizing links before fetching note details, media, or comments\n- Automating workflows that start from share links\n", + "description": "Get Xiaohongshu (RedNote) share Link Resolution data, including helping extract note IDs, for downstream note and comment workflows.", "operationId": "shareUrlTransferV1", "parameters": [ { @@ -69071,16 +68982,16 @@ "description": "default response" } }, - "summary": "Share Link Convert (V3)", + "summary": "Share Link Resolution", "tags": [ - "Xiaohongshu" + "Xiaohongshu (RedNote)" ], "x-order": "12002400" } }, "/api/youku/get-user-detail/v1": { "get": { - "description": "This API retrieves detailed profile information of a specific Youku creator/user, including user ID, username, avatar, signature/description, follower count, following count, total videos, and verification status.\n\nTypical use cases:\n- Analyzing creator influence and audience size.\n- Monitoring account growth and verification status.\n- Fetching basic user info for social CRM.\n", + "description": "Get YOUKU user Profile data, including user ID, username, and avatar, for analyzing creator influence and audience size, monitoring account growth and verification status, and fetching basic user info for social crm.", "operationId": "getUserDetailV1", "parameters": [ { @@ -69335,16 +69246,16 @@ "description": "default response" } }, - "summary": "User Profile (V1)", + "summary": "User Profile", "tags": [ - "Youku" + "YOUKU" ], "x-order": "23001200" } }, "/api/youku/get-video-detail/v1": { "get": { - "description": "This API retrieves detailed information of a specific Youku video, including video ID, title, description, cover image, duration, tags, play count, like count, publish time, and the video's detail page URL.\n\nTypical use cases:\n- Fetching comprehensive metadata for a single video.\n- Tracking engagement metrics like play counts and likes.\n- Integrating detailed video info into third-party dashboards.\n", + "description": "Get YOUKU video Details data, including video ID, title, and description, for fetching comprehensive metadata for a single video, tracking engagement metrics like play counts and likes, and integrating detailed video info into third-party dashboards.", "operationId": "getVideoDetailV1", "parameters": [ { @@ -69553,16 +69464,16 @@ "description": "default response" } }, - "summary": "Video Details (V1)", + "summary": "Video Details", "tags": [ - "Youku" + "YOUKU" ], "x-order": "23001100" } }, "/api/youku/search-video/v1": { "get": { - "description": "This API performs a keyword-based search on Youku, returning a list of videos that match the search term.\nReturned fields include video ID, title, cover image, duration, play count, publish time, and the video's detail page URL.\n\nTypical use cases:\n- Keyword-based video discovery.\n- Monitoring specific topics or trends on Youku.\n- Analyzing search results for market research.\n", + "description": "Get YOUKU video Search data, including video ID, title, and cover image, for keyword-based video discovery, monitoring specific topics or trends on youku, and analyzing search results for market research.", "operationId": "searchVideoV1", "parameters": [ { @@ -69930,16 +69841,64 @@ "description": "default response" } }, - "summary": "Video Search (V1)", + "summary": "Video Search", "tags": [ - "Youku" + "YOUKU" ], "x-order": "23001000" } }, + "/api/youtube/get-channel-videos/v1": { + "get": { + "description": "Retrieve a list of videos from a specific YouTube channel, providing detailed insights into content performance and upload history.", + "operationId": "getChannelVideosV1", + "parameters": [ + { + "description": "Access token for this API service.", + "in": "query", + "name": "token", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The unique identifier for a YouTube channel.", + "in": "query", + "name": "channelId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The cursor for pagination.", + "in": "query", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "content": { + "application/json": {} + }, + "description": "default response" + } + }, + "summary": "Channel Videos", + "tags": [ + "YouTube" + ], + "x-order": "25001001" + } + }, "/api/youtube/get-video-detail/v1": { "get": { - "description": "Retrieves detailed metadata for a specific YouTube video, including its title, description,\nview counts, channel information, and media assets.\n\nTypical use cases\n- Tracking video engagement and statistics\n- Extracting video metadata for content analysis\n- Verifying video availability and status\n", + "description": "Get YouTube video Details data, including its title, description, and view counts, for tracking video engagement and statistics, extracting video metadata for content analysis, and verifying video availability and status.", "operationId": "getVideoDetailV1", "parameters": [ { @@ -70001,7 +69960,7 @@ "description": "default response" } }, - "summary": "Video Details (V1)", + "summary": "Video Details", "tags": [ "YouTube" ], @@ -70010,7 +69969,7 @@ }, "/api/zhihu/get-answer-list/v1": { "get": { - "description": "Retrieve the list of answers under a specific Zhihu question by its question ID.\n\nTypical use cases:\n- Analyzing user opinions and extracting high-quality responses.\n- Studying community engagement and topic discussions.\n", + "description": "Get Zhihu answer List data, including answer content, author profiles, and interaction metrics, for question analysis and answer research.", "operationId": "getAnswerListV1", "parameters": [ { @@ -70334,7 +70293,7 @@ "description": "default response" } }, - "summary": "Answer List (V1)", + "summary": "Answer List", "tags": [ "Zhihu" ], @@ -70343,7 +70302,7 @@ }, "/api/zhihu/get-column-article-detail/v1": { "get": { - "description": "Retrieve detailed information for a specific Zhihu Column article by its article ID.\n\nTypical use cases:\n- In-depth content analysis of professional articles.\n- Creator performance evaluation and topic trend monitoring.\n", + "description": "Get Zhihu column Article Details data, including title, author, and content, for article archiving and content research.", "operationId": "getColumnArticleDetailV1", "parameters": [ { @@ -70635,7 +70594,7 @@ "description": "default response" } }, - "summary": "Column Article Details (V1)", + "summary": "Column Article Details", "tags": [ "Zhihu" ], @@ -70644,7 +70603,7 @@ }, "/api/zhihu/get-column-article-list/v1": { "get": { - "description": "Retrieve the list of articles published under a specific Zhihu Column by its column ID.\n\nTypical use cases:\n- Tracking creator output and analyzing column performance.\n- Knowledge aggregation based on specific topics.\n", + "description": "Get Zhihu column Article List data, including article metadata and list ordering, for column monitoring and content collection.", "operationId": "getColumnArticleListV1", "parameters": [ { @@ -70768,7 +70727,7 @@ "description": "default response" } }, - "summary": "Column Article List (V1)", + "summary": "Column Article List", "tags": [ "Zhihu" ], @@ -70777,7 +70736,7 @@ }, "/api/zhihu/search/v1": { "get": { - "description": "Search for Zhihu content (including questions, answers, and articles) by keyword.\n\nTypical use cases:\n- Topic discovery and competitive brand monitoring.\n- Identifying trending discussions and high-value creators.\n", + "description": "Get Zhihu keyword Search data, including matched results, metadata, and ranking signals, for topic discovery and content research.", "operationId": "searchV1", "parameters": [ { @@ -70955,7 +70914,7 @@ "description": "default response" } }, - "summary": "Search (V1)", + "summary": "Keyword Search", "tags": [ "Zhihu" ], @@ -70968,107 +70927,5 @@ "description": "Generated server url", "url": "https://47.117.133.51" } - ], - "tags": [ - { - "description": "IMDb Data Services\n\nMain endpoints:\n- Movie and TV title details (metadata, ratings, cast, plot, awards, box office, etc.)\n- Search functionality (titles, people, etc.)\n- News and charts (top 250, streaming picks, news by category)\n\nTypical use cases:\n- Retrieve comprehensive metadata for specific movies or TV shows using IMDb IDs (tt-prefixed).\n- Search for titles and celebrities with customizable filters.\n- Track trending movies and top-rated content via chart rankings.\n", - "name": "IMDb" - }, - { - "description": "APIs for retrieving content, creator, and engagement data from Xiaohongshu.\n\nMain endpoints\n- Note Details: retrieve a single note/post with text (plain/rich when available), media (images/video),\n publish time, author info, and engagement metrics (when available).\n- User Published Notes: list notes published by a specific user with pagination, useful for creator monitoring\n and building content timelines.\n- Note Search: search notes by keyword and optional filters, returning paginated results for discovery and analysis.\n- User Search: search creators/users by keyword, returning basic profile signals for identification and tracking.\n- Note Comments: retrieve comments for a note with pagination, useful for sentiment and community feedback analysis.\n\nTypical use cases\n- Content research and trend analysis (keywords/topics/hashtags)\n- Creator/KOL monitoring and competitive intelligence\n- Brand reputation and sentiment monitoring based on notes and comments\n- Building datasets for analytics, reporting, and downstream automation\n", - "name": "Xiaohongshu" - }, - { - "description": "APIs for retrieving video content, creator, and engagement data from Douyin (TikTok China).\n\nMain endpoints\n- User Profile: retrieve profile information for a specific Douyin user (nickname, avatar, follower count, etc.).\n- User Published Videos: list videos published by a specific user with pagination, useful for creator monitoring.\n- Video Details: get comprehensive metadata for a single video, including play URL, statistics, and author info.\n- Video Search: search videos by keyword and optional filters (sort, publish time, duration).\n- User Search: search Douyin creators/users by keyword.\n- Video Comments: fetch top-level comments for a video with pagination.\n- Comment Replies: fetch nested replies for a specific top-level comment with paging.\n- Share Link Resolution: convert Douyin short share URLs to structured data.\n\nTypical use cases\n- Content research and trend analysis (keywords/topics/hashtags)\n- Creator/KOL monitoring and competitive intelligence\n- Brand reputation and sentiment monitoring based on videos and comments\n- Building datasets for analytics, reporting, and downstream automation\n", - "name": "Douyin" - }, - { - "description": "TikTok Shop Data Services.\n\nMain endpoints\n- Search Products: search for products on TikTok Shop based on keywords and region.\n- Product Detail: retrieve detailed information for a specific product on TikTok Shop.\n", - "name": "TikTok Shop" - }, - { - "description": "Facebook Data Services.\n\nMain endpoints:\n- Search Posts: Search for public posts using keywords and date ranges.\n\nTypical use cases:\n- Monitoring social media sentiment or trends related to specific topics.\n- Researching public discourse and engagement on Facebook.\n", - "name": "Facebook" - }, - { - "description": "Xiaohongshu Pgy (Pugongying) data services.", - "name": "Xiaohongshu Pgy" - }, - { - "description": "Unified APIs for product data on JD.com.\n\nIncluded endpoints\n- Product Details: retrieve product core information such as title, images, price, SKU/variants, shop info, and status.\n- Product Comments: fetch user reviews/comments with paging, useful for sentiment and public-opinion monitoring.\n\nTypical use cases\n- E-commerce analytics: product/brand/category analysis, trend tracking, and report generation.\n- Price monitoring: scheduled checks for price changes and availability status.\n- Review & sentiment monitoring: track comment volume, rating shifts, and negative/positive feedback signals.\n- Competitor intelligence: monitor competing products and compare pricing and review signals over time.\n", - "name": "JD" - }, - { - "description": "Bilibili API endpoints\n\nMain endpoints:\n- Video Details: Get video metadata, stats, and uploader info.\n- User Profile: Get user profile, videos, and stats.\n- Search: Keyword-based video search.\n- Interactions: Comments, replies, danmaku.\n\nTypical use cases:\n- Tracking video performance and engagement metrics.\n- Analyzing user/creator content and growth.\n- Gathering community feedback and trends.\n", - "name": "Bilibili" - }, - { - "description": "Weixin Official Account (WeChat) API\n\nMain endpoints:\n- User Published Posts: Retrieves posts from a specific official account.\n- Article Engagement Metrics: Retrieves read counts, likes, etc., for an article.\n- Article Comments: Retrieves user comments from an article.\n- Search: Keywords search for accounts and articles.\n- Article Details: Retrieves core metadata for an article.\n\nTypical use cases:\n- Monitoring account-level content and engagement.\n- Analyzing article-level performance metrics.\n- Collecting public community feedback and discussions.\n", - "name": "Weixin" - }, - { - "description": "Youku API for video search, video details, and user profile information.\n\nMain endpoints:\n- Search for videos by keyword.\n- Retrieve detailed metadata for specific videos.\n- Fetch comprehensive profile details for creators and users.\n\nTypical use cases:\n- Content monitoring and keyword-based trend analysis.\n- Data collection for video engagement metrics (play counts, likes).\n- Social media listening and creator influence assessment.\n", - "name": "Youku" - }, - { - "description": "Unified APIs for retrieving metadata and content details from YouTube.\n\nTypical use cases\n- Video monitoring: track view counts, engagement, and metadata changes for specific videos.\n- Content analysis: extract video titles, descriptions, and tags for trend research or content classification.\n- Marketing intelligence: monitor competitor channels or specific promotional content.\n- Media tracking: verify video status, availability, and basic metadata for platform monitoring.\n", - "name": "YouTube" - }, - { - "description": "Zhihu data services.\n\nMain endpoints:\n- Search: Retrieve content based on keywords.\n- Column: Access detailed information and article lists from specific columns.\n- Question/Answer: Fetch answer lists and engagement metrics for specific questions.\n\nTypical use cases:\n- Market research and consumer sentiment analysis.\n- Tracking expert opinions and professional knowledge trends.\n- Monitoring brand or product discussions on a leading knowledge-sharing platform.\n", - "name": "Zhihu" - }, - { - "description": "Douyin Xingtu data services.", - "name": "Douyin Xingtu" - }, - { - "description": "Unified APIs for retrieving data from Instagram, including user profiles, post details, published content, and reels/hashtag searches.\n\nMain endpoints\n- User Profile: Retrieves public profile information of an Instagram user, including follower count, following count, and post count.\n- Post Details: Retrieves detailed information of a public Instagram post by post code, including media content (images/videos) and engagement metrics.\n- User Published Posts: Retrieves a list of public posts published by an Instagram user, with pagination support.\n- Reels & Hashtag Search: Search public Instagram Reels or hashtag-specific posts by keywords or hashtag.\n\nTypical use cases\n- Tracking influencer performance and audience growth.\n- Monitoring trending content through keyword and hashtag searches.\n- Analyzing post engagement metrics for specific accounts or topics.\n", - "name": "Instagram" - }, - { - "description": "Amazon Data Services.\n\nMain endpoints\n- Product Details: retrieve comprehensive product information from Amazon based on the provided ASIN, including basic metadata (title, brand, category), media assets (images), availability, and pricing.\n- Product Top Reviews: retrieve top (most relevant or most helpful) public reviews for an Amazon product, including ratings, content, and Helpful vote counts.\n- Best Sellers: explore top-performing products across various categories on Amazon, including sales rank and popularity indicators.\n\nTypical use cases\n- E-commerce analytics: product/brand/category analysis, trend tracking, and report generation.\n- Price monitoring and availability tracking: scheduled checks for price changes and availability status on Amazon.\n- Review & sentiment monitoring: track consumer feedback and ratings to analyze product performance and customer satisfaction.\n- Competitor intelligence: monitor competing products on Amazon and compare pricing and review signals over time.\n", - "name": "Amazon" - }, - { - "description": "APIs for retrieving video content, creator, and engagement data from Kuaishou.\n\nMain endpoints\n- User Profile: retrieve profile information for a specific Kuaishou user (nickname, avatar, follower count, etc.).\n- User Published Videos: list videos published by a specific user with pagination.\n- Video Details: get comprehensive metadata for a single video, including play URL, statistics, and author info.\n- Video Search: search videos by keyword.\n- User Search: search Kuaishou creators/users by keyword.\n- Video Comments: fetch comments for a video with pagination.\n- Share Link Resolution: convert Kuaishou share URLs to structured data.\n\nTypical use cases\n- Content research and trend analysis\n- Creator/KOL monitoring\n- Brand reputation monitoring\n- Building datasets for analytics\n", - "name": "Kuaishou" - }, - { - "description": "Unified APIs for product data on Taobao and Tmall.\n\nAlthough Taobao and Tmall are separate marketplaces in Alibaba's ecosystem, on this API platform they share the same\nendpoint set and response model. No platform parameter is required — the APIs work in a unified manner across both.\n\nIncluded endpoints\n- Product Details: retrieve product core information such as title, images, price, SKU/variants (if available), shop info, and status.\n- Shop Product List: list products under a shop with pagination/sorting, useful for store monitoring and catalog building.\n- Product Search: search products by keyword/filters, useful for discovery, analysis, and building watchlists.\n- Product Comments: fetch user reviews/comments with paging, useful for sentiment and public-opinion monitoring.\n\nTypical use cases\n- E-commerce analytics: product/brand/category analysis, trend tracking, and report generation.\n- Price monitoring: scheduled checks for price changes, promotions, and availability status.\n- Review & sentiment monitoring: track comment volume, rating shifts, and negative/positive feedback signals.\n- Content enrichment: obtain product media (images) and basic metadata for catalogs or internal systems.\n- Competitor intelligence: monitor competing shops/products and compare pricing and review signals over time.\n", - "name": "Taobao & Tmall" - }, - { - "description": "APIs for Douban movie metadata, reviews, and comments.\n\nMain endpoints:\n- Movie Reviews: Retrieve long-form user reviews for movies.\n- Movie Review Details: Get detailed content of a specific movie review.\n- Movie Comments: Retrieve short user comments for movies.\n\nTypical use cases:\n- Sentiment analysis for film and media content.\n- Academic and market research on audience reception.\n", - "name": "Douban" - }, - { - "description": "APIs for retrieving posts, user profiles, engagement metrics, and trending topics from Weibo.\n\nMain endpoints\n- Keyword Search: search Weibo posts by keywords and time range, returning content and metrics.\n- User Profile: retrieve detailed information for a specified Weibo user.\n- Post Details: get comprehensive metadata for a single Weibo post.\n- User Published Posts: list posts published by a specific user with pagination.\n- User Fans/Followers: retrieve the follower and following lists for a user.\n- TV Video Details: get metadata and media URLs for Weibo TV components.\n- Hot Search: fetch current trending topics on Weibo.\n\nTypical use cases\n- Social media monitoring and brand sentiment analysis\n- Public opinion research and trend tracking\n- Creator and influencer identification and monitoring\n- Gathering public data for research or business intelligence\n", - "name": "Weibo" - }, - { - "description": "Unified search APIs across multiple social media platforms.\n\nIncluded endpoints\n- Unified Search: retrieve social media data from multiple sources (Weibo, Weixin, Douyin, etc.) in a single request.\n\nTypical use cases\n- Multi-platform trend analysis: search for specific keywords across different social media ecosystems.\n- Public opinion monitoring: track hot topics and sentiment shifts on a cross-platform scale.\n", - "name": "Search" - }, - { - "description": "Ke Holdings / Beike (Lianjia) Data API.\n\nMain endpoints:\n- Resale Housing Details: Comprehensive data for second-hand property listings.\n- Resale Housing List: Filterable list of available second-hand properties.\n- Community List: Details and statistics for residential communities (Xiaoqu).\n\nTypical use cases:\n- Property market analysis and valuation.\n- Tracking housing trends and availability in specific regions.\n- Community-level demographic and price research.\n", - "name": "Beike" - }, - { - "description": "TikTok Global Data (Overseas Version).\n\nMain endpoints:\n- User Profiles and published posts (V1).\n- Post details and metadata including engagement metrics (V1).\n- Keyword search for users and posts (V1).\n- Interactive data such as comments and sub-comments (V1).\n\nTypical use cases:\n- Global market analysis and influencer discovery.\n- Content performance tracking on TikTok.\n- Brand sentiment analysis via comment retrieval.\n- Cross-region trend monitoring.\n", - "name": "TikTok" - }, - { - "description": "X (formerly Twitter) Data Services.\n\nMain endpoints:\n- User Details: Retrieve basic profile information and statistics of X users.\n- User Published Posts: Access a user's tweet timeline with pagination support.\n\nTypical use cases:\n- Monitoring user account growth and engagement metrics.\n- Analyzing public tweet history for market research or brand sentiment.\n\nNotes:\n- Only public data is accessible via these endpoints.\n- User Rest ID is required for identifying the target account.\n", - "name": "X(Twitter)" - }, - { - "description": "APIs for retrieving data from Reddit, including post details, comments, and search results.\n\nReddit is a network of communities where people can dive into their interests, hobbies and passions.\nThese APIs allow for systematic extraction of public discussions and content.\n\nIncluded endpoints\n- Post Details: Retrieve comprehensive information about a specific post, including its content and engagement metrics.\n- Post Comments: Fetch the discussion thread for a given post with pagination support.\n- Search: Search for posts across Reddit based on keywords and filters.\n\nTypical use cases\n- Public opinion analysis: Track discussions around specific brands, products, or topics.\n- Market research: Understand community sentiment and emerging trends within specific subreddits.\n- Content aggregation: Collect high-quality community-driven content for research or archival purposes.\n", - "name": "Reddit" - }, - { - "description": "Toutiao (Jinri Toutiao) Data Services.\n\nMain endpoints:\n- Article Details: Retrieve comprehensive metadata and engagement metrics for Toutiao articles.\n- User Profile: Access detailed creator information, including verification status and performance stats.\n- Search: Perform keyword-based content discovery across the Toutiao ecosystem.\n\nTypical use cases:\n- Media monitoring and trend analysis.\n- Creator performance tracking and influencer profiling.\n- Content aggregation and keyword intelligence.\n", - "name": "Toutiao" - } ] } diff --git a/openapi/public-api.normalized.json b/openapi/public-api.normalized.json index 99a7c8c3..1bd19805 100644 --- a/openapi/public-api.normalized.json +++ b/openapi/public-api.normalized.json @@ -49,7 +49,7 @@ "paths": { "/api/amazon/get-best-sellers/v1": { "get": { - "description": "Retrieves top performing products for a given category on Amazon.\nSupports top level best sellers categories (e.g. software). In addition, subcategories / category path can be specified.\n\nTypical use cases:\n- Identifying trending products in specific categories\n- Market share analysis and category research\n- Tracking sales rank and popularity over time\n", + "description": "Get Amazon best Sellers data, including rank positions, product metadata, and pricing, for identifying trending products in specific categories, market share analysis and category research, and tracking sales rank and popularity over time.", "operationId": "getBestSellersV1", "parameters": [ { @@ -687,7 +687,7 @@ "tokenAuth": [] } ], - "summary": "Best Sellers (V1)", + "summary": "Best Sellers", "tags": [ "Amazon" ], @@ -699,7 +699,7 @@ }, "/api/amazon/get-category-products/v1": { "get": { - "description": " Retrieves products under a specified Amazon category.\n Supports category-based product discovery and returns product information such as title, price, rating, review count, and other available marketplace fields.\n\n Typical use cases:\n - Discovering products within a specific category\n - Category research and competitor analysis\n - Monitoring product assortment, pricing, and popularity trends\n", + "description": "Get Amazon products By Category data, including title, price, and rating, for category-based product discovery and returns product information such as title, price, and rating.", "operationId": "getProductsByCategoryV1", "parameters": [ { @@ -796,7 +796,7 @@ "tokenAuth": [] } ], - "summary": "Products By Category (V1)", + "summary": "Products By Category", "tags": [ "Amazon" ], @@ -808,7 +808,7 @@ }, "/api/amazon/get-product-detail/v1": { "get": { - "description": "Retrieves detailed product information from Amazon based on the provided ASIN.\nIt returns core product data such as title, brand, price, availability, rating,\nreview count, product images, category information, and other publicly available details.\n\nTypical use cases:\n- Building product catalogs and enriching item content (e.g., images)\n- Price monitoring and availability tracking\n- E-commerce analytics and competitor tracking\n", + "description": "Get Amazon product Details data, including title, brand, and price, for building product catalogs and enriching item content (e.g., images), price monitoring and availability tracking, and e-commerce analytics and competitor tracking.", "operationId": "getProductDetailV1", "parameters": [ { @@ -1244,7 +1244,7 @@ "tokenAuth": [] } ], - "summary": "Product Details (V1)", + "summary": "Product Details", "tags": [ "Amazon" ], @@ -1256,7 +1256,7 @@ }, "/api/amazon/get-product-top-reviews/v1": { "get": { - "description": "Retrieves top (most relevant or most helpful) public reviews for an Amazon product based on the provided ASIN.\nIt returns review details such as review ID, reviewer name, rating score,\nreview title, review content, publish time, and helpful vote count (if available).\n\nTypical use cases:\n- Sentiment analysis and consumer feedback tracking\n- Product research and quality assessment\n- Monitoring competitor customer experience\n", + "description": "Get Amazon product Top Reviews data, including most helpful) public reviews, for sentiment analysis and consumer feedback tracking, product research and quality assessment, and monitoring competitor customer experience.", "operationId": "getProductTopReviewsV1", "parameters": [ { @@ -1470,7 +1470,7 @@ "tokenAuth": [] } ], - "summary": "Product Top Reviews (V1)", + "summary": "Product Top Reviews", "tags": [ "Amazon" ], @@ -1482,7 +1482,7 @@ }, "/api/beike/community/list/v1": { "get": { - "description": "Retrieves a list of residential communities (Xiaoqu) from Beike (Lianjia) within a specified city.\n\nThe data includes:\n- Community name and unique ID.\n- Average listing price and historical price trends.\n- Build year and architectural details.\n- Geographical coordinates and location information.\n\nTypical use cases:\n- Identifying popular residential areas in a city.\n- Comparing average housing prices across different communities.\n- Spatial analysis of property development patterns.\n", + "description": "Get Beike community List data, including - Community name and unique ID and Average listing price and historical price trends, for identifying popular residential areas in a city and comparing average housing prices across different communities.", "operationId": "communityListV1", "parameters": [ { @@ -2044,7 +2044,7 @@ "tokenAuth": [] } ], - "summary": "Community List (V1)", + "summary": "Community List", "tags": [ "Beike" ], @@ -2056,7 +2056,7 @@ }, "/api/beike/ershoufang/detail/v1": { "get": { - "description": "Retrieves comprehensive information for a specific second-hand property listing on Beike (Lianjia).\n\nThe data includes:\n- Pricing (total and unit price).\n- Physical attributes (area, layout, floor, orientation).\n- Listing metadata (tags, listing date).\n- Agent contact information.\n\nTypical use cases:\n- Displaying a full property profile to users.\n- Detailed price comparison between specific listings.\n", + "description": "Get Beike resale Housing Details data, including - Pricing (total and unit price), Physical attributes (area, and layout, for displaying a full property profile to users and detailed price comparison between specific listings.", "operationId": "ershoufangDetailV1", "parameters": [ { @@ -2338,7 +2338,7 @@ "tokenAuth": [] } ], - "summary": "Resale Housing Details (V1)", + "summary": "Resale Housing Details", "tags": [ "Beike" ], @@ -2350,7 +2350,7 @@ }, "/api/beike/get-ershoufang-list/v1": { "get": { - "description": "Fetches a list of second-hand property listings from Beike (Lianjia) based on specified filters.\n\nKey features:\n- Supports filtering by city/region, price range, layout, and area.\n- Returns core listing details such as title, total price, unit price, and community info.\n- Provides house codes for fetching full details via the detail API.\n\nTypical use cases:\n- Building search result pages for property portals.\n- Aggregating market data for regional housing trends.\n", + "description": "Get Beike resale Housing List data, including - Supports filtering by city/region, price range, and layout, for building search result pages for property portals and aggregating market data for regional housing trends.", "operationId": "getErshoufangListV1", "parameters": [ { @@ -2641,7 +2641,7 @@ "tokenAuth": [] } ], - "summary": "Resale Housing List (V1)", + "summary": "Resale Housing List", "tags": [ "Beike" ], @@ -2653,7 +2653,7 @@ }, "/api/bilibili/get-user-detail/v2": { "get": { - "description": "Retrieve detailed profile information of a specific Bilibili user, including username, avatar, level, and verification status.\n\nTypical use cases:\n- Analyzing creator's profile, level, and verification status.\n- Verifying user identity and social presence on Bilibili.\n", + "description": "Get Bilibili user Profile data, including account metadata, audience metrics, and verification-related fields, for analyzing creator's profile, level, and verification status and verifying user identity and social presence on bilibili.", "operationId": "getUserDetailV2", "parameters": [ { @@ -3229,7 +3229,7 @@ "tokenAuth": [] } ], - "summary": "User Profile (V2)", + "summary": "User Profile", "tags": [ "Bilibili" ], @@ -3241,7 +3241,7 @@ }, "/api/bilibili/get-user-relation-stat/v1": { "get": { - "description": "Retrieve follower count and following count for a specific Bilibili user.\n\nTypical use cases:\n- Tracking creator's follower growth and audience reach.\n- Analyzing social influence and account popularity.\n", + "description": "Get Bilibili user Relation Stats data, including following counts, for creator benchmarking and audience growth tracking.", "operationId": "getUserRelationStat", "parameters": [ { @@ -3286,7 +3286,7 @@ "tokenAuth": [] } ], - "summary": "User Relation Stats (V1)", + "summary": "User Relation Stats", "tags": [ "Bilibili" ], @@ -3298,7 +3298,7 @@ }, "/api/bilibili/get-user-video-list/v2": { "get": { - "description": "Retrieve a list of videos published by a specific Bilibili user, including video metadata, cover images, and engagement metrics.\n\nTypical use cases:\n- Monitoring creator's content updates and publishing patterns.\n- Building user-specific video catalogs for analysis.\n", + "description": "Get Bilibili user Published Videos data, including titles, covers, and publish times, for creator monitoring and content performance analysis.", "operationId": "getUserVideoListV2", "parameters": [ { @@ -3417,7 +3417,7 @@ "tokenAuth": [] } ], - "summary": "User Published Videos (V2)", + "summary": "User Published Videos", "tags": [ "Bilibili" ], @@ -3429,7 +3429,7 @@ }, "/api/bilibili/get-video-caption/v2": { "get": { - "description": "Retrieve subtitle/caption information for a specific Bilibili video.\n\nTypical use cases:\n- Extracting textual content from video subtitles for indexing or analysis.\n- Multi-language content processing and accessibility analysis.\n", + "description": "Get Bilibili video Captions data, including caption data, for transcript extraction and multilingual content analysis.", "operationId": "getVideoCaptionV1", "parameters": [ { @@ -3489,7 +3489,7 @@ "tokenAuth": [] } ], - "summary": "Video Captions (V2)", + "summary": "Video Captions", "tags": [ "Bilibili" ], @@ -3501,7 +3501,7 @@ }, "/api/bilibili/get-video-comment/v2": { "get": { - "description": "Retrieve top-level comments for a specific Bilibili video, including commenter info, text, likes, and timestamps.\n\nTypical use cases:\n- Gathering detailed viewer feedback and community discussions.\n- Sentiment analysis and public opinion monitoring.\n", + "description": "Get Bilibili video Comments data, including commenter profiles, text, and likes, for sentiment analysis and comment moderation workflows.", "operationId": "getVideoCommentV2", "parameters": [ { @@ -4438,7 +4438,7 @@ "tokenAuth": [] } ], - "summary": "Video Comments (V2)", + "summary": "Video Comments", "tags": [ "Bilibili" ], @@ -4450,7 +4450,7 @@ }, "/api/bilibili/get-video-danmu/v2": { "get": { - "description": "Retrieve danmaku (rolling comments) for a specific Bilibili video.\n\nTypical use cases:\n- Analyzing real-time viewer reactions and community trends.\n- Sentiment analysis based on rolling comments.\n", + "description": "Get Bilibili video Danmaku data, including timeline positions and comment text, for audience reaction analysis and subtitle-style comment review.", "operationId": "getVideoDanmuV2", "parameters": [ { @@ -4502,7 +4502,7 @@ "tokenAuth": [] } ], - "summary": "Video Danmaku (V2)", + "summary": "Video Danmaku", "tags": [ "Bilibili" ], @@ -4514,7 +4514,7 @@ }, "/api/bilibili/get-video-detail/v2": { "get": { - "description": "Retrieve comprehensive details about a specific Bilibili video, including metadata (title, tags, publishing time), statistics (views, likes, danmaku count), and uploader profile information.\n\nTypical use cases:\n- Tracking video performance and engagement metrics.\n- Analyzing content metadata and uploader information.\n", + "description": "Get Bilibili video Details data, including metadata (title, tags, and publishing time), for tracking video performance and engagement metrics and analyzing content metadata and uploader information.", "operationId": "getVideoDetailV2", "parameters": [ { @@ -5647,7 +5647,7 @@ "tokenAuth": [] } ], - "summary": "Video Details (V2)", + "summary": "Video Details", "tags": [ "Bilibili" ], @@ -5659,7 +5659,7 @@ }, "/api/bilibili/search-video/v2": { "get": { - "description": "Search for Bilibili videos based on keywords, returning matched videos with metadata, author information, and engagement stats.\n\nTypical use cases:\n- Discovering trending videos or creators by specific keywords.\n- Competitive analysis and market research on Bilibili.\n", + "description": "Get Bilibili video Search data, including matched videos, creators, and engagement metrics, for topic research and content discovery.", "operationId": "searchVideoV2", "parameters": [ { @@ -7198,7 +7198,7 @@ "tokenAuth": [] } ], - "summary": "Video Search (V2)", + "summary": "Video Search", "tags": [ "Bilibili" ], @@ -7210,7 +7210,7 @@ }, "/api/bilibili/share-url-transfer/v1": { "get": { - "description": "Resolve Bilibili share URLs (e.g., https://b23.tv/...) to get the original content metadata.\n\nTypical use cases:\n- Converting shortened mobile share links to standard BVID/metadata.\n- Automating content extraction from shared social media links.\n\nHighlights\n- Only supports share URLs starting with 'https://b23.tv/'.\n", + "description": "Get Bilibili share Link Resolution data, including resolved video and page identifier, for converting shortened mobile share links to standard bvid/metadata and automating content extraction from shared social media links.", "operationId": "shareUrlTransferV1", "parameters": [ { @@ -7244,7 +7244,7 @@ "tokenAuth": [] } ], - "summary": "Share Link Resolution (V1)", + "summary": "Share Link Resolution", "tags": [ "Bilibili" ], @@ -7256,7 +7256,7 @@ }, "/api/douban/get-movie-comments/v1": { "get": { - "description": "Retrieves short user comments (short reviews) for a specific movie subject (identified by subjectId).\n\nTypical use cases:\n- Fast-paced sentiment analysis using quick viewer comments.\n- Monitoring initial audience reaction upon movie release.\n", + "description": "Get Douban movie Comments data, including ratings, snippets, and interaction counts, for quick sentiment sampling and review monitoring.", "operationId": "getMovieCommentsV1", "parameters": [ { @@ -7318,9 +7318,9 @@ "tokenAuth": [] } ], - "summary": "Movie Comments (V1)", + "summary": "Comments", "tags": [ - "Douban" + "Douban Movie" ], "x-order": "21001200", "x-sdk-class-name": "DoubanResource", @@ -7330,7 +7330,7 @@ }, "/api/douban/get-movie-review-detail/v1": { "get": { - "description": "Retrieves the full content and metadata of a specific movie review (identified by reviewId).\n\nTypical use cases:\n- Fetching the complete text of a single long review.\n- Analyzing the structured data and user engagement (likes, replies) of a specific review.\n", + "description": "Get Douban movie Review Details data, including metadata, content fields, and engagement signals, for review archiving and detailed opinion analysis.", "operationId": "getMovieReviewDetailsV1", "parameters": [ { @@ -7370,9 +7370,9 @@ "tokenAuth": [] } ], - "summary": "Movie Review Details (V1)", + "summary": "Review Details", "tags": [ - "Douban" + "Douban Movie" ], "x-order": "21001100", "x-sdk-class-name": "DoubanResource", @@ -7382,7 +7382,7 @@ }, "/api/douban/get-movie-reviews/v1": { "get": { - "description": "Retrieves long-form user reviews for a specific movie subject (identified by subjectId).\n\nTypical use cases:\n- Analyzing detailed audience feedback for movies.\n- Long-term trend analysis of viewer sentiment.\n", + "description": "Get Douban movie Reviews data, including review titles, ratings, and snippets, for audience sentiment analysis and review research.", "operationId": "getMovieReviewsV1", "parameters": [ { @@ -7705,9 +7705,9 @@ "tokenAuth": [] } ], - "summary": "Movie Reviews (V1)", + "summary": "Movie Reviews", "tags": [ - "Douban" + "Douban Movie" ], "x-order": "21001000", "x-sdk-class-name": "DoubanResource", @@ -7717,7 +7717,7 @@ }, "/api/douban/get-recent-hot-movie/v1": { "get": { - "description": "Retrieves the latest hot movies currently trending on the platform.\n\nTypical use cases:\n- Discovering recently popular movies.\n- Tracking current movie trends for content analysis or recommendation.\n", + "description": "Get Douban recent Hot Movie data, including ratings, posters, and subject metadata, for movie discovery and trend monitoring.", "operationId": "getRecentHotMovieV1", "parameters": [ { @@ -8317,9 +8317,9 @@ "tokenAuth": [] } ], - "summary": "Recent Hot Movie (V1)", + "summary": "Recent Hot Movie", "tags": [ - "Douban" + "Douban Movie" ], "x-order": "21001300", "x-sdk-class-name": "DoubanResource", @@ -8329,7 +8329,7 @@ }, "/api/douban/get-recent-hot-tv/v1": { "get": { - "description": "Retrieves the latest hot TV shows currently trending on the platform.\n\nTypical use cases:\n- Discovering recently popular TV shows.\n- Tracking current TV trends for content analysis or recommendation.\n", + "description": "Get Douban recent Hot Tv data, including ratings, posters, and subject metadata, for series discovery and trend monitoring.", "operationId": "getRecentHotTvV1", "parameters": [ { @@ -8865,9 +8865,9 @@ "tokenAuth": [] } ], - "summary": "Recent Hot Tv (V1)", + "summary": "Recent Hot Tv", "tags": [ - "Douban" + "Douban Movie" ], "x-order": "21001400", "x-sdk-class-name": "DoubanResource", @@ -8877,7 +8877,7 @@ }, "/api/douban/get-subject-detail/v1": { "get": { - "description": "Retrieves detailed information for a specific subject identified by subjectId.\n\nTypical use cases:\n- Displaying complete subject metadata in applications or websites.\n- Supporting content analysis, cataloging, or detail page rendering.\n", + "description": "Get Douban subject Details data, including title, rating, and cast, for title enrichment and catalog research.", "operationId": "getSubjectDetailV1", "parameters": [ { @@ -8926,9 +8926,9 @@ "tokenAuth": [] } ], - "summary": "Subject Details (V1)", + "summary": "Subject Details", "tags": [ - "Douban" + "Douban Movie" ], "x-order": "21001200", "x-sdk-class-name": "DoubanResource", @@ -8938,7 +8938,7 @@ }, "/api/douyin-xingtu/get-author-commerce-seed-base-info/v1": { "get": { - "description": "Get author's commercial seeding data.", + "description": "Get Douyin Creator Marketplace (Xingtu) author Commerce Seeding Base Info data, including baseline metrics, commercial signals, and seeding indicators, for product seeding analysis, creator vetting, and campaign planning.", "operationId": "getAuthorCommerceSeedingBaseInfoV1", "parameters": [ { @@ -9008,9 +9008,9 @@ "tokenAuth": [] } ], - "summary": "Author Commerce Seeding Base Info (V1)", + "summary": "Author Commerce Seeding Base Info", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15005100", "x-sdk-class-name": "DouyinXingtuResource", @@ -9020,7 +9020,7 @@ }, "/api/douyin-xingtu/get-author-commerce-spread-info/v1": { "get": { - "description": "Get author's commercial spread metrics.", + "description": "Get Douyin Creator Marketplace (Xingtu) author Commerce Spread Info data, including spread metrics, for creator evaluation for campaign planning and media buying.", "operationId": "getAuthorCommerceSpreadInfoV1", "parameters": [ { @@ -9084,9 +9084,9 @@ "tokenAuth": [] } ], - "summary": "Author Commerce Spread Info (V1)", + "summary": "Author Commerce Spread Info", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15005000", "x-sdk-class-name": "DouyinXingtuResource", @@ -9096,7 +9096,7 @@ }, "/api/douyin-xingtu/get-author-content-hot-keywords/v1": { "get": { - "description": "Get analytical keywords from author's content.", + "description": "Get Douyin Creator Marketplace (Xingtu) kOL Content Keyword Analysis data, including core metrics, trend signals, and performance indicators, for content theme analysis and creator positioning research.", "operationId": "getAuthorContentHotKeywordsV1", "parameters": [ { @@ -9157,9 +9157,9 @@ "tokenAuth": [] } ], - "summary": "KOL Content Keyword Analysis (V1)", + "summary": "KOL Content Keyword Analysis", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15004900", "x-sdk-class-name": "DouyinXingtuResource", @@ -9169,7 +9169,7 @@ }, "/api/douyin-xingtu/get-author-hot-comment-tokens/v1": { "get": { - "description": "Get analytical tokens from author's top comments.", + "description": "Get Douyin Creator Marketplace (Xingtu) kOL Comment Keyword Analysis data, including core metrics, trend signals, and performance indicators, for audience language analysis and comment-topic research.", "operationId": "getAuthorHotCommentTokensV1", "parameters": [ { @@ -9259,9 +9259,9 @@ "tokenAuth": [] } ], - "summary": "KOL Comment Keyword Analysis (V1)", + "summary": "KOL Comment Keyword Analysis", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15004800", "x-sdk-class-name": "DouyinXingtuResource", @@ -9272,7 +9272,7 @@ "/api/douyin-xingtu/get-kol-audience-distribution/v1": { "get": { "deprecated": true, - "description": "Get fans audience distribution (Legacy).", + "description": "Get Douyin Creator Marketplace (Xingtu) audience Distribution data, including demographic and interest-based audience segmentation, for creator evaluation, campaign planning, and marketplace research.", "operationId": "getKolAudienceDistributionV1", "parameters": [ { @@ -9731,9 +9731,9 @@ "tokenAuth": [] } ], - "summary": "KOL Audience Profile (V1) [Deprecated]", + "summary": "Audience Distribution", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15003200", "x-sdk-class-name": "DouyinXingtuResource", @@ -9744,7 +9744,7 @@ "/api/douyin-xingtu/get-kol-convert-ability/v1": { "get": { "deprecated": true, - "description": "Get conversion capability analysis (Legacy).", + "description": "Get Douyin Creator Marketplace (Xingtu) conversion Analysis data, including conversion efficiency and commercial performance indicators, for creator evaluation, campaign planning, and marketplace research.", "operationId": "getKolConvertAbilityV1", "parameters": [ { @@ -9814,9 +9814,9 @@ "tokenAuth": [] } ], - "summary": "KOL Conversion Analysis (V1) [Deprecated]", + "summary": "Conversion Analysis", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15003800", "x-sdk-class-name": "DouyinXingtuResource", @@ -9827,7 +9827,7 @@ "/api/douyin-xingtu/get-kol-convert-videos-or-products/v1": { "get": { "deprecated": true, - "description": "Get detailed conversion resource list (Legacy).", + "description": "Get Douyin Creator Marketplace (Xingtu) conversion Resources data, including products tied to a Douyin Xingtu creator's conversion activity, for commerce analysis and campaign optimization.", "operationId": "getKolConvertVideosOrProductsV1", "parameters": [ { @@ -9908,9 +9908,9 @@ "tokenAuth": [] } ], - "summary": "KOL Conversion Video Display (V1) [Deprecated]", + "summary": "Conversion Resources", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15004100", "x-sdk-class-name": "DouyinXingtuResource", @@ -9921,7 +9921,7 @@ "/api/douyin-xingtu/get-kol-cp-info/v1": { "get": { "deprecated": true, - "description": "Get cost-effectiveness analysis data (Legacy).", + "description": "Get Douyin Creator Marketplace (Xingtu) cost Performance Analysis data, including pricing, exposure, and engagement efficiency indicators, for creator evaluation, campaign planning, and marketplace research.", "operationId": "getKolCpInfoV1", "parameters": [ { @@ -9985,9 +9985,9 @@ "tokenAuth": [] } ], - "summary": "KOL Cost-Effectiveness Analysis (V1) [Deprecated]", + "summary": "Cost Performance Analysis", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15004400", "x-sdk-class-name": "DouyinXingtuResource", @@ -9997,7 +9997,7 @@ }, "/api/douyin-xingtu/get-kol-daily-fans/v1": { "get": { - "description": "Get author's historical daily fans growth trend.", + "description": "Get Douyin Creator Marketplace (Xingtu) follower Growth Trend data, including historical audience changes over time, for creator evaluation, campaign planning, and marketplace research.", "operationId": "getKolDailyFansV1", "parameters": [ { @@ -10320,9 +10320,9 @@ "tokenAuth": [] } ], - "summary": "KOL Follower Trend (V1)", + "summary": "Follower Growth Trend", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15004700", "x-sdk-class-name": "DouyinXingtuResource", @@ -10333,7 +10333,7 @@ "/api/douyin-xingtu/get-kol-fans-distribution/v1": { "get": { "deprecated": true, - "description": "Get fans portrait (Legacy).", + "description": "Get Douyin Creator Marketplace (Xingtu) follower Profile data, including audience demographics, interests, and distribution metrics, for creator evaluation, campaign planning, and marketplace research.", "operationId": "getKolFansDistributionV1", "parameters": [ { @@ -10809,9 +10809,9 @@ "tokenAuth": [] } ], - "summary": "KOL Follower Profile (V1) [Deprecated]", + "summary": "Follower Profile", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15003300", "x-sdk-class-name": "DouyinXingtuResource", @@ -10822,7 +10822,7 @@ "/api/douyin-xingtu/get-kol-info/v1": { "get": { "deprecated": true, - "description": "Retrieve KOL profile information (Legacy).", + "description": "Get Douyin Creator Marketplace (Xingtu) creator Profile data, including audience and pricing data, for influencer vetting, benchmark analysis, and campaign planning.", "operationId": "getKolInfoV1", "parameters": [ { @@ -10964,9 +10964,9 @@ "tokenAuth": [] } ], - "summary": "KOL Profile (V1) [Deprecated]", + "summary": "Creator Profile", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15003100", "x-sdk-class-name": "DouyinXingtuResource", @@ -10977,7 +10977,7 @@ "/api/douyin-xingtu/get-kol-link-info/v1": { "get": { "deprecated": true, - "description": "Get author link index (Legacy).", + "description": "Get Douyin Creator Marketplace (Xingtu) creator Link Metrics data, including creator ranking, traffic structure, and related performance indicators, for creator evaluation, campaign planning, and marketplace research.", "operationId": "getKolLinkInfoV1", "parameters": [ { @@ -11078,9 +11078,9 @@ "tokenAuth": [] } ], - "summary": "KOL Xingtu Index (V1) [Deprecated]", + "summary": "Creator Link Metrics", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15004000", "x-sdk-class-name": "DouyinXingtuResource", @@ -11091,7 +11091,7 @@ "/api/douyin-xingtu/get-kol-link-struct/v1": { "get": { "deprecated": true, - "description": "Get author link structure (Legacy).", + "description": "Get Douyin Creator Marketplace (Xingtu) creator Link Structure data, including engagement and conversion metrics, for creator performance analysis.", "operationId": "getKolLinkStructV1", "parameters": [ { @@ -11167,9 +11167,9 @@ "tokenAuth": [] } ], - "summary": "KOL Link Struct (V1) [Deprecated]", + "summary": "Creator Link Structure", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15004200", "x-sdk-class-name": "DouyinXingtuResource", @@ -11180,7 +11180,7 @@ "/api/douyin-xingtu/get-kol-marketing-info/v1": { "get": { "deprecated": true, - "description": "Get marketing pricing info (Legacy).", + "description": "Get Douyin Creator Marketplace (Xingtu) marketing Rates data, including rate card details and commercial service metrics, for creator evaluation, campaign planning, and marketplace research.", "operationId": "getKolMarketingInfoV1", "parameters": [ { @@ -11418,9 +11418,9 @@ "tokenAuth": [] } ], - "summary": "KOL Service Pricing (V1) [Deprecated]", + "summary": "Marketing Rates", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15003400", "x-sdk-class-name": "DouyinXingtuResource", @@ -11431,7 +11431,7 @@ "/api/douyin-xingtu/get-kol-rec-videos/v1": { "get": { "deprecated": true, - "description": "Get author content and video performance (Legacy).", + "description": "Get Douyin Creator Marketplace (Xingtu) kOL Content Performance data, including video performance metrics, for creator evaluation, campaign planning, and marketplace research.", "operationId": "getKolRecVideosV1", "parameters": [ { @@ -11768,9 +11768,9 @@ "tokenAuth": [] } ], - "summary": "KOL Content Performance (V1) [Deprecated]", + "summary": "KOL Content Performance", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15004500", "x-sdk-class-name": "DouyinXingtuResource", @@ -11781,7 +11781,7 @@ "/api/douyin-xingtu/get-kol-show-items-v2/v1": { "get": { "deprecated": true, - "description": "Get showcased items or videos performance (Legacy).", + "description": "Get Douyin Creator Marketplace (Xingtu) video Performance data, including core metrics, trend signals, and performance indicators, for creator evaluation, campaign planning, and marketplace research.", "operationId": "getKolShowItemsV2V1", "parameters": [ { @@ -12277,9 +12277,9 @@ "tokenAuth": [] } ], - "summary": "KOL Video Performance (V1) [Deprecated]", + "summary": "Video Performance", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15003900", "x-sdk-class-name": "DouyinXingtuResource", @@ -12290,7 +12290,7 @@ "/api/douyin-xingtu/get-kol-spread-info/v1": { "get": { "deprecated": true, - "description": "Get spread performance metrics (Legacy).", + "description": "Get Douyin Creator Marketplace (Xingtu) creator Performance Overview data, including audience, content performance, and commercial indicators, for quick evaluation.", "operationId": "getKolSpreadInfoV1", "parameters": [ { @@ -12441,9 +12441,9 @@ "tokenAuth": [] } ], - "summary": "KOL Data Overview (V1) [Deprecated]", + "summary": "Creator Performance Overview", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15003500", "x-sdk-class-name": "DouyinXingtuResource", @@ -12454,7 +12454,7 @@ "/api/douyin-xingtu/get-kol-touch-distribution/v1": { "get": { "deprecated": true, - "description": "Get connected user source distribution (Legacy).", + "description": "Get Douyin Creator Marketplace (Xingtu) audience Source Distribution data, including segment breakdowns, audience composition, and distribution signals, for traffic analysis and existing integration compatibility.", "operationId": "getKolTouchDistributionV1", "parameters": [ { @@ -12608,9 +12608,9 @@ "tokenAuth": [] } ], - "summary": "KOL Connected User Sources (V1) [Deprecated]", + "summary": "Audience Source Distribution", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15004300", "x-sdk-class-name": "DouyinXingtuResource", @@ -12621,7 +12621,7 @@ "/api/douyin-xingtu/get-video-detail/v1": { "get": { "deprecated": true, - "description": "Get detailed video data (Legacy).", + "description": "Get Douyin Creator Marketplace (Xingtu) video Details data, including performance fields from the legacy Douyin Xingtu endpoint, for content review and integration compatibility.", "operationId": "getVideoDetailV1", "parameters": [ { @@ -12669,9 +12669,9 @@ "tokenAuth": [] } ], - "summary": "Video Details (V1) [Deprecated]", + "summary": "Video Details", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15005200", "x-sdk-class-name": "DouyinXingtuResource", @@ -12681,7 +12681,7 @@ }, "/api/douyin-xingtu/gw/api/aggregator/get_author_order_experience/v1": { "get": { - "description": "Get author's transaction experience summary.", + "description": "Get Douyin Creator Marketplace (Xingtu) creator Order Experience data, including commercial history and transaction-related indicators, for creator evaluation, campaign planning, and marketplace research.", "operationId": "gwApiAggregatorGetAuthorOrderExperienceV1", "parameters": [ { @@ -12735,9 +12735,9 @@ "tokenAuth": [] } ], - "summary": "Author Order Experience (V1)", + "summary": "Creator Order Experience", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15001400", "x-sdk-class-name": "DouyinXingtuResource", @@ -12747,7 +12747,7 @@ }, "/api/douyin-xingtu/gw/api/author/get_author_base_info/v1": { "get": { - "description": "Retrieve basic information for a specific author.", + "description": "Get Douyin Creator Marketplace (Xingtu) creator Profile data, including audience and pricing data, for influencer vetting, benchmark analysis, and campaign planning.", "operationId": "gwApiAuthorGetAuthorBaseInfoV1", "parameters": [ { @@ -12880,9 +12880,9 @@ "tokenAuth": [] } ], - "summary": "Author Base Info (V1)", + "summary": "Creator Profile", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15001000", "x-sdk-class-name": "DouyinXingtuResource", @@ -12892,7 +12892,7 @@ }, "/api/douyin-xingtu/gw/api/author/get_author_marketing_info/v1": { "get": { - "description": "Get author's marketing pricing and stats.", + "description": "Get Douyin Creator Marketplace (Xingtu) marketing Rates data, including rate card details and commercial service metrics, for creator evaluation, campaign planning, and marketplace research.", "operationId": "gwApiAuthorGetAuthorMarketingInfoV1", "parameters": [ { @@ -13121,9 +13121,9 @@ "tokenAuth": [] } ], - "summary": "Author Marketing Info (V1)", + "summary": "Marketing Rates", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15001800", "x-sdk-class-name": "DouyinXingtuResource", @@ -13133,7 +13133,7 @@ }, "/api/douyin-xingtu/gw/api/author/get_author_platform_channel_info_v2/v1": { "get": { - "description": "Retrieve author's platform channel data.", + "description": "Get Douyin Creator Marketplace (Xingtu) creator Channel Metrics data, including platform distribution and channel performance data used, for creator evaluation.", "operationId": "gwApiAuthorGetAuthorPlatformChannelInfoV2V1", "parameters": [ { @@ -13189,9 +13189,9 @@ "tokenAuth": [] } ], - "summary": "Author Platform Channel Info (V1)", + "summary": "Creator Channel Metrics", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15001300", "x-sdk-class-name": "DouyinXingtuResource", @@ -13201,7 +13201,7 @@ }, "/api/douyin-xingtu/gw/api/author/get_author_show_items_v2/v1": { "get": { - "description": "Get author's showcased items or videos.", + "description": "Get Douyin Creator Marketplace (Xingtu) showcase Items data, including products and videos associated with the account, for creator evaluation, campaign planning, and marketplace research.", "operationId": "gwApiAuthorGetAuthorShowItemsV2V1", "parameters": [ { @@ -13720,9 +13720,9 @@ "tokenAuth": [] } ], - "summary": "Author Show Items (V1)", + "summary": "Showcase Items", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15002100", "x-sdk-class-name": "DouyinXingtuResource", @@ -13732,7 +13732,7 @@ }, "/api/douyin-xingtu/gw/api/data_sp/author_audience_distribution/v1": { "get": { - "description": "Get author's audience demographics.", + "description": "Get Douyin Creator Marketplace (Xingtu) audience Distribution data, including demographic and interest-based audience segmentation, for creator evaluation, campaign planning, and marketplace research.", "operationId": "gwApiDataSpAuthorAudienceDistributionV1", "parameters": [ { @@ -14217,9 +14217,9 @@ "tokenAuth": [] } ], - "summary": "Author Audience Distribution (V1)", + "summary": "Audience Distribution", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15001700", "x-sdk-class-name": "DouyinXingtuResource", @@ -14229,7 +14229,7 @@ }, "/api/douyin-xingtu/gw/api/data_sp/author_cp_info/v1": { "get": { - "description": "Get author's cost-performance analysis.", + "description": "Get Douyin Creator Marketplace (Xingtu) cost Performance Analysis data, including pricing, exposure, and engagement efficiency indicators, for creator evaluation, campaign planning, and marketplace research.", "operationId": "gwApiDataSpAuthorCpInfoV1", "parameters": [ { @@ -14300,9 +14300,9 @@ "tokenAuth": [] } ], - "summary": "Author CP Info (V1)", + "summary": "Cost Performance Analysis", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15002300", "x-sdk-class-name": "DouyinXingtuResource", @@ -14312,7 +14312,7 @@ }, "/api/douyin-xingtu/gw/api/data_sp/author_link_struct/v1": { "get": { - "description": "Get structure of author links.", + "description": "Get Douyin Creator Marketplace (Xingtu) creator Link Structure data, including engagement and conversion metrics, for creator performance analysis.", "operationId": "gwApiDataSpAuthorLinkStructV1", "parameters": [ { @@ -14395,9 +14395,9 @@ "tokenAuth": [] } ], - "summary": "Author Link Struct (V1)", + "summary": "Creator Link Structure", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15001100", "x-sdk-class-name": "DouyinXingtuResource", @@ -14407,7 +14407,7 @@ }, "/api/douyin-xingtu/gw/api/data_sp/author_rec_videos_v2/v1": { "get": { - "description": "Get author's high-performance recommended videos.", + "description": "Get Douyin Creator Marketplace (Xingtu) recommended Videos data, including content references used, for creator evaluation.", "operationId": "gwApiDataSpAuthorRecVideosV2V1", "parameters": [ { @@ -14751,9 +14751,9 @@ "tokenAuth": [] } ], - "summary": "Author Recommended Videos (V1)", + "summary": "Recommended Videos", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15002500", "x-sdk-class-name": "DouyinXingtuResource", @@ -14763,7 +14763,7 @@ }, "/api/douyin-xingtu/gw/api/data_sp/author_touch_distribution/v1": { "get": { - "description": "Get author's user touchpoints and distribution.", + "description": "Get Douyin Creator Marketplace (Xingtu) audience Touchpoint Distribution data, including segment breakdowns, audience composition, and distribution signals, for creator evaluation, campaign planning, and marketplace research.", "operationId": "gwApiDataSpAuthorTouchDistributionV1", "parameters": [ { @@ -14924,9 +14924,9 @@ "tokenAuth": [] } ], - "summary": "Author Touch Distribution (V1)", + "summary": "Audience Touchpoint Distribution", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15002400", "x-sdk-class-name": "DouyinXingtuResource", @@ -14936,7 +14936,7 @@ }, "/api/douyin-xingtu/gw/api/data_sp/author_video_distribution/v1": { "get": { - "description": "Get author's video performance distribution.", + "description": "Get Douyin Creator Marketplace (Xingtu) video Distribution data, including content performance breakdowns across published videos, for creator evaluation, campaign planning, and marketplace research.", "operationId": "gwApiDataSpAuthorVideoDistributionV1", "parameters": [ { @@ -15008,9 +15008,9 @@ "tokenAuth": [] } ], - "summary": "Author Video Distribution (V1)", + "summary": "Video Distribution", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15001600", "x-sdk-class-name": "DouyinXingtuResource", @@ -15020,7 +15020,7 @@ }, "/api/douyin-xingtu/gw/api/data_sp/check_author_display/v1": { "get": { - "description": "Check visibility status of an author.", + "description": "Get Douyin Creator Marketplace (Xingtu) creator Visibility Status data, including availability status, discovery eligibility, and campaign display signals, for creator evaluation, campaign planning, and marketplace research.", "operationId": "gwApiDataSpCheckAuthorDisplayV1", "parameters": [ { @@ -15079,9 +15079,9 @@ "tokenAuth": [] } ], - "summary": "Check Author Display (V1)", + "summary": "Creator Visibility Status", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15001200", "x-sdk-class-name": "DouyinXingtuResource", @@ -15091,7 +15091,7 @@ }, "/api/douyin-xingtu/gw/api/data_sp/get_author_convert_ability/v1": { "get": { - "description": "Get author's conversion capability analysis.", + "description": "Get Douyin Creator Marketplace (Xingtu) conversion Analysis data, including conversion efficiency and commercial performance indicators, for creator evaluation, campaign planning, and marketplace research.", "operationId": "gwApiDataSpGetAuthorConvertAbilityV1", "parameters": [ { @@ -15168,9 +15168,9 @@ "tokenAuth": [] } ], - "summary": "Author Convert Ability (V1)", + "summary": "Conversion Analysis", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15002000", "x-sdk-class-name": "DouyinXingtuResource", @@ -15180,7 +15180,7 @@ }, "/api/douyin-xingtu/gw/api/data_sp/get_author_convert_videos_or_products/v1": { "get": { - "description": "Get detailed conversion data for videos or products.", + "description": "Get Douyin Creator Marketplace (Xingtu) conversion Resources data, including products tied to a Douyin Xingtu creator's conversion activity, for commerce analysis and campaign optimization.", "operationId": "gwApiDataSpGetAuthorConvertVideosOrProductsV1", "parameters": [ { @@ -15334,9 +15334,9 @@ "tokenAuth": [] } ], - "summary": "Author Convert Videos or Products (V1)", + "summary": "Conversion Resources", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15002200", "x-sdk-class-name": "DouyinXingtuResource", @@ -15346,7 +15346,7 @@ }, "/api/douyin-xingtu/gw/api/data_sp/get_author_fans_distribution/v1": { "get": { - "description": "Get author's fans demographics and distribution.", + "description": "Get Douyin Creator Marketplace (Xingtu) follower Distribution data, including audience segmentation and location and demographic breakdowns, for creator evaluation, campaign planning, and marketplace research.", "operationId": "gwApiDataSpGetAuthorFansDistributionV1", "parameters": [ { @@ -15810,9 +15810,9 @@ "tokenAuth": [] } ], - "summary": "Author Fans Distribution (V1)", + "summary": "Follower Distribution", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15002600", "x-sdk-class-name": "DouyinXingtuResource", @@ -15822,7 +15822,7 @@ }, "/api/douyin-xingtu/gw/api/data_sp/get_author_link_info/v1": { "get": { - "description": "Get author's link index and stats.", + "description": "Get Douyin Creator Marketplace (Xingtu) creator Link Metrics data, including creator ranking, traffic structure, and related performance indicators, for creator evaluation, campaign planning, and marketplace research.", "operationId": "gwApiDataSpGetAuthorLinkInfoV1", "parameters": [ { @@ -15967,9 +15967,9 @@ "tokenAuth": [] } ], - "summary": "Author Link Info (V1)", + "summary": "Creator Link Metrics", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15001500", "x-sdk-class-name": "DouyinXingtuResource", @@ -15979,7 +15979,7 @@ }, "/api/douyin-xingtu/gw/api/data_sp/get_author_spread_info/v1": { "get": { - "description": "Get author's spread performance metrics.", + "description": "Get Douyin Creator Marketplace (Xingtu) distribution Metrics data, including exposure, spread, and related performance indicators, for creator evaluation, campaign planning, and marketplace research.", "operationId": "gwApiDataSpGetAuthorSpreadInfoV1", "parameters": [ { @@ -16142,9 +16142,9 @@ "tokenAuth": [] } ], - "summary": "Author Spread Info (V1)", + "summary": "Distribution Metrics", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15001900", "x-sdk-class-name": "DouyinXingtuResource", @@ -16154,7 +16154,7 @@ }, "/api/douyin-xingtu/gw/api/data_sp/item_report_detail/v1": { "get": { - "description": "Get detailed item report data.", + "description": "Get Douyin Creator Marketplace (Xingtu) item Report Details data, including key metrics and report fields used, for item performance analysis.", "operationId": "gwApiDataSpItemReportDetailV1", "parameters": [ { @@ -16247,9 +16247,9 @@ "tokenAuth": [] } ], - "summary": "Item Report Details (V1)", + "summary": "Item Report Details", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15002900", "x-sdk-class-name": "DouyinXingtuResource", @@ -16259,7 +16259,7 @@ }, "/api/douyin-xingtu/gw/api/data_sp/item_report_th_analysis/v1": { "get": { - "description": "Get analytical insights for an item report.", + "description": "Get Douyin Creator Marketplace (Xingtu) item Report Analysis data, including performance interpretation, for creator evaluation, campaign planning, and marketplace research.", "operationId": "gwApiDataSpItemReportThAnalysisV1", "parameters": [ { @@ -16466,9 +16466,9 @@ "tokenAuth": [] } ], - "summary": "Item Report Analysis (V1)", + "summary": "Item Report Analysis", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15003000", "x-sdk-class-name": "DouyinXingtuResource", @@ -16478,7 +16478,7 @@ }, "/api/douyin-xingtu/gw/api/data_sp/item_report_trend/v1": { "get": { - "description": "Get trend analysis for an item report.", + "description": "Get Douyin Creator Marketplace (Xingtu) item Report Trend data, including time-based changes in item performance metrics, for creator evaluation, campaign planning, and marketplace research.", "operationId": "gwApiDataSpItemReportTrendV1", "parameters": [ { @@ -17737,9 +17737,9 @@ "tokenAuth": [] } ], - "summary": "Item Report Trend (V1)", + "summary": "Item Report Trend", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15002800", "x-sdk-class-name": "DouyinXingtuResource", @@ -17749,7 +17749,7 @@ }, "/api/douyin-xingtu/gw/api/gsearch/search_for_author_square/v1": { "get": { - "description": "Search for authors using filters.", + "description": "Get Douyin Creator Marketplace (Xingtu) creator Search data, including filters, returning profile, and audience, for discovery, comparison, and shortlist building.", "operationId": "gwApiGsearchSearchForAuthorSquareV1", "parameters": [ { @@ -18014,9 +18014,9 @@ "tokenAuth": [] } ], - "summary": "Author Search (V1)", + "summary": "Creator Search", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15002700", "x-sdk-class-name": "DouyinXingtuResource", @@ -18027,7 +18027,7 @@ "/api/douyin-xingtu/search-douyin-kol/v1": { "get": { "deprecated": true, - "description": "Search for Douyin KOLs (Legacy JSON body).", + "description": "Get Douyin Creator Marketplace (Xingtu) legacy KOL Search data, including preserving the request format, for creator evaluation, campaign planning, and marketplace research.", "operationId": "searchDouyinKolV1", "parameters": [ { @@ -18069,9 +18069,9 @@ "tokenAuth": [] } ], - "summary": "Douyin KOL Search (V1) [Deprecated]", + "summary": "Legacy KOL Search", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15003600", "x-sdk-class-name": "DouyinXingtuResource", @@ -18082,7 +18082,7 @@ "/api/douyin-xingtu/search-for-author-square/v3": { "get": { "deprecated": true, - "description": "Search for creators by fans range (Legacy).", + "description": "Get Douyin Creator Marketplace (Xingtu) creator Search data, including filters, returning profile, and audience, for discovery, comparison, and shortlist building.", "operationId": "searchForAuthorSquareV3", "parameters": [ { @@ -18136,9 +18136,9 @@ "tokenAuth": [] } ], - "summary": "Creator List Search (V3) [Deprecated]", + "summary": "Creator Search", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15004600", "x-sdk-class-name": "DouyinXingtuResource", @@ -18148,7 +18148,7 @@ }, "/api/douyin-xingtu/search-kol-simple/v1": { "get": { - "description": "Simple keyword-based KOL search.", + "description": "Get Douyin Creator Marketplace (Xingtu) kOL Keyword Search data, including matching creators and discovery data, for creator sourcing and shortlist building.", "operationId": "searchKolSimpleV1", "parameters": [ { @@ -18374,9 +18374,9 @@ "tokenAuth": [] } ], - "summary": "KOL Keyword Search (V1)", + "summary": "KOL Keyword Search", "tags": [ - "Douyin Xingtu" + "Douyin Creator Marketplace (Xingtu)" ], "x-order": "15003700", "x-sdk-class-name": "DouyinXingtuResource", @@ -18386,7 +18386,7 @@ }, "/api/douyin/get-user-detail/v3": { "get": { - "description": "Retrieves detailed profile information of a Douyin user, including nickname, avatar,\nfollower count, verification status, bio, and other user statistics.\n\nTypical use cases:\n- Identifying creators and building creator lists\n- Enriching user records for analytics and reporting\n- Monitoring profile changes and audience growth\n", + "description": "Get Douyin (TikTok China) user Profile data, including follower counts, verification status, and bio details, for creator research and account analysis.", "operationId": "getUserDetailV3", "parameters": [ { @@ -18877,9 +18877,9 @@ "tokenAuth": [] } ], - "summary": "User Profile (V3)", + "summary": "User Profile", "tags": [ - "Douyin" + "Douyin (TikTok China)" ], "x-order": "14001000", "x-sdk-class-name": "DouyinResource", @@ -18890,7 +18890,7 @@ "/api/douyin/get-user-video-list/v1": { "get": { "deprecated": true, - "description": "Retrieves a list of videos published by a specific Douyin user, including video ID,\ncover image, title/caption, publish time, and engagement metrics.\n\nHighlights:\n- Capable of retrieving the latest published videos.\n\nTypical use cases:\n- Creator monitoring and content tracking\n- Building content timelines for specific accounts\n", + "description": "Get Douyin (TikTok China) user Published Videos data, including captions, covers, and publish times, for account monitoring.", "operationId": "getUserVideoListV1", "parameters": [ { @@ -19729,9 +19729,9 @@ "tokenAuth": [] } ], - "summary": "User Published Videos (V1)", + "summary": "User Published Videos", "tags": [ - "Douyin" + "Douyin (TikTok China)" ], "x-order": "14001100", "x-sdk-class-name": "DouyinResource", @@ -19741,7 +19741,7 @@ }, "/api/douyin/get-user-video-list/v3": { "get": { - "description": "Retrieves a list of videos published by a specific Douyin user. This version may offer\ndifferent data structure or coverage compared to V1.\n\nHighlights:\n- Not capable of retrieving the latest published videos.\n\nTypical use cases:\n- Creator monitoring and content tracking\n- Building content timelines for specific accounts\n", + "description": "Get Douyin (TikTok China) user Published Videos data, including captions, covers, and publish times, for account monitoring.", "operationId": "getUserVideoListV3", "parameters": [ { @@ -20613,9 +20613,9 @@ "tokenAuth": [] } ], - "summary": "User Published Videos (V3)", + "summary": "User Published Videos", "tags": [ - "Douyin" + "Douyin (TikTok China)" ], "x-order": "14001200", "x-sdk-class-name": "DouyinResource", @@ -20625,7 +20625,7 @@ }, "/api/douyin/get-video-comment/v1": { "get": { - "description": "Retrieves the comment list of a Douyin video by awemeId.\nReturns comment content, author info, like count, reply count, and publish time.\n\nTypical use cases:\n- Sentiment analysis and community feedback monitoring\n- Gathering user engagement data for specific videos\n", + "description": "Get Douyin (TikTok China) video Comments data, including authors, text, and likes, for sentiment analysis and engagement review.", "operationId": "getVideoCommentV1", "parameters": [ { @@ -20970,9 +20970,9 @@ "tokenAuth": [] } ], - "summary": "Video Comments (V1)", + "summary": "Video Comments", "tags": [ - "Douyin" + "Douyin (TikTok China)" ], "x-order": "14001600", "x-sdk-class-name": "DouyinResource", @@ -20982,7 +20982,7 @@ }, "/api/douyin/get-video-detail/v2": { "get": { - "description": "Provides detailed information about a specific Douyin video, including video URL,\ndescription, author info, publish time, and engagement metrics (likes, comments, shares).\n\nTypical use cases:\n- Content analysis and performance tracking\n- Retrieving high-quality video assets and metadata\n", + "description": "Get Douyin (TikTok China) video Details data, including author details, publish time, and engagement counts, for video research, archiving, and performance analysis.", "operationId": "getVideoDetailV2", "parameters": [ { @@ -22213,9 +22213,9 @@ "tokenAuth": [] } ], - "summary": "Video Details (V2)", + "summary": "Video Details", "tags": [ - "Douyin" + "Douyin (TikTok China)" ], "x-order": "14001300", "x-sdk-class-name": "DouyinResource", @@ -22225,7 +22225,7 @@ }, "/api/douyin/get-video-sub-comment/v1": { "get": { - "description": "Retrieves replies to a specific top-level comment under a Douyin video,\nincluding reply content, user information, timestamp, and like count.\n\nTypical use cases:\n- Deep-dive into specific discussion threads\n- Detailed community feedback analysis\n", + "description": "Get Douyin (TikTok China) comment Replies data, including text, authors, and timestamps, for thread analysis and feedback research.", "operationId": "getVideoSubCommentV1", "parameters": [ { @@ -22557,9 +22557,9 @@ "tokenAuth": [] } ], - "summary": "Comment Replies (V1)", + "summary": "Comment Replies", "tags": [ - "Douyin" + "Douyin (TikTok China)" ], "x-order": "14001700", "x-sdk-class-name": "DouyinResource", @@ -22569,7 +22569,7 @@ }, "/api/douyin/search-user/v2": { "get": { - "description": "Enables searching for Douyin users by keyword, returning profiles with nickname,\navatar, follower count, and other metadata.\n\nTypical use cases:\n- Identifying creators and influencers\n- Competitive analysis and creator discovery\n", + "description": "Get Douyin (TikTok China) user Search data, including profile metadata and follower signals, for creator discovery and account research.", "operationId": "searchUserV2", "parameters": [ { @@ -22761,9 +22761,9 @@ "tokenAuth": [] } ], - "summary": "User Search (V2)", + "summary": "User Search", "tags": [ - "Douyin" + "Douyin (TikTok China)" ], "x-order": "14001500", "x-sdk-class-name": "DouyinResource", @@ -22773,7 +22773,7 @@ }, "/api/douyin/search-video/v4": { "get": { - "description": "Allows searching for Douyin videos based on keywords, returning matched results with\nvideo metadata and engagement metrics. Supports filtering by sort type, publish time, and duration.\n\nTypical use cases:\n- Trend analysis and keyword monitoring\n- Discovery of relevant content for specific topics\n", + "description": "Get Douyin (TikTok China) video Search data, including metadata and engagement signals, for content discovery, trend research, and competitive monitoring.", "operationId": "searchVideoV4", "parameters": [ { @@ -24159,9 +24159,9 @@ "tokenAuth": [] } ], - "summary": "Video Search (V4)", + "summary": "Video Search", "tags": [ - "Douyin" + "Douyin (TikTok China)" ], "x-order": "14001400", "x-sdk-class-name": "DouyinResource", @@ -24171,7 +24171,7 @@ }, "/api/douyin/share-url-transfer/v1": { "get": { - "description": "Converts a Douyin short share URL (e.g., https://v.douyin.com/...) into structured video data.\n\nTypical use cases:\n- Resolving shared links from users or social media posts\n- Automating content ingestion from shared URLs\n", + "description": "Get Douyin (TikTok China) share Link Resolution data, including helping extract canonical IDs, for downstream video and comment workflows.", "operationId": "shareUrlTransferV1", "parameters": [ { @@ -24205,9 +24205,9 @@ "tokenAuth": [] } ], - "summary": "Share Link Resolution (V1)", + "summary": "Share Link Resolution", "tags": [ - "Douyin" + "Douyin (TikTok China)" ], "x-order": "14001800", "x-sdk-class-name": "DouyinResource", @@ -24215,9 +24215,98 @@ "x-sdk-resource": "douyin" } }, + "/api/facebook/get-profile-id/v1": { + "get": { + "description": "Retrieve the unique Facebook profile ID from a given profile URL.", + "operationId": "getProfileIdV1", + "parameters": [ + { + "description": "The path part of the Facebook profile URL. Do not include `https://www.facebook.com`. Example: `/people/To-Bite/pfbid021XLeDjjZjsoWse1H43VEgb3i1uCLTpBvXSvrnL2n118YPtMF5AZkBrZobhWWdHTHl/`", + "in": "query", + "name": "url", + "required": true, + "schema": { + "type": "string" + }, + "x-sdk-python-name": "url" + } + ], + "responses": { + "default": { + "content": { + "application/json": {} + }, + "description": "default response" + } + }, + "security": [ + { + "tokenAuth": [] + } + ], + "summary": "Get Profile ID", + "tags": [ + "Facebook" + ], + "x-order": "30001010", + "x-sdk-class-name": "FacebookResource", + "x-sdk-method-name": "get_profile_id_v1", + "x-sdk-resource": "facebook" + } + }, + "/api/facebook/get-profile-posts/v1": { + "get": { + "description": "Get public posts from a specific Facebook profile using its profile ID.", + "operationId": "getProfilePostsV1", + "parameters": [ + { + "description": "The unique Facebook profile ID.", + "in": "query", + "name": "profileId", + "required": true, + "schema": { + "type": "string" + }, + "x-sdk-python-name": "profile_id" + }, + { + "description": "Pagination cursor for fetching the next set of results.", + "in": "query", + "name": "cursor", + "required": false, + "schema": { + "default": "", + "type": "string" + }, + "x-sdk-python-name": "cursor" + } + ], + "responses": { + "default": { + "content": { + "application/json": {} + }, + "description": "default response" + } + }, + "security": [ + { + "tokenAuth": [] + } + ], + "summary": "Get Profile Posts", + "tags": [ + "Facebook" + ], + "x-order": "30001020", + "x-sdk-class-name": "FacebookResource", + "x-sdk-method-name": "get_profile_posts_v1", + "x-sdk-resource": "facebook" + } + }, "/api/facebook/search-post/v1": { "get": { - "description": "Search for public posts on Facebook based on keywords.\n\nThe results include post metadata, content, author information, publication time,\nengagement metrics (reactions, comments, shares), and media URLs.\n\nTypical use cases:\n- Discovering relevant public posts for specific keywords.\n- Analyzing engagement and reach of public content on Facebook.\n", + "description": "Get Facebook post Search data, including matched results, metadata, and ranking signals, for discovering relevant public posts for specific keywords and analyzing engagement and reach of public content on facebook.", "operationId": "searchV1", "parameters": [ { @@ -24500,7 +24589,7 @@ "tokenAuth": [] } ], - "summary": "Search Posts (V1)", + "summary": "Post Search", "tags": [ "Facebook" ], @@ -24512,7 +24601,7 @@ }, "/api/imdb/main-search-query/v1": { "get": { - "description": "Perform a general search on IMDb for titles, people, and more.\n\nTypical use cases:\n- Search for a movie by name or find a celebrity's profile.\n", + "description": "Get IMDb keyword Search data, including matched results, metadata, and ranking signals, for entity discovery and entertainment research.", "operationId": "mainSearchQuery", "parameters": [ { @@ -27418,7 +27507,7 @@ "tokenAuth": [] } ], - "summary": "Main Search (V1)", + "summary": "Keyword Search", "tags": [ "IMDb" ], @@ -27430,7 +27519,7 @@ }, "/api/imdb/news-by-category-query/v1": { "get": { - "description": "Retrieve entertainment news articles filtered by category.\n\nTypical use cases:\n- Stay updated on movie, TV, or celebrity news.\n", + "description": "Get IMDb news by Category data, including headlines, summaries, and source metadata, for media monitoring and news research.", "operationId": "newsByCategoryQuery", "parameters": [ { @@ -27534,7 +27623,7 @@ "tokenAuth": [] } ], - "summary": "News by Category (V1)", + "summary": "News by Category", "tags": [ "IMDb" ], @@ -27546,7 +27635,7 @@ }, "/api/imdb/streaming-picks-query/v1": { "get": { - "description": "Retrieve streaming recommendations curated by IMDb.\n\nTypical use cases:\n- Browse popular and recommended content available on streaming services.\n", + "description": "Get IMDb streaming Picks data, including curated titles available across streaming surfaces, for content discovery and watchlist research.", "operationId": "streamingPicksQuery", "parameters": [ { @@ -27776,7 +27865,7 @@ "tokenAuth": [] } ], - "summary": "Streaming Picks (V1)", + "summary": "Streaming Picks", "tags": [ "IMDb" ], @@ -27788,7 +27877,7 @@ }, "/api/imdb/title-awards-summary-query/v1": { "get": { - "description": "Retrieve a summary of awards and nominations for a specific title.\n\nTypical use cases:\n- List Oscar wins, Golden Globe nominations, and other accolades.\n", + "description": "Get IMDb title Awards Summary data, including nominations, for title benchmarking and awards research.", "operationId": "titleAwardsSummaryQuery", "parameters": [ { @@ -27862,7 +27951,7 @@ "tokenAuth": [] } ], - "summary": "Title Awards Summary (V1)", + "summary": "Awards Summary", "tags": [ "IMDb" ], @@ -27874,7 +27963,7 @@ }, "/api/imdb/title-base-query/v1": { "get": { - "description": "Retrieve basic metadata for a specific title.\n\nTypical use cases:\n- Get essential information like title, year, and genre.\n", + "description": "Get IMDb title Base Info data, including title text, release year, and type, for catalog enrichment and title lookup workflows.", "operationId": "titleBaseQuery", "parameters": [ { @@ -27989,7 +28078,7 @@ "tokenAuth": [] } ], - "summary": "Title Base Info (V1)", + "summary": "Base Info", "tags": [ "IMDb" ], @@ -28001,7 +28090,7 @@ }, "/api/imdb/title-box-office-summary/v1": { "get": { - "description": "Retrieve box office summary for a specific title.\n\nTypical use cases:\n- Analyze financial performance including budget, opening weekend, and worldwide gross.\n", + "description": "Get IMDb title Box Office Summary data, including grosses and related performance indicators, for revenue tracking and title comparison.", "operationId": "titleBoxOfficeSummary", "parameters": [ { @@ -28114,7 +28203,7 @@ "tokenAuth": [] } ], - "summary": "Title Box Office Summary (V1)", + "summary": "Box Office Summary", "tags": [ "IMDb" ], @@ -28126,7 +28215,7 @@ }, "/api/imdb/title-chart-rankings/v1": { "get": { - "description": "Retrieve title rankings from IMDb charts (e.g., Top 250).\n\nTypical use cases:\n- View the highest-rated movies and TV shows of all time.\n", + "description": "Get IMDb title Chart Rankings data, including positions in lists such as Top 250 and related charts, for ranking monitoring and title benchmarking.", "operationId": "titleChartRankings", "parameters": [ { @@ -28266,7 +28355,7 @@ "tokenAuth": [] } ], - "summary": "Title Chart Rankings (V1)", + "summary": "Chart Rankings", "tags": [ "IMDb" ], @@ -28278,7 +28367,7 @@ }, "/api/imdb/title-contribution-questions/v1": { "get": { - "description": "Retrieve contribution questions for a specific title.\n\nTypical use cases:\n- Facilitate user contributions by providing relevant metadata questions for a movie or TV show.\n", + "description": "Get IMDb title Contribution Questions data, including specific IMDb title, for data maintenance workflows and title metadata review.", "operationId": "titleContributionQuestions", "parameters": [ { @@ -28394,7 +28483,7 @@ "tokenAuth": [] } ], - "summary": "Title Contribution Questions (V1)", + "summary": "Contribution Questions", "tags": [ "IMDb" ], @@ -28406,7 +28495,7 @@ }, "/api/imdb/title-countries-of-origin/v1": { "get": { - "description": "Retrieve the countries of origin for a specific title.\n\nTypical use cases:\n- Identify the production locations and international roots of a movie or TV show.\n", + "description": "Get IMDb title Countries of Origin data, including country names and regional metadata, for catalog enrichment and regional content analysis.", "operationId": "titleCountriesOfOrigin", "parameters": [ { @@ -28479,7 +28568,7 @@ "tokenAuth": [] } ], - "summary": "Title Countries of Origin (V1)", + "summary": "Countries of Origin", "tags": [ "IMDb" ], @@ -28491,7 +28580,7 @@ }, "/api/imdb/title-critics-review-summary-query/v1": { "get": { - "description": "Retrieve a summary of critical reviews for a specific title.\n\nTypical use cases:\n- Display Metacritic scores and a compilation of professional critic feedback.\n", + "description": "Get IMDb title Critics Review Summary data, including review highlights, for review analysis and title comparison.", "operationId": "titleCriticsReviewSummaryQuery", "parameters": [ { @@ -28730,7 +28819,7 @@ "tokenAuth": [] } ], - "summary": "Title Critics Review Summary (V1)", + "summary": "Critics Review Summary", "tags": [ "IMDb" ], @@ -28742,7 +28831,7 @@ }, "/api/imdb/title-details-query/v1": { "get": { - "description": "Retrieve comprehensive details for a specific title.\n\nTypical use cases:\n- Get all standard information for a movie or TV show including summary, ratings, and more.\n", + "description": "Get IMDb title Details data, including metadata, release info, and cast, for deep title research and catalog enrichment.", "operationId": "titleDetailsQuery", "parameters": [ { @@ -29005,7 +29094,7 @@ "tokenAuth": [] } ], - "summary": "Title Details (V1)", + "summary": "Details", "tags": [ "IMDb" ], @@ -29017,7 +29106,7 @@ }, "/api/imdb/title-did-you-know-query/v1": { "get": { - "description": "Retrieve interesting 'Did You Know' facts and trivia for a title.\n\nTypical use cases:\n- Enhance user engagement with fun facts and behind-the-scenes trivia.\n", + "description": "Get IMDb title 'Did You Know' Insights data, including trivia, for editorial research and title insight enrichment.", "operationId": "titleDidYouKnowQuery", "parameters": [ { @@ -29205,7 +29294,7 @@ "tokenAuth": [] } ], - "summary": "Title 'Did You Know' Insights (V1)", + "summary": "'Did You Know' Insights", "tags": [ "IMDb" ], @@ -29217,7 +29306,7 @@ }, "/api/imdb/title-extended-details-query/v1": { "get": { - "description": "Retrieve comprehensive extended details for a specific title.\n\nTypical use cases:\n- Get in-depth metadata including production details, alternate titles, and more.\n", + "description": "Get IMDb title Extended Details data, including title info, images, and genres, for title enrichment and catalog research.", "operationId": "titleExtendedDetailsQuery", "parameters": [ { @@ -29408,7 +29497,7 @@ "tokenAuth": [] } ], - "summary": "Title Extended Details (V1)", + "summary": "Extended Details", "tags": [ "IMDb" ], @@ -29420,7 +29509,7 @@ }, "/api/imdb/title-more-like-this-query/v1": { "get": { - "description": "Retrieve title recommendations (More Like This) for a specific title.\n\nTypical use cases:\n- Provide users with similar content recommendations based on their interest in a specific title.\n", + "description": "Get IMDb title Recommendations data, including related titles and suggestion metadata, for content discovery and recommendation analysis.", "operationId": "titleMoreLikeThisQuery", "parameters": [ { @@ -29573,7 +29662,7 @@ "tokenAuth": [] } ], - "summary": "Title Recommendations (V1)", + "summary": "Recommendations", "tags": [ "IMDb" ], @@ -29585,7 +29674,7 @@ }, "/api/imdb/title-plot-query/v1": { "get": { - "description": "Retrieve the plot summary for a specific title.\n\nTypical use cases:\n- Display a detailed description of the storyline for a movie or TV show.\n", + "description": "Get IMDb title Plot Summary data, including core metrics, trend signals, and performance indicators, for displaying a detailed description of the storyline for a movie or TV show.", "operationId": "titlePlotQuery", "parameters": [ { @@ -29671,7 +29760,7 @@ "tokenAuth": [] } ], - "summary": "Title Plot Summary (V1)", + "summary": "Plot Summary", "tags": [ "IMDb" ], @@ -29683,7 +29772,7 @@ }, "/api/imdb/title-redux-overview-query/v1": { "get": { - "description": "Retrieve a redux overview of a specific title.\n\nTypical use cases:\n- Get a concise summary and overview of a movie or TV show's key attributes.\n", + "description": "Get IMDb title Redux Overview data, including key summary fields and linked metadata, for get a concise summary and overview of a movie or TV show's key attributes.", "operationId": "titleReduxOverviewQuery", "parameters": [ { @@ -31489,7 +31578,7 @@ "tokenAuth": [] } ], - "summary": "Title Redux Overview (V1)", + "summary": "Redux Overview", "tags": [ "IMDb" ], @@ -31501,7 +31590,7 @@ }, "/api/imdb/title-release-expectation-query/v1": { "get": { - "description": "Retrieve release expectation data for a specific title.\n\nTypical use cases:\n- Analyze audience anticipation for upcoming movie or TV show releases.\n", + "description": "Get IMDb title Release Expectation data, including production status, release dates, and anticipation signals, for release monitoring and title research.", "operationId": "titleReleaseExpectationQuery", "parameters": [ { @@ -32668,7 +32757,7 @@ "tokenAuth": [] } ], - "summary": "Title Release Expectation (V1)", + "summary": "Release Expectation", "tags": [ "IMDb" ], @@ -32680,7 +32769,7 @@ }, "/api/imdb/title-top-cast-and-crew/v1": { "get": { - "description": "Retrieve information about the top cast and crew members of a title.\n\nTypical use cases:\n- List directors, writers, and main actors for a movie or TV show.\n", + "description": "Get IMDb title Top Cast and Crew data, including names, roles, and profile references, for talent research and title enrichment.", "operationId": "titleTopCastAndCrew", "parameters": [ { @@ -33258,7 +33347,7 @@ "tokenAuth": [] } ], - "summary": "Title Top Cast and Crew (V1)", + "summary": "Top Cast and Crew", "tags": [ "IMDb" ], @@ -33270,7 +33359,7 @@ }, "/api/imdb/title-user-reviews-summary-query/v1": { "get": { - "description": "Retrieve a summary of user-submitted reviews for a specific title.\n\nTypical use cases:\n- Get average user ratings and a snapshot of audience sentiment.\n", + "description": "Get IMDb title User Reviews Summary data, including aggregated review content and counts, for audience sentiment analysis.", "operationId": "titleUserReviewsSummaryQuery", "parameters": [ { @@ -33495,7 +33584,7 @@ "tokenAuth": [] } ], - "summary": "Title User Reviews Summary (V1)", + "summary": "User Reviews Summary", "tags": [ "IMDb" ], @@ -33507,7 +33596,7 @@ }, "/api/instagram/get-post-detail/v1": { "get": { - "description": "Retrieves detailed information of a public Instagram post by post code, including post caption, media content (images/videos), publish time, and engagement metrics such as likes and comments.\n\nTypical use cases:\n- Analyzing engagement metrics (likes/comments) for a specific post\n- Archiving post content and media assets for content analysis\n- Verifying post details via the unique shortcode\n", + "description": "Get Instagram post Details data, including post caption, media content (images/videos), and publish time, for analyzing engagement metrics (likes/comments) for a specific post and archiving post content and media assets for content analysis.", "operationId": "getPostDetailV1", "parameters": [ { @@ -34012,7 +34101,7 @@ "tokenAuth": [] } ], - "summary": "Post Details (V1)", + "summary": "Post Details", "tags": [ "Instagram" ], @@ -34024,7 +34113,7 @@ }, "/api/instagram/get-user-detail/v1": { "get": { - "description": "Retrieves public profile information of an Instagram user, including follower count, following count, post count, and basic profile details.\n\nTypical use cases:\n- Obtaining basic account metadata for influencer vetting\n- Tracking follower growth and audience reach over time\n- Mapping user handles to specific profile stats\n", + "description": "Get Instagram user Profile data, including follower count, following count, and post count, for obtaining basic account metadata for influencer vetting, tracking follower growth and audience reach over time, and mapping user handles to specific profile stats.", "operationId": "getUserDetailV1", "parameters": [ { @@ -34411,7 +34500,7 @@ "tokenAuth": [] } ], - "summary": "User Details (V1)", + "summary": "User Profile", "tags": [ "Instagram" ], @@ -34423,7 +34512,7 @@ }, "/api/instagram/get-user-posts/v1": { "get": { - "description": "Retrieves a list of public posts published by an Instagram user, including post code, caption, media type, publish time, and basic engagement metrics.\n\nTypical use cases:\n- Monitoring recent publishing activity of a specific user\n- Building a historical record of content for auditing or analysis\n- Collecting post identifiers for deeper engagement analysis\n", + "description": "Get Instagram user Published Posts data, including post code, caption, and media type, for monitoring recent publishing activity of a specific user and building a historical record of content for auditing or analysis.", "operationId": "getUserPostsV1", "parameters": [ { @@ -34750,7 +34839,7 @@ "tokenAuth": [] } ], - "summary": "User Published Posts (V1)", + "summary": "User Published Posts", "tags": [ "Instagram" ], @@ -34762,7 +34851,7 @@ }, "/api/instagram/search-hashtag-posts/v1": { "get": { - "description": "Searches public Instagram posts by keyword or hashtag. It returns a list of matched posts with metadata including caption, author profile, publish time, and media links.\n\nTypical use cases:\n- Competitive analysis of trending topics and hashtags\n- Monitoring community discussions and public opinion on specific tags\n- Aggregating user-generated content for specific campaigns\n", + "description": "Get Instagram hashtag Posts Search data, including caption, author profile, and publish time, for competitive analysis of trending topics and hashtags and monitoring community discussions and public opinion on specific tags.", "operationId": "searchHashtagPostsV1", "parameters": [ { @@ -34927,7 +35016,7 @@ "tokenAuth": [] } ], - "summary": "Hashtag Posts Search (V1)", + "summary": "Hashtag Posts Search", "tags": [ "Instagram" ], @@ -34939,7 +35028,7 @@ }, "/api/instagram/search-reels/v1": { "get": { - "description": "Allows you to search public Instagram Reels by keyword or hashtag. It returns detailed information for each matched post, including post ID, caption, author profile, publish time, and engagement metrics.\n\nTypical use cases:\n- Tracking trends and viral content via specific keywords or hashtags\n- Discovering high-engagement Reels within a particular niche\n- Monitoring brand mentions and campaign hashtags\n", + "description": "Get Instagram reels Search data, including post ID, caption, and author profile, for tracking trends and viral content via specific keywords or hashtags and discovering high-engagement reels within a particular niche.", "operationId": "searchReelsV1", "parameters": [ { @@ -35408,7 +35497,7 @@ "tokenAuth": [] } ], - "summary": "Reels Search (V1)", + "summary": "Reels Search", "tags": [ "Instagram" ], @@ -35420,7 +35509,7 @@ }, "/api/jd/get-item-comments/v1": { "get": { - "description": "Retrieves customer reviews (comments) for a specific JD.com (China) product by item ID.\nIt returns review content, rating/score, review time, user/display info (if available), and paging data.\n\nTypical use cases:\n- Review & sentiment monitoring: track comment volume and rating shifts.\n- Public opinion analysis: analyze negative/positive feedback signals.\n\nHighlights\n- Page limit: The maximum page number supported is 8.\n", + "description": "Get JD.com product Comments data, including ratings, timestamps, and reviewer signals, for customer feedback analysis and product research.", "operationId": "getItemCommentsV1", "parameters": [ { @@ -35708,9 +35797,9 @@ "tokenAuth": [] } ], - "summary": "Product Comments (V1)", + "summary": "Product Comments", "tags": [ - "JD" + "JD.com" ], "x-order": "19001100", "x-sdk-class-name": "JdResource", @@ -35720,7 +35809,7 @@ }, "/api/jd/get-item-detail/v1": { "get": { - "description": "Retrieves product detail data for JD.com items, including basic metadata (title, item ID),\nmedia assets (images), shop information, item status, and pricing.\n\nTypical use cases:\n- Building product catalogs and enriching item content\n- E-commerce analytics and competitor tracking\n- General product lookup and verification\n\nHighlights\n- Price accuracy: The after-coupon (coupon-discounted) price is not accurate(Non-login version).\n", + "description": "Get JD.com product Details data, including pricing, images, and shop information, for catalog analysis, product monitoring, and ecommerce research.", "operationId": "getItemDetailV1", "parameters": [ { @@ -36833,9 +36922,9 @@ "tokenAuth": [] } ], - "summary": "Product Details (V1)", + "summary": "Product Details", "tags": [ - "JD" + "JD.com" ], "x-order": "19001000", "x-sdk-class-name": "JdResource", @@ -36845,7 +36934,7 @@ }, "/api/jd/get-shop-item-list/v1": { "get": { - "description": " Retrieves the product list for a specific JD.com (China) shop.\n It returns items available in the shop, typically including basic product information such as item ID, title, price, sales-related data, image, and paging data.\n\n Typical use cases:\n - Shop catalog monitoring: track product assortments and newly listed items for a target shop.\n - Competitive analysis: analyze a shop’s product lineup, pricing, and listing changes over time.\n", + "description": "Get JD.com shop Product List data, including item titles, prices, and images, for catalog tracking and seller research.", "operationId": "getShopItemListV1", "parameters": [ { @@ -36882,9 +36971,9 @@ "tokenAuth": [] } ], - "summary": "Shop Product List (V1)", + "summary": "Shop Product List", "tags": [ - "JD" + "JD.com" ], "x-order": "19001200", "x-sdk-class-name": "JdResource", @@ -36894,7 +36983,7 @@ }, "/api/kuaishou/get-user-detail/v1": { "get": { - "description": "Retrieves detailed profile information of a Kuaishou user, including nickname,\navatar, follower count, verification status, and bio.\n\nTypical use cases:\n- Creator research and building creator profiles\n- Monitoring audience growth and account status\n", + "description": "Get Kuaishou user Profile data, including account metadata, audience metrics, and verification-related fields, for creator research and building creator profiles and monitoring audience growth and account status.", "operationId": "getUserProfileV1", "parameters": [ { @@ -37045,7 +37134,7 @@ "tokenAuth": [] } ], - "summary": "User Profile (V1)", + "summary": "User Profile", "tags": [ "Kuaishou" ], @@ -37057,7 +37146,7 @@ }, "/api/kuaishou/get-user-video-list/v2": { "get": { - "description": "Retrieves a list of videos posted by a specific Kuaishou user, including video ID,\ncover image, publish time, and engagement metrics.\n\nTypical use cases:\n- Content analysis for specific creators\n- Monitoring video performance and engagement trends\n", + "description": "Get Kuaishou user Published Videos data, including covers, publish times, and engagement metrics, for creator monitoring and content performance analysis.", "operationId": "getUserVideoListV2", "parameters": [ { @@ -37329,7 +37418,7 @@ "tokenAuth": [] } ], - "summary": "User Published Videos (V2)", + "summary": "User Published Videos", "tags": [ "Kuaishou" ], @@ -37345,14 +37434,14 @@ "operationId": "getVideoCommentsV1", "parameters": [ { - "description": "The unique numeric photo ID of the video.", + "description": "The unique ID of the Kuaishou video, e.g. `3xbknvct79h46h9`", "in": "query", - "name": "photoId", + "name": "videoId", "required": true, "schema": { "type": "string" }, - "x-sdk-python-name": "photo_id" + "x-sdk-python-name": "video_id" }, { "description": "Pagination cursor for subsequent pages.", @@ -39213,7 +39302,7 @@ "tokenAuth": [] } ], - "summary": "Video Comments (V1)", + "summary": "Video Comments", "tags": [ "Kuaishou" ], @@ -39225,11 +39314,11 @@ }, "/api/kuaishou/get-video-detail/v2": { "get": { - "description": "Provides detailed information about a specific Kuaishou video, including video URL,\ncaption, author info, publish time, and engagement metrics (likes, comments, shares).\n\nTypical use cases:\n- In-depth content performance analysis\n- Building databases of viral videos\n", + "description": "Get Kuaishou video Details data, including video URL, caption, and author info, for in-depth content performance analysis and building databases of viral videos.", "operationId": "getVideoDetailsV2", "parameters": [ { - "description": "The unique ID of the Kuaishou video.", + "description": "The unique ID of the Kuaishou video, e.g. `3xg9avuebhtfcku`", "in": "query", "name": "videoId", "required": true, @@ -39631,7 +39720,7 @@ "tokenAuth": [] } ], - "summary": "Video Details (V2)", + "summary": "Video Details", "tags": [ "Kuaishou" ], @@ -39643,7 +39732,7 @@ }, "/api/kuaishou/search-user/v2": { "get": { - "description": "Enhanced user search for Kuaishou, returning detailed user profiles with nickname,\navatar, follower count, and bio.\n\nTypical use cases:\n- Creator discovery and influencer analytics\n- Market research on specific content domains\n", + "description": "Get Kuaishou user Search data, including profile names, avatars, and follower counts, for creator discovery and account research.", "operationId": "searchUserV2", "parameters": [ { @@ -40780,7 +40869,7 @@ "tokenAuth": [] } ], - "summary": "User Search (V2)", + "summary": "User Search", "tags": [ "Kuaishou" ], @@ -40792,7 +40881,7 @@ }, "/api/kuaishou/search-video/v2": { "get": { - "description": "Enables searching for Kuaishou videos by keyword, returning matched results with video ID,\ncover image, description, author info, publish time, and engagement metrics.\n\nTypical use cases:\n- Competitive analysis and market trends\n- Keywords monitoring and brand tracking\n", + "description": "Get Kuaishou video Search data, including video ID, cover image, and description, for competitive analysis and market trends and keywords monitoring and brand tracking.", "operationId": "searchVideoV2", "parameters": [ { @@ -41086,7 +41175,7 @@ "tokenAuth": [] } ], - "summary": "Video Search (V2)", + "summary": "Video Search", "tags": [ "Kuaishou" ], @@ -41098,7 +41187,7 @@ }, "/api/kuaishou/share-url-transfer/v1": { "get": { - "description": "Converts Kuaishou short share URLs to structured data.\n\nTypical use cases:\n- Resolving shared links for automated content processing\n", + "description": "Get Kuaishou share Link Resolution data, including resolved content identifier and target object data, for resolving shared links for automated content processing.", "operationId": "shareLinkResolutionV1", "parameters": [ { @@ -41132,7 +41221,7 @@ "tokenAuth": [] } ], - "summary": "Share Link Resolution (V1)", + "summary": "Share Link Resolution", "tags": [ "Kuaishou" ], @@ -41144,7 +41233,7 @@ }, "/api/reddit/get-post-comments/v1": { "get": { - "description": "Fetches the discussion thread (comments) for a specific Reddit post by its ID.\nThe results are returned as a paginated list of comment objects, including the text,\nauthor, and other metadata for each response.\n\nTypical use cases\n- Mining customer feedback and reviews\n- Understanding community sentiment through detailed discussions\n- Tracking the evolution of topics within a thread\n\nHighlights\n- Pagination is supported via the 'cursor' parameter.\n", + "description": "Get Reddit post Comments data, including text, authors, and timestamps, for discussion analysis and moderation research.", "operationId": "getPostCommentsV1", "parameters": [ { @@ -41859,7 +41948,7 @@ "tokenAuth": [] } ], - "summary": "Post Comments (V1)", + "summary": "Post Comments", "tags": [ "Reddit" ], @@ -41871,7 +41960,7 @@ }, "/api/reddit/get-post-detail/v1": { "get": { - "description": "Retrieves comprehensive information of a specific Reddit post by its unique ID.\nIncludes the post content (text or link), author details, subreddit information,\nand engagement statistics like upvotes, downvotes, and comment counts.\n\nTypical use cases\n- Sentiment analysis for brands, products, or topics\n- Tracking public engagement with specific pieces of content\n- Content archiving and metadata analysis\n", + "description": "Get Reddit post Details data, including author details, subreddit info, and engagement counts, for content analysis, moderation research, and monitoring.", "operationId": "getPostDetailV1", "parameters": [ { @@ -42098,7 +42187,7 @@ "tokenAuth": [] } ], - "summary": "Post Details (V1)", + "summary": "Post Details", "tags": [ "Reddit" ], @@ -42110,7 +42199,7 @@ }, "/api/reddit/search/v1": { "get": { - "description": "Performs a search for posts on Reddit based on specified keywords.\nRetrieves matching posts along with their metadata and basic engagement metrics.\n\nTypical use cases\n- Discovering new discussions or trends on specific topics\n- Competitive intelligence and brand monitoring\n- Researching community activity across the platform\n\nHighlights\n- Results can be paginated using the 'after' parameter.\n", + "description": "Get Reddit keyword Search data, including titles, authors, and subreddit context, for topic discovery and monitoring.", "operationId": "searchV1", "parameters": [ { @@ -42761,7 +42850,7 @@ "tokenAuth": [] } ], - "summary": "Search (V1)", + "summary": "Keyword Search", "tags": [ "Reddit" ], @@ -42773,7 +42862,7 @@ }, "/api/search/v1": { "get": { - "description": "Retrieves social media data across all supported platforms (Weibo, Weixin, Douyin, Xiaohongshu, etc.)\nbased on the provided keyword and time range. This non-real-time search provides a\ncomprehensive view of cross-platform social sentiment and trends.\n\nTypical use cases:\n- Analyzing brand mentions across different social ecosystems\n- Comparative sentiment monitoring between platforms\n- Historical keyword tracking within an 84-day window\n\nHighlights\n- Time range limit: Data is restricted to the last 84 days from the current date.\n- Non-real-time: Results are not indexed in real-time and may have a delay.\n", + "description": "Get cross-platform social media search data, including Xiaohongshu, Douyin, Kuaishou, WeChat, Bilibili, Weibo and Zhihu results, for trend research and monitoring.", "operationId": "searchV1", "parameters": [ { @@ -43108,9 +43197,9 @@ "tokenAuth": [] } ], - "summary": "Unified Search (V1)", + "summary": "Cross-Platform Search", "tags": [ - "Search" + "Social Media" ], "x-order": "10001000", "x-sdk-class-name": "SearchResource", @@ -43120,7 +43209,7 @@ }, "/api/taobao/get-item-comment/v3": { "get": { - "description": "Retrieves user reviews for a Taobao/Tmall item, including review text, publish time,\nauthor info (when available), rating/likes (if present), and other review metadata. Supports pagination.\n\nTypical use cases:\n- Review and sentiment monitoring\n- Tracking rating/review volume changes over time\n- Collecting feedback for product/competitor analysis\n- Building datasets for NLP or customer-insight workflows\n", + "description": "Get Taobao and Tmall product Reviews data, including ratings, timestamps, and reviewer signals, for feedback analysis and product research.", "operationId": "getItemCommentV3", "parameters": [ { @@ -44463,9 +44552,9 @@ "tokenAuth": [] } ], - "summary": "Product Reviews (V3)", + "summary": "Product Reviews", "tags": [ - "Taobao & Tmall" + "Taobao and Tmall" ], "x-order": "11001500", "x-sdk-class-name": "TaobaoResource", @@ -44475,7 +44564,7 @@ }, "/api/taobao/get-item-detail/v1": { "get": { - "description": "Retrieves product detail data for Taobao/Tmall items, including basic metadata (title, item ID, category),\nmedia assets (images), shop information, item status, and pricing.\n\nTypical use cases:\n- Building product catalogs and enriching item content (e.g., images)\n- E-commerce analytics and competitor tracking\n- General product lookup and verification\n\nHighlights\n- Some items are not supported; in that case the response business code is 202 and retrying will not help.\n- After-coupon (coupon-discounted) price is not guaranteed: some items may miss it or return an imprecise value.\n", + "description": "Get Taobao and Tmall product Details data, including pricing, images, and shop details, for product research, catalog monitoring, and ecommerce analysis.", "operationId": "getItemDetailV1", "parameters": [ { @@ -45686,9 +45775,9 @@ "tokenAuth": [] } ], - "summary": "Product Details (V1)", + "summary": "Product Details", "tags": [ - "Taobao & Tmall" + "Taobao and Tmall" ], "x-order": "11001000", "x-sdk-class-name": "TaobaoResource", @@ -45696,315 +45785,9 @@ "x-sdk-resource": "taobao" } }, - "/api/taobao/get-item-detail/v3": { - "get": { - "description": "Retrieves product detail data for Taobao/Tmall items, including basic metadata (title, item ID, category),\nmedia assets (images), shop information, item status, and pricing.\n\nTypical use cases:\n- Price monitoring and promotion tracking\n- Building product catalogs and enriching item content (e.g., images)\n- E-commerce analytics and competitor tracking\n\nHighlights\n- App-based data source.\n- Accurate after-coupon (coupon-discounted) price.\n- Works across all items supported by this endpoint.\n", - "operationId": "getItemDetailV3", - "parameters": [ - { - "description": "AUnique product identifier on Taobao/Tmall (item ID).", - "in": "query", - "name": "itemId", - "required": true, - "schema": { - "type": "string" - }, - "x-sdk-python-name": "item_id" - } - ], - "responses": { - "default": { - "content": { - "application/json": { - "example": { - "code": 0, - "data": { - "apiStack": [ - { - "name": "esi", - "value": "{\"item\":{\"sellCount\":\"3000+\",\"skuText\":\"配送至:罗湖区,请选择商品规格\",\"images\":[\"https://img.alicdn.com/imgextra/..." - } - ], - "debug": { - "app": "detailcache", - "cachedTimestamp": "2026-02-26T03:01:54", - "dataFrom": "tair", - "host": "detailcache011081147178.center.na620@11.81.147.178" - }, - "feature": { - "isOnLine": "true", - "tcloudToH5": "true" - }, - "item": { - "brandValueId": "3300940", - "businessId": "default", - "cartUrl": "https://h5.m.taobao.com/awp/base/cart.htm", - "categoryId": "50011993", - "commentCount": "0", - "countMultiple": [], - "exParams": {}, - "favcount": "119", - "h5DescV6": "false", - "h5ItemUrl": "https://new.m.taobao.com/detail.htm?id=1019694598833&hybrid=true", - "h5moduleDescUrl": "//mdetail.tmall.com/templates/pages/itemDesc?id=1019694598833", - "images": [ - "//img.alicdn.com/imgextra/i1/379424083/O1CN01OJockE1g24GDEQgbN_!!4611686018427383123-2-item_pic.png" - ], - "itemId": "1019694598833", - "moduleDescParams": { - "f": "desc/icoss156110212570d8d7f9e784afa0", - "id": "1019694598833" - }, - "moduleDescUrl": "//hws.m.taobao.com/d/modulet/v5/WItemMouldDesc.do?id=1019694598833&f=icoss156110212570d8d7f9e784afa0", - "newTaobaoH5DescUrl": "https://market.m.taobao.com/app/detail-project/desc/index.html?id=1019694598833&descVersion=7.0&type...", - "openDecoration": "false", - "pcADescUrl": "//market.m.taobao.com/app/detail-project/desc/index.html?id=1019694598833&descVersion=7.0&type=1&f=i...", - "rootCategoryId": "1801", - "skuText": "请选择商品规格 ", - "subtitle": "", - "taobaoDescUrl": "https://market.m.taobao.com/app/detail-project/desc/index.html?id=1019694598833&descVersion=7.0&type...", - "taobaoPcDescUrl": "https://market.m.taobao.com/app/detail-project/desc/index.html?id=1019694598833&descVersion=6.0&type...", - "title": "【李佳琦直播间爆品日付定金】珀莱雅红宝石水乳2.0套装紧致抗皱", - "tmallDescUrl": "//mdetail.tmall.com/templates/pages/desc?id=1019694598833" - }, - "mockData": "{\"delivery\":{},\"trade\":{\"buyEnable\":true,\"cartEnable\":true},\"feature\":{\"hasSku\":true,\"showSku\":true}...", - "params": { - "trackParams": { - "BC_type": "B", - "brandId": "3300940", - "categoryId": "50011993" - } - }, - "props": { - "groupProps": [ - { - "基本信息": [ - { - "品牌": "PROYA/珀莱雅" - } - ] - } - ] - }, - "props2": {}, - "propsCut": "品牌 面部护理套装 化妆品备案编号/注册证号 功效 注册信息 产地 适用人群 保质期 包装种类 是否为特殊用途化妆品 生产厂家信息 产品类别 单品数量 ", - "rate": { - "goodRateInfo": { - "goodRateRatio3m": "0.0", - "goodRateRatioAll": "0.0", - "rateCnt3m": "0", - "rateCntAll": "0" - }, - "invite": { - "inviteText": "", - "showInvite": "false" - } - }, - "resource": { - "entrances": { - "askAll": { - "icon": "https://img.alicdn.com/tps/TB1tVU6PpXXXXXFaXXXXXXXXXXX-102-60.png", - "link": "https://meta.m.taobao.com/app/mtb/taobao-ugc/ask/list?disableNav=YES&refId=1019694598833", - "text": "对宝贝有疑问？可以向已买的人求助" - } - } - }, - "seller": { - "allItemCount": "379", - "atmophereMask": "true", - "atmosphereColor": "#ffffff", - "atmosphereImg": "https://img.alicdn.com/imgextra/i2/379424083/O1CN01Seo8Tn1g23k80lTm6_!!379424083.jpg", - "atmosphereMaskColor": "#59000000", - "backgroundPic": "https://img.alicdn.com/imgextra/i3/O1CN01xTAR63288IdQsnpY9_!!6000000007887-0-tps-750-750.jpg", - "brandIcon": "//gw.alicdn.com/tfs/TB1lkPnjeH2gK0jSZFEXXcqMpXa-368-52.png?getAvatar=avatar", - "brandIconRatio": "7.3", - "creditLevel": "20", - "creditLevelIcon": "//gw.alicdn.com/imgextra/i1/O1CN01VD9Iap25oweneR31D_!!6000000007574-2-tps-120-60.png", - "dataTypeLabels": [ - { - "labelCode": "threshold_repurchase_rate", - "outputName": "超43%的人复购", - "processedValue": "43%" - } - ], - "detail4ShopLabelInfo": { - "dataTypeLabels": [ - { - "labelCode": "new_shop_open_year", - "outputName": "15年老店", - "processedValue": "15" - } - ], - "dsrLabels": [ - { - "labelCode": "goods_label_1", - "outputName": "88VIP好评率98%", - "processedValue": "88VIP好评率98%" - } - ], - "featureMap": { - "bc_type": "tm", - "experience_desc": "99", - "experience_level": "高", - "experience_ork": "99", - "goods_level": "高", - "goods_ork": "99", - "goods_value": "5.0", - "is_db": "Y", - "logistics_level": "高", - "logistics_ork": "99", - "logistics_value": "5.0", - "nps_star_num_out": "5.0", - "nps_value": "5.0", - "service_level": "高", - "service_ork": "99", - "service_value": "5.0" - }, - "goodDynamicLabels": [], - "overallScore": "5.0", - "serviceTypeLabels": [], - "stylizedTypeLabels": [] - }, - "entranceList": [ - { - "action": [ - { - "key": "open_url", - "params": { - "url": "//shop.m.taobao.com/shop/shop_index.htm?user_id=379424083&item_id=1019694598833¤tClickTime=-1" - } - } - ], - "backgroundColor": "#59000000", - "borderColor": "#59ffffff", - "text": "进店逛逛", - "textColor": "#ffffff" - } - ], - "evaluates": [ - { - "level": "1", - "levelBackgroundColor": "#EEEEEE", - "levelText": "高", - "levelTextColor": "#999999", - "score": "4.8 ", - "title": "宝贝描述", - "tmallLevelBackgroundColor": "#EEEEEE", - "tmallLevelTextColor": "#999999", - "type": "desc" - } - ], - "evaluates2": [ - { - "level": "1", - "levelText": "高", - "levelTextColor": "#f0f0f0", - "score": "4.8 ", - "scoreTextColor": "#ffffff", - "title": "宝贝描述", - "titleColor": "#ffffff", - "type": "desc" - } - ], - "fans": "2496万", - "fbt2User": "珀莱雅官方旗舰店", - "goodDynamicLabels": [ - { - "labelCode": "threshold_repurchase_rate", - "outputName": "超43%的人复购", - "processedValue": "43%" - } - ], - "goodRatePercentage": "100.00%", - "newItemCount": "45", - "overallScore": "5.0", - "pcShopUrl": "//shop60637940.taobao.com", - "rankLevelPic": "//img.alicdn.com/imgextra/i2/O1CN01BqRQGe28GXgm1qhik_!!6000000007905-2-tps-133-24.png", - "sellerNick": "珀莱雅官方旗舰店", - "sellerType": "B", - "serviceTypeLabels": [ - { - "labelCode": "threshold_ww_good_cst_eva_rate_30d", - "outputName": "客服满意度97%", - "processedValue": "97%" - } - ], - "shopCard": "掌柜近期上新45件宝贝，速览", - "shopIcon": "//img.alicdn.com/imgextra//i4/379424083/O1CN01ocORhv1g23s1B1Y7i_!!379424083.png", - "shopId": "60637940", - "shopName": "珀莱雅官方旗舰店", - "shopTextColor": "#ffffff", - "shopType": "B", - "shopUrl": "tmall://page.tm/shop?item_id=1019694598833&shopId=60637940", - "shopVersion": "0", - "showShopLinkIcon": "false", - "simpleShopDOStatus": "1", - "startsIcon": "https://img.alicdn.com/imgextra/i4/O1CN018GrFIW1Zx7vwjt3Jg_!!6000000003260-2-tps-91-14.png", - "stylizedTypeLabels": [], - "taoShopUrl": "//shop.m.taobao.com/shop/shop_index.htm?user_id=379424083&item_id=1019694598833", - "useFallbackImage": "true", - "userId": "379424083" - }, - "skuBase": { - "props": [ - { - "name": "商品规格", - "pid": "-1", - "values": [ - { - "image": "//img.alicdn.com/imgextra/i3/379424083/O1CN01IndZtP1g24GEdq67U_!!379424083.jpg", - "name": "水120ml+乳120ml", - "vid": "-1" - } - ] - } - ], - "skus": [ - { - "propPath": "-1:-1", - "skuId": "6196136571178" - } - ] - }, - "vertical": { - "askAll": { - "answerIcon": null, - "answerText": null, - "askIcon": "https://img.alicdn.com/tps/TB1tVU6PpXXXXXFaXXXXXXXXXXX-102-60.png", - "askText": "宝贝好不好，问问已买的人", - "linkUrl": "https://meta.m.taobao.com/app/mtb/taobao-ugc/ask/list?disableNav=YES&refId=1019694598833", - "model4XList": null, - "modelList": null, - "questNum": "0", - "showNum": "2", - "title": "问大家" - } - } - } - } - } - }, - "description": "default response" - } - }, - "security": [ - { - "tokenAuth": [] - } - ], - "summary": "Product Details (V3)", - "tags": [ - "Taobao & Tmall" - ], - "x-order": "11001100", - "x-sdk-class-name": "TaobaoResource", - "x-sdk-method-name": "get_item_detail_v3", - "x-sdk-resource": "taobao" - } - }, "/api/taobao/get-item-detail/v4": { "get": { - "description": "Retrieves product detail data for Taobao/Tmall items, including basic metadata (title, item ID, category),\nmedia assets (images), shop information, item status, and pricing.\n\nTypical use cases:\n- Building product catalogs and enriching item content (e.g., images)\n- E-commerce analytics and competitor tracking\n- General product lookup and verification\n\nHighlights\n- Accurate after-coupon price is available, but detailed coupon information is not included.\n", + "description": "Get Taobao and Tmall product Details data, including pricing, images, and shop details, for product research, catalog monitoring, and ecommerce analysis.", "operationId": "getItemDetailV4", "parameters": [ { @@ -46079,9 +45862,9 @@ "tokenAuth": [] } ], - "summary": "Product Details (V4)", + "summary": "Product Details", "tags": [ - "Taobao & Tmall" + "Taobao and Tmall" ], "x-order": "11001200", "x-sdk-class-name": "TaobaoResource", @@ -46091,7 +45874,7 @@ }, "/api/taobao/get-item-detail/v5": { "get": { - "description": "Retrieves product detail data for Taobao/Tmall items, including basic metadata (title, item ID, category),\nmedia assets (images), shop information, item status, and pricing.\n\nTypical use cases:\n- Building product catalogs and enriching item content (e.g., images)\n- E-commerce analytics and competitor tracking\n- General product lookup and verification\n\nHighlights\n- Some items are not supported. Unsupported items and transient collection failures may both return business code = 301.\n- Retry is not meant to be unlimited. A small number of retries (e.g., up to 5 attempts) is recommended.\n If it still returns code = 301, treat the item as unsupported and switch to another item or endpoint.\n", + "description": "Get Taobao and Tmall product Details data, including pricing, images, and shop details, for product research, catalog monitoring, and ecommerce analysis.", "operationId": "getItemDetailV5", "parameters": [ { @@ -46847,9 +46630,9 @@ "tokenAuth": [] } ], - "summary": "Product Details (V5)", + "summary": "Product Details", "tags": [ - "Taobao & Tmall" + "Taobao and Tmall" ], "x-order": "11001300", "x-sdk-class-name": "TaobaoResource", @@ -46859,7 +46642,7 @@ }, "/api/taobao/get-item-detail/v9": { "get": { - "description": "Retrieves product detail data for Taobao/Tmall items, including basic metadata (title, item ID, category),\nmedia assets (images), shop information, item status, and pricing.\n\nTypical use cases:\n- Building product catalogs and enriching item content (e.g., images)\n- E-commerce analytics and competitor tracking\n- General product lookup and verification\n\nHighlights\n- Some items are not supported; in that case the response business code is 202 and retrying will not help.\n- After-coupon (coupon-discounted) price is not guaranteed: some items may miss it or return an imprecise value.\n", + "description": "Get Taobao and Tmall product Details data, including pricing, images, and shop details, for product research, catalog monitoring, and ecommerce analysis.", "operationId": "getItemDetailV9", "parameters": [ { @@ -47633,9 +47416,9 @@ "tokenAuth": [] } ], - "summary": "Product Details (V9)", + "summary": "Product Details", "tags": [ - "Taobao & Tmall" + "Taobao and Tmall" ], "x-order": "11001400", "x-sdk-class-name": "TaobaoResource", @@ -47645,7 +47428,7 @@ }, "/api/taobao/get-shop-item-list/v1": { "get": { - "description": "Retrieves a paginated list of products under a Taobao/Tmall shop, including basic product metadata\n(e.g., item ID, title, price, images when available) and listing status.\n\nTypical use cases:\n- Monitoring a shop's assortment and new/removed products\n- Building shop-level catalogs and scheduled collection pipelines\n- Competitor shop tracking and e-commerce analytics\n\nHighlights\n- An empty product list may mean either: the shop has no products, or the shop is not supported by this endpoint.\n If the list is empty, verify with another shop or use an alternative endpoint if available.\n", + "description": "Get Taobao and Tmall shop Product List data, including item titles, prices, and images, for seller research and catalog tracking.", "operationId": "getShopItemListV1", "parameters": [ { @@ -47707,9 +47490,9 @@ "tokenAuth": [] } ], - "summary": "Shop Product List (V1)", + "summary": "Shop Product List", "tags": [ - "Taobao & Tmall" + "Taobao and Tmall" ], "x-order": "11001600", "x-sdk-class-name": "TaobaoResource", @@ -47719,7 +47502,7 @@ }, "/api/taobao/get-shop-item-list/v2": { "get": { - "description": "Retrieves a paginated list of products under a Taobao/Tmall shop, including basic product metadata\n(e.g., item ID, title, price, images when available) and listing status.\n\nTypical use cases:\n- Monitoring a shop's assortment and new/removed products\n- Building shop-level catalogs and scheduled collection pipelines\n- Competitor shop tracking and e-commerce analytics\n\nHighlights\n- An empty product list may mean either: the shop has no products, or the shop is not supported by this endpoint.\n If the list is empty, verify with another shop or use an alternative endpoint if available.\n", + "description": "Get Taobao and Tmall shop Product List data, including item titles, prices, and images, for seller research and catalog tracking.", "operationId": "getShopItemListV2", "parameters": [ { @@ -49404,9 +49187,9 @@ "tokenAuth": [] } ], - "summary": "Shop Product List (V2)", + "summary": "Shop Product List", "tags": [ - "Taobao & Tmall" + "Taobao and Tmall" ], "x-order": "11001700", "x-sdk-class-name": "TaobaoResource", @@ -49416,7 +49199,7 @@ }, "/api/taobao/get-shop-item-list/v3": { "get": { - "description": "Retrieves a paginated list of products under a Taobao/Tmall shop, including basic product metadata\n(e.g., item ID, title, price, images when available) and listing status.\n\nTypical use cases:\n- Monitoring a shop's assortment and new/removed products\n- Building shop-level catalogs and scheduled collection pipelines\n- Competitor shop tracking and e-commerce analytics\n\nHighlights\n- Works across all shops supported by this endpoint.\n", + "description": "Get Taobao and Tmall shop Product List data, including item titles, prices, and images, for seller research and catalog tracking.", "operationId": "getShopItemListV3", "parameters": [ { @@ -49564,9 +49347,9 @@ "tokenAuth": [] } ], - "summary": "Shop Product List (V3)", + "summary": "Shop Product List", "tags": [ - "Taobao & Tmall" + "Taobao and Tmall" ], "x-order": "11001800", "x-sdk-class-name": "TaobaoResource", @@ -49576,7 +49359,7 @@ }, "/api/taobao/search-item-list/v1": { "get": { - "description": "Searches Taobao/Tmall products by keyword and optional filters, returning a paginated result set\nwith basic product metadata (e.g., item ID, title, price, images when available) and listing status.\n\nTypical use cases:\n- Discovering products for analysis or monitoring\n- Building watchlists by keyword/category\n- Market and competitor research\n- Feeding downstream pipelines (detail collection, price tracking)\n", + "description": "Get Taobao and Tmall product Search data, including titles, prices, and images, for product discovery.", "operationId": "searchItemListV1", "parameters": [ { @@ -49771,9 +49554,9 @@ "tokenAuth": [] } ], - "summary": "Product Search (V1)", + "summary": "Product Search", "tags": [ - "Taobao & Tmall" + "Taobao and Tmall" ], "x-order": "11001900", "x-sdk-class-name": "TaobaoResource", @@ -49783,7 +49566,7 @@ }, "/api/tiktok-shop/get-product-detail/v1": { "get": { - "description": "Retrieves detailed information for a specific product on TikTok Shop based on the provided product ID and region.\nIt returns comprehensive product data including title, description, price, stock, and media.\n\nTypical use cases:\n- Building product catalogs\n- Price and stock monitoring\n- In-depth product analysis\n", + "description": "Get TikTok Shop product Details data, including title, description, and price, for building product catalogs, price and stock monitoring, and in-depth product analysis.", "operationId": "getProductDetailV1", "parameters": [ { @@ -49836,7 +49619,7 @@ "tokenAuth": [] } ], - "summary": "Product Detail (V1)", + "summary": "Product Details", "tags": [ "TikTok Shop" ], @@ -49848,7 +49631,7 @@ }, "/api/tiktok-shop/search-products/v1": { "get": { - "description": "Searches for products on TikTok Shop based on the provided keyword and region.\nIt returns a list of products including title, price, sales, and other metadata.\n\nTypical use cases:\n- Market research and trend analysis\n- Competitor product discovery\n- Monitoring product popularity in specific regions\n", + "description": "Get TikTok Shop product Search data, including title, price, and sales, for market research and trend analysis, competitor product discovery, and monitoring product popularity in specific regions.", "operationId": "searchProductsV1", "parameters": [ { @@ -49923,7 +49706,7 @@ "tokenAuth": [] } ], - "summary": "Search Products (V1)", + "summary": "Product Search", "tags": [ "TikTok Shop" ], @@ -49935,7 +49718,7 @@ }, "/api/tiktok/get-post-comment/v1": { "get": { - "description": "Retrieve a list of comments under a specific TikTok post by post ID.\nThe API returns detailed information for each comment, including comment ID, user information,\ntext content, like count, reply count, and publish time.\n\nTypical use cases:\n- Sentiment analysis of the audience's reaction to specific content.\n- Engagement measurement via comment volume and quality.\n- Community interaction research and feedback collection.\n", + "description": "Get TikTok post Comments data, including comment ID, user information, and text content, for sentiment analysis of the audience's reaction to specific content and engagement measurement via comment volume and quality.", "operationId": "getPostCommentV1", "parameters": [ { @@ -50081,7 +49864,7 @@ "tokenAuth": [] } ], - "summary": "Post Comments (V1)", + "summary": "Post Comments", "tags": [ "TikTok" ], @@ -50093,7 +49876,7 @@ }, "/api/tiktok/get-post-detail/v1": { "get": { - "description": "Retrieve detailed information for a specific TikTok post by its post ID.\nThe API returns complete metadata including video ID, author information, description text, publish time,\nengagement metrics (likes, comments, shares, views), and available download URLs for both the video and cover image.\n\nTypical use cases:\n- Content performance analysis and metadata extraction.\n- Influencer evaluation via specific post metrics.\n- Verifying post authenticity and downloading media for offline analysis.\n", + "description": "Get TikTok post Details data, including video ID, author information, and description text, for content performance analysis and metadata extraction and influencer evaluation via specific post metrics.", "operationId": "getPostDetailV1", "parameters": [ { @@ -50519,7 +50302,7 @@ "tokenAuth": [] } ], - "summary": "Post Details (V1)", + "summary": "Post Details", "tags": [ "TikTok" ], @@ -50531,7 +50314,7 @@ }, "/api/tiktok/get-post-sub-comment/v1": { "get": { - "description": "Retrieve a list of replies under a specific TikTok comment by comment ID.\nThe API returns detailed information for each reply, including reply ID, user information,\ntext content, like count, and publish time.\n\nTypical use cases:\n- Understanding detailed user interactions and threaded discussions.\n- Identifying influencers or active participants within a comment section.\n- Tracking sentiment propagation within comment threads.\n", + "description": "Get TikTok comment Replies data, including reply ID, user information, and text content, for understanding detailed user interactions and threaded discussions and identifying influencers or active participants within a comment section.", "operationId": "getPostSubCommentV1", "parameters": [ { @@ -50757,7 +50540,7 @@ "tokenAuth": [] } ], - "summary": "Comment Replies (V1)", + "summary": "Comment Replies", "tags": [ "TikTok" ], @@ -50769,7 +50552,7 @@ }, "/api/tiktok/get-user-detail/v1": { "get": { - "description": "Retrieve detailed profile information for a specific TikTok user by user ID.\nThe API returns comprehensive data including nickname, unique ID, avatar, bio, follower/following counts,\ntotal likes, and other engagement indicators.\n\nTypical use cases:\n- Influencer profiling and audience analysis.\n- Account performance tracking and growth monitoring.\n- Identifying verified status and official accounts.\n\nNotes:\n- You must provide either 'uniqueId' or 'secUid'.\n", + "description": "Get TikTok user Profile data, including nickname, unique ID, and avatar, for influencer profiling and audience analysis, account performance tracking and growth monitoring, and identifying verified status and official accounts.", "operationId": "getUserDetailV1", "parameters": [ { @@ -50941,7 +50724,7 @@ "tokenAuth": [] } ], - "summary": "User Profile (V1)", + "summary": "User Profile", "tags": [ "TikTok" ], @@ -50953,7 +50736,7 @@ }, "/api/tiktok/get-user-post/v1": { "get": { - "description": "Retrieve a list of posts published by a specific TikTok user.\nThe API returns detailed information about each post, including video ID, description, publish time,\nstatistics (likes, comments, shares, views), and video download URL if available.\n\nTypical use cases:\n- User activity analysis and posting frequency tracking.\n- Influencer performance evaluation.\n- Content trend monitoring for specific creators.\n", + "description": "Get TikTok user Published Posts data, including video ID, description, and publish time, for user activity analysis and posting frequency tracking, influencer performance evaluation, and content trend monitoring for specific creators.", "operationId": "getUserPostV1", "parameters": [ { @@ -51270,7 +51053,7 @@ "tokenAuth": [] } ], - "summary": "User Published Posts (V1)", + "summary": "User Published Posts", "tags": [ "TikTok" ], @@ -51282,7 +51065,7 @@ }, "/api/tiktok/search-post/v1": { "get": { - "description": "Search for TikTok posts by keyword.\nThe API returns a list of matching posts with key details such as video ID, description,\nauthor information, publish time, and engagement metrics (likes, comments, shares, views).\n\nTypical use cases:\n- Trend monitoring and content discovery.\n- Keyword-based market analysis and sentiment tracking.\n- Identifying viral content related to specific topics.\n", + "description": "Get TikTok post Search data, including key details such as video ID, description, and author information, for trend monitoring and content discovery and keyword-based market analysis and sentiment tracking.", "operationId": "searchPostV1", "parameters": [ { @@ -52695,7 +52478,7 @@ "tokenAuth": [] } ], - "summary": "Post Search (V1)", + "summary": "Post Search", "tags": [ "TikTok" ], @@ -52707,7 +52490,7 @@ }, "/api/tiktok/search-user/v1": { "get": { - "description": "Search for TikTok users by keyword.\nThe API returns a list of matching users along with basic profile information such as user ID,\nnickname, unique handle, avatar, bio, follower count, and verification status.\n\nTypical use cases:\n- Discovering influencers in specific niches via keywords.\n- Identifying target audiences and conducting competitor research.\n- Finding official brand accounts.\n", + "description": "Get TikTok user Search data, including basic profile information such as user ID, nickname, and unique handle, for discovering influencers in specific niches via keywords and identifying target audiences and conducting competitor research.", "operationId": "searchUserV1", "parameters": [ { @@ -53376,7 +53159,7 @@ "tokenAuth": [] } ], - "summary": "User Search (V1)", + "summary": "User Search", "tags": [ "TikTok" ], @@ -53388,7 +53171,7 @@ }, "/api/toutiao/get-article-detail/v1": { "get": { - "description": "Retrieve detailed information for a specific Toutiao (Jinri Toutiao) article by its article ID.\n\nThe API returns complete metadata including article ID, title, author information, publish time, content text or summary, engagement metrics (views, comments, likes, shares), and the article URL.\n\nTypical use cases:\n- Content performance analysis and media monitoring.\n- Verifying article authenticity and metadata retrieval.\n", + "description": "Get Toutiao article Details data, including article ID, title, and author information, for content performance analysis and media monitoring and verifying article authenticity and metadata retrieval.", "operationId": "getArticleDetailV1", "parameters": [ { @@ -53893,7 +53676,7 @@ "tokenAuth": [] } ], - "summary": "Article Details (V1)", + "summary": "Article Details", "tags": [ "Toutiao" ], @@ -53905,7 +53688,7 @@ }, "/api/toutiao/get-user-detail/v1": { "get": { - "description": "Retrieve detailed information for a specific Toutiao (Jinri Toutiao) user by their user ID.\n\nThe API returns comprehensive profile metadata including user ID, nickname, avatar, bio/description, verification status, follower and following counts, total likes, and total published articles or videos.\n\nTypical use cases:\n- Influencer profiling and audience analysis.\n- Monitoring creator performance and growth.\n", + "description": "Get Toutiao user Profile data, including user ID, nickname, and avatar, for influencer profiling and audience analysis and monitoring creator performance and growth.", "operationId": "getUserDetailV1", "parameters": [ { @@ -53984,7 +53767,7 @@ "tokenAuth": [] } ], - "summary": "User Profile (V1)", + "summary": "User Profile", "tags": [ "Toutiao" ], @@ -53997,7 +53780,7 @@ "/api/toutiao/search/v1": { "get": { "deprecated": true, - "description": "Perform a keyword-based search on Toutiao (Jinri Toutiao) App to retrieve a list of matching articles, videos, and other content.\n\nThe API returns detailed search results including title, summary, author, publish time, and engagement metrics such as likes, comments, and shares.\n\nTypical use cases:\n- Content aggregation and trend analysis.\n- Media monitoring and keyword intelligence.\n", + "description": "Get Toutiao app Keyword Search data, including matching articles, videos, and authors, for topic discovery and monitoring.", "operationId": "searchV1", "parameters": [ { @@ -54436,7 +54219,7 @@ "tokenAuth": [] } ], - "summary": "Search (V1)", + "summary": "App Keyword Search", "tags": [ "Toutiao" ], @@ -54448,7 +54231,7 @@ }, "/api/toutiao/search/v2": { "get": { - "description": "Perform a keyword-based search on Toutiao (Jinri Toutiao) PC version to retrieve a list of matching articles, videos, and other content.\n\nThe API returns detailed search results including title, summary, author, publish time, and engagement metrics such as likes, comments, and shares.\n\nTypical use cases:\n- Content aggregation and trend analysis.\n- Media monitoring and keyword intelligence.\n\nHighlights\n- This is the PC version of the search API. Note that it currently only supports retrieving the first page of results.\n", + "description": "Get Toutiao web Keyword Search data, including this is the PC version of the search API. Note that it currently only supports retrieving the first page of results, for first-page discovery of articles, videos, and authors for trend research and monitoring.", "operationId": "searchV2", "parameters": [ { @@ -54475,7 +54258,7 @@ "tokenAuth": [] } ], - "summary": "Search (V2)", + "summary": "Web Keyword Search", "tags": [ "Toutiao" ], @@ -54487,7 +54270,7 @@ }, "/api/twitter/get-user-detail/v1": { "get": { - "description": "Retrieves basic public information for a specific X (Twitter) user using their Rest ID.\n\nTypical use cases:\n- Accessing user profile metadata (e.g., description, location, verification status).\n- Collecting follower and following counts.\n- Verifying account details for identity confirmation.\n", + "description": "Get Twitter user Profile data, including account metadata, audience metrics, and verification-related fields, for accessing user profile metadata (e.g., description, location, verification status) and collecting follower and following counts.", "operationId": "getUserDetailV1", "parameters": [ { @@ -54555,9 +54338,9 @@ "tokenAuth": [] } ], - "summary": "User Details (V1)", + "summary": "User Profile", "tags": [ - "X(Twitter)" + "Twitter" ], "x-order": 31001000, "x-sdk-class-name": "TwitterResource", @@ -54567,7 +54350,7 @@ }, "/api/twitter/get-user-posts/v1": { "get": { - "description": "Retrieves the public tweet timeline (posts) for a specific X (Twitter) user.\n\nTypical use cases:\n- Monitoring recent activity of influential accounts.\n- Collecting tweets for archival or content analysis.\n- Tracking engagement on specific user-generated content.\n\nHighlights:\n- Supports pagination via cursor for large datasets.\n", + "description": "Get Twitter user Published Posts data, including post content, timestamps, and engagement data, for account monitoring and content analysis.", "operationId": "getUserPostsV1", "parameters": [ { @@ -56844,9 +56627,9 @@ "tokenAuth": [] } ], - "summary": "User Published Posts (V1)", + "summary": "User Published Posts", "tags": [ - "X(Twitter)" + "Twitter" ], "x-order": 31001100, "x-sdk-class-name": "TwitterResource", @@ -56854,9 +56637,138 @@ "x-sdk-resource": "twitter" } }, + "/api/web/html/v1": { + "get": { + "description": "Get the HTML content of a web page.", + "operationId": "htmlV1", + "parameters": [ + { + "description": "The URL of the web page to fetch.", + "in": "query", + "name": "url", + "required": true, + "schema": { + "type": "string" + }, + "x-sdk-python-name": "url" + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/Result" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "tokenAuth": [] + } + ], + "summary": "HTML Content", + "tags": [ + "Web Page" + ], + "x-order": "35001000", + "x-sdk-class-name": "WebResource", + "x-sdk-method-name": "html_v1", + "x-sdk-resource": "web" + } + }, + "/api/web/markdown/v1": { + "get": { + "description": "Get the Markdown content of a web page.", + "operationId": "markdownV1", + "parameters": [ + { + "description": "The URL of the web page to fetch.", + "in": "query", + "name": "url", + "required": true, + "schema": { + "type": "string" + }, + "x-sdk-python-name": "url" + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/Result" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "tokenAuth": [] + } + ], + "summary": "Markdown Content", + "tags": [ + "Web Page" + ], + "x-order": "35001200", + "x-sdk-class-name": "WebResource", + "x-sdk-method-name": "markdown_v1", + "x-sdk-resource": "web" + } + }, + "/api/web/rendered-html/v1": { + "get": { + "description": "Get the Rendered HTML content of a web page.", + "operationId": "renderedHtmlV1", + "parameters": [ + { + "description": "The URL of the web page to fetch.", + "in": "query", + "name": "url", + "required": true, + "schema": { + "type": "string" + }, + "x-sdk-python-name": "url" + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/Result" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "tokenAuth": [] + } + ], + "summary": "Rendered HTML Content", + "tags": [ + "Web Page" + ], + "x-order": "35001100", + "x-sdk-class-name": "WebResource", + "x-sdk-method-name": "rendered_html_v1", + "x-sdk-resource": "web" + } + }, "/api/weibo/get-fans/v1": { "get": { - "description": "Retrieves the follower list (fans) of a specified Weibo user with pagination.\nIncludes user IDs, nicknames, avatars, and verification status of followers.\n\nTypical use cases:\n- Audience analysis and demographic research\n- Monitoring follower growth and community engagement\n", + "description": "Get Weibo user Fans data, including profile metadata and verification signals, for audience analysis and influencer research.", "operationId": "getFansV1", "parameters": [ { @@ -57051,7 +56963,7 @@ "tokenAuth": [] } ], - "summary": "User Fans (V1)", + "summary": "User Fans", "tags": [ "Weibo" ], @@ -57063,7 +56975,7 @@ }, "/api/weibo/get-followers/v1": { "get": { - "description": "Retrieves the list of accounts that a specified Weibo user is following.\nIncludes user IDs, nicknames, avatars, and verification status of the followed accounts.\n\nTypical use cases:\n- Relationship mapping and network analysis\n- Identifying interests and associations of specific users\n", + "description": "Get Weibo user Followers data, including profile metadata and verification signals, for network analysis and creator research.", "operationId": "getFollowersV1", "parameters": [ { @@ -57258,7 +57170,7 @@ "tokenAuth": [] } ], - "summary": "User Followers (V1)", + "summary": "User Followers", "tags": [ "Weibo" ], @@ -57270,7 +57182,7 @@ }, "/api/weibo/get-post-comments/v1": { "get": { - "description": " Retrieves comments for a specified Weibo post with pagination.\n Returns comment content, comment ID, author information, publish time, and related engagement data when available.\n\n Typical use cases:\n - Collecting comment threads for a specific post\n - Sentiment analysis and audience feedback research\n - Monitoring engagement and discussion around a post\n", + "description": "Get Weibo post Comments data, including text, authors, and timestamps, for feedback analysis.", "operationId": "getPostCommentsV1", "parameters": [ { @@ -57323,7 +57235,7 @@ "tokenAuth": [] } ], - "summary": "Post Comments (V1)", + "summary": "Post Comments", "tags": [ "Weibo" ], @@ -57335,7 +57247,7 @@ }, "/api/weibo/get-user-detail/v3": { "get": { - "description": "Retrieves detailed profile information for a specified Weibo user, including nickname, avatar,\nuser ID, follower/following counts, bio, and verification status.\n\nTypical use cases:\n- Creator/KOL identification and monitoring\n- Enriching user records for analytics and reporting\n", + "description": "Get Weibo user Profile data, including follower counts, verification status, and bio details, for creator research and account analysis.", "operationId": "getUserProfileV3", "parameters": [ { @@ -57450,7 +57362,7 @@ "tokenAuth": [] } ], - "summary": "User Profile (V3)", + "summary": "User Profile", "tags": [ "Weibo" ], @@ -57462,7 +57374,7 @@ }, "/api/weibo/get-user-post/v1": { "get": { - "description": "Retrieves the post list of a specified Weibo user with pagination.\nEach entry includes status ID, text, media assets, publish time, and engagement metrics.\n\nTypical use cases:\n- Creator monitoring and content tracking\n- Building content timelines for specific accounts\n", + "description": "Get Weibo user Published Posts data, including text, media, and publish times, for account monitoring.", "operationId": "getUserPublishedPostsV1", "parameters": [ { @@ -58221,7 +58133,7 @@ "tokenAuth": [] } ], - "summary": "User Published Posts (V1)", + "summary": "User Published Posts", "tags": [ "Weibo" ], @@ -58233,7 +58145,7 @@ }, "/api/weibo/get-weibo-detail/v1": { "get": { - "description": "Retrieves detailed information about a specific Weibo post, including full text content,\nmedia assets (images/videos), author information, publish time, and engagement metrics (likes, comments, and reposts).\n\nTypical use cases:\n- Detailed analysis of specific social media posts\n- Content archival and monitoring\n", + "description": "Get Weibo post Details data, including media, author metadata, and engagement counts, for post analysis, archiving, and campaign monitoring.", "operationId": "getWeiboDetailsV1", "parameters": [ { @@ -58469,7 +58381,7 @@ "tokenAuth": [] } ], - "summary": "Post Details (V1)", + "summary": "Post Details", "tags": [ "Weibo" ], @@ -58481,7 +58393,7 @@ }, "/api/weibo/hot-search/v1": { "get": { - "description": "Retrieves the current hot search (trending) topics from Weibo.\n\nTypical use cases:\n- Real-time trend monitoring\n- Identifying viral topics and news\n", + "description": "Get Weibo hot Search data, including ranking data, for trend monitoring, newsroom workflows, and topic discovery.", "operationId": "hotSearchV1", "parameters": [], "responses": { @@ -59349,7 +59261,7 @@ "tokenAuth": [] } ], - "summary": "Hot Search (V1)", + "summary": "Hot Search", "tags": [ "Weibo" ], @@ -59361,7 +59273,7 @@ }, "/api/weibo/search-all/v2": { "get": { - "description": "Enables advanced keyword-based search on Weibo posts, supporting filters such as time range.\nReturns matching posts with content, author info, publish time, and engagement metrics (likes, reposts, comments).\n\nTypical use cases:\n- Tracking discussions around specific brands or events\n- Gathering public opinion data for a specific time period\n", + "description": "Get Weibo keyword Search data, including authors, publish times, and engagement signals, for trend monitoring.", "operationId": "searchAllV2", "parameters": [ { @@ -59461,7 +59373,7 @@ "tokenAuth": [] } ], - "summary": "Keyword Search (V2)", + "summary": "Keyword Search", "tags": [ "Weibo" ], @@ -59473,7 +59385,7 @@ }, "/api/weibo/search-profile/v1": { "get": { - "description": "Search Weibo posts published by a specific user by keywords and time range.\n", + "description": "Get Weibo search User Published Posts data, including matched results, metadata, and ranking signals, for author research and historical content discovery.", "operationId": "searchProfileV1", "parameters": [ { @@ -59542,7 +59454,7 @@ "tokenAuth": [] } ], - "summary": "Search User Published Posts (V1)", + "summary": "Search User Published Posts", "tags": [ "Weibo" ], @@ -59554,7 +59466,7 @@ }, "/api/weibo/tv-component/v1": { "get": { - "description": "Retrieves detailed information of a single Weibo TV video by its object ID.\nIncludes video metadata, media URLs, cover images, author info, and engagement metrics.\n\nTypical use cases:\n- Video content analysis and archival\n- Monitoring performance of Weibo TV videos\n", + "description": "Get Weibo tV Video Details data, including media URLs, author details, and engagement counts, for video research, archiving, and performance analysis.", "operationId": "tvComponentV1", "parameters": [ { @@ -59816,7 +59728,7 @@ "tokenAuth": [] } ], - "summary": "TV Video Details (V1)", + "summary": "TV Video Details", "tags": [ "Weibo" ], @@ -59828,7 +59740,7 @@ }, "/api/weixin/get-article-comment/v1": { "get": { - "description": "Retrieves user comments from a specific Weixin Official Account article, including commenter name, comment content, like count, and timestamp.\n\nTypical use cases:\n- Analyzing community sentiment and feedback.\n- Identifying popular discussion points.\n", + "description": "Get WeChat Official Accounts article Comments data, including commenter details, comment text, and timestamps, for feedback analysis.", "operationId": "getArticleComment", "parameters": [ { @@ -59860,9 +59772,9 @@ "tokenAuth": [] } ], - "summary": "Article Comments (V1)", + "summary": "Article Comments", "tags": [ - "Weixin" + "WeChat Official Accounts" ], "x-order": 20001200, "x-sdk-class-name": "WeixinResource", @@ -59872,7 +59784,7 @@ }, "/api/weixin/get-article-detail/v1": { "get": { - "description": "Retrieves core metadata and content details for a specific Weixin Official Account article.\n\nTypical use cases:\n- Scraping detailed content for archival or analysis.\n- Verifying article metadata from a URL.\n", + "description": "Get WeChat Official Accounts article Details data, including body content, for article archiving, research, and content analysis.", "operationId": "getArticleDetailV1", "parameters": [ { @@ -59912,9 +59824,9 @@ "tokenAuth": [] } ], - "summary": "Article Details (V1)", + "summary": "Article Details", "tags": [ - "Weixin" + "WeChat Official Accounts" ], "x-order": 20001400, "x-sdk-class-name": "WeixinResource", @@ -59924,7 +59836,7 @@ }, "/api/weixin/get-article-feedback/v1": { "get": { - "description": "Retrieves engagement metrics for a specific Weixin Official Account article, including read count, like count, share count, and comment count.\n\nTypical use cases:\n- Tracking performance of a specific post.\n- Comparing engagement levels across different articles.\n", + "description": "Get WeChat Official Accounts article Engagement Metrics data, including like, share, and comment metrics, for article performance tracking and benchmarking.", "operationId": "getArticleFeedback", "parameters": [ { @@ -59963,9 +59875,9 @@ "tokenAuth": [] } ], - "summary": "Article Engagement Metrics (V1)", + "summary": "Article Engagement Metrics", "tags": [ - "Weixin" + "WeChat Official Accounts" ], "x-order": 20001100, "x-sdk-class-name": "WeixinResource", @@ -59975,7 +59887,7 @@ }, "/api/weixin/get-user-post/v1": { "get": { - "description": "Retrieves posts published by a specific Weixin Official Account, including title, author, publish time, content summary, and engagement metrics such as reads, likes, and shares.\n\nTypical use cases:\n- Monitoring recent activity of a specific account.\n- Analyzing publishing frequency and content types.\n", + "description": "Get WeChat Official Accounts user Published Posts data, including titles, publish times, and summaries, for account monitoring.", "operationId": "getUserPost", "parameters": [ { @@ -60120,9 +60032,9 @@ "tokenAuth": [] } ], - "summary": "User Published Posts (V1)", + "summary": "User Published Posts", "tags": [ - "Weixin" + "WeChat Official Accounts" ], "x-order": 20001000, "x-sdk-class-name": "WeixinResource", @@ -60132,7 +60044,7 @@ }, "/api/weixin/search/v1": { "get": { - "description": "Supports keyword-based search for both Weixin Official Accounts and their published articles. It returns matched accounts or posts with details such as account name, article title, publish time, and summary.\n\nTypical use cases:\n- Discovering new accounts related to specific topics.\n- Finding historical articles using keywords.\n", + "description": "Get WeChat Official Accounts keyword Search data, including account names, titles, and publish times, for content discovery.", "operationId": "searchV1", "parameters": [ { @@ -60275,9 +60187,9 @@ "tokenAuth": [] } ], - "summary": "Search (V1)", + "summary": "Keyword Search", "tags": [ - "Weixin" + "WeChat Official Accounts" ], "x-order": 20001300, "x-sdk-class-name": "WeixinResource", @@ -60287,7 +60199,7 @@ }, "/api/xiaohongshu-pgy/api/pgy/kol/data/core_data/v1": { "get": { - "description": "Retrieve core performance data for a KOL.", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) creator Core Metrics data, including engagement and content metrics, for benchmarking, vetting, and campaign planning.", "operationId": "apiPgyKolDataCoreDataV1", "parameters": [ { @@ -60384,9 +60296,9 @@ "tokenAuth": [] } ], - "summary": "KOL Data Core (V1)", + "summary": "Creator Core Metrics", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13002300", "x-sdk-class-name": "XiaohongshuPgyResource", @@ -60396,7 +60308,7 @@ }, "/api/xiaohongshu-pgy/api/solar/cooperator/blogger/v2/v1": { "get": { - "description": "Search for KOLs using various filters.", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) creator Search data, including filters, returning profile, and audience, for discovery, comparison, and shortlist building.", "operationId": "apiSolarCooperatorBloggerV2V1", "parameters": [ { @@ -60725,9 +60637,9 @@ "tokenAuth": [] } ], - "summary": "KOL Search (V1)", + "summary": "Creator Search", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13002200", "x-sdk-class-name": "XiaohongshuPgyResource", @@ -60737,7 +60649,7 @@ }, "/api/xiaohongshu-pgy/api/solar/cooperator/user/blogger/userId/v1": { "get": { - "description": "Retrieve blogger profile information.", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) creator Profile data, including audience and pricing data, for influencer vetting, benchmark analysis, and campaign planning.", "operationId": "apiSolarCooperatorUserBloggerUserIdV1", "parameters": [ { @@ -60937,9 +60849,9 @@ "tokenAuth": [] } ], - "summary": "User Blogger (V1)", + "summary": "Creator Profile", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13001000", "x-sdk-class-name": "XiaohongshuPgyResource", @@ -60949,7 +60861,7 @@ }, "/api/xiaohongshu-pgy/api/solar/kol/data/userId/fans_overall_new_history/v1": { "get": { - "description": "Retrieve historical fans growth data.", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) follower Growth History data, including historical points, trend signals, and growth metrics, for trend tracking, audience analysis, and creator performance monitoring.", "operationId": "apiSolarKolDataUserIdFansOverallNewHistoryV1", "parameters": [ { @@ -61138,9 +61050,9 @@ "tokenAuth": [] } ], - "summary": "Fans Overall New History (V1)", + "summary": "Follower Growth History", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13001200", "x-sdk-class-name": "XiaohongshuPgyResource", @@ -61150,7 +61062,7 @@ }, "/api/xiaohongshu-pgy/api/solar/kol/data/userId/fans_profile/v1": { "get": { - "description": "Get detailed fans profile for a specific KOL.", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) follower Profile data, including audience demographics, interests, and distribution metrics, for creator evaluation, campaign planning, and creator benchmarking.", "operationId": "apiSolarKolDataUserIdFansProfileV1", "parameters": [ { @@ -61528,9 +61440,9 @@ "tokenAuth": [] } ], - "summary": "Fans Profile (V1)", + "summary": "Follower Profile", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13001900", "x-sdk-class-name": "XiaohongshuPgyResource", @@ -61540,7 +61452,7 @@ }, "/api/xiaohongshu-pgy/api/solar/kol/dataV2/costEffective/v1": { "get": { - "description": "Analyze cost-effectiveness of a specific KOL.", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) cost Effectiveness Analysis data, including pricing, reach, and engagement efficiency indicators, for campaign evaluation.", "operationId": "apiSolarKolDataV2CostEffectiveV1", "parameters": [ { @@ -61588,9 +61500,9 @@ "tokenAuth": [] } ], - "summary": "Cost Effective (V1)", + "summary": "Cost Effectiveness Analysis", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13002000", "x-sdk-class-name": "XiaohongshuPgyResource", @@ -61600,7 +61512,7 @@ }, "/api/xiaohongshu-pgy/api/solar/kol/dataV2/kolContentTags/v1": { "get": { - "description": "Get content-related tags for a KOL.", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) creator Content Tags data, including topic labels that describe publishing themes and content focus, for creator evaluation, campaign planning, and creator benchmarking.", "operationId": "apiSolarKolDataV2KolContentTagsV1", "parameters": [ { @@ -61632,9 +61544,9 @@ "tokenAuth": [] } ], - "summary": "KOL Content Tags (V1)", + "summary": "Creator Content Tags", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13001600", "x-sdk-class-name": "XiaohongshuPgyResource", @@ -61644,7 +61556,7 @@ }, "/api/xiaohongshu-pgy/api/solar/kol/dataV2/kolFeatureTags/v1": { "get": { - "description": "Get feature tags assigned to a KOL.", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) creator Feature Tags data, including platform tags, category labels, and classification signals, for segmentation, discovery, and creator classification.", "operationId": "apiSolarKolDataV2KolFeatureTagsV1", "parameters": [ { @@ -61676,9 +61588,9 @@ "tokenAuth": [] } ], - "summary": "KOL Feature Tags (V1)", + "summary": "Creator Feature Tags", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13001500", "x-sdk-class-name": "XiaohongshuPgyResource", @@ -61688,7 +61600,7 @@ }, "/api/xiaohongshu-pgy/api/solar/kol/dataV2/notesDetail/v1": { "get": { - "description": "Retrieves the list of notes published by a specific Xiaohongshu user.\nIt returns note items posted by the target account, typically including note IDs, titles/covers (if available), publish-related metadata, and paging information.\n\nTypical use cases:\n- Creator content monitoring: track a user's recently published notes.\n- Content collection: build datasets of notes under a specific account.\n- Account activity analysis: review posting frequency and content output.\n\nHighlights\n- Some users may not return note data through this endpoint. In general, users enrolled in Pugongying or users with relatively large follower bases are more likely to be supported.\n", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) user Published Notes data, including note metadata and engagement signals, for creator monitoring and campaign research.", "operationId": "apiSolarKolDataV2NotesDetailV1", "parameters": [ { @@ -61907,9 +61819,9 @@ "tokenAuth": [] } ], - "summary": "User Published Notes List (V1)", + "summary": "User Published Notes", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13001800", "x-sdk-class-name": "XiaohongshuPgyResource", @@ -61919,7 +61831,7 @@ }, "/api/xiaohongshu-pgy/api/solar/kol/dataV3/dataSummary/v1": { "get": { - "description": "Get summary data for a specific KOL.", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) Summary data, including activity, engagement, and audience growth, for creator evaluation, campaign planning, and creator benchmarking.", "operationId": "apiSolarKolDataV3DataSummaryV1", "parameters": [ { @@ -61989,9 +61901,9 @@ "tokenAuth": [] } ], - "summary": "Data Summary (V1)", + "summary": "Data Summary", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13001100", "x-sdk-class-name": "XiaohongshuPgyResource", @@ -62001,7 +61913,7 @@ }, "/api/xiaohongshu-pgy/api/solar/kol/dataV3/fansSummary/v1": { "get": { - "description": "Get summary of fans demographics and stats.", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) follower Summary data, including growth and engagement metrics, for audience analysis and creator benchmarking.", "operationId": "apiSolarKolDataV3FansSummaryV1", "parameters": [ { @@ -62049,9 +61961,9 @@ "tokenAuth": [] } ], - "summary": "Fans Summary (V1)", + "summary": "Follower Summary", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13001300", "x-sdk-class-name": "XiaohongshuPgyResource", @@ -62061,7 +61973,7 @@ }, "/api/xiaohongshu-pgy/api/solar/kol/dataV3/notesRate/v1": { "get": { - "description": "Get performance rates for notes.", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) note Performance Rates data, including core metrics, trend signals, and performance indicators, for content efficiency analysis, creator benchmarking, and campaign planning.", "operationId": "apiSolarKolDataV3NotesRateV1", "parameters": [ { @@ -62531,9 +62443,9 @@ "tokenAuth": [] } ], - "summary": "Notes Rate (V1)", + "summary": "Note Performance Rates", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13001700", "x-sdk-class-name": "XiaohongshuPgyResource", @@ -62543,7 +62455,7 @@ }, "/api/xiaohongshu-pgy/api/solar/kol/get_similar_kol/v1": { "get": { - "description": "Find similar KOLs based on a given user ID.", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) similar Creators data, including audience signals, for creator discovery, benchmarking, and shortlist building.", "operationId": "apiSolarKolGetSimilarKolV1", "parameters": [ { @@ -62594,9 +62506,9 @@ "tokenAuth": [] } ], - "summary": "Similar KOL (V1)", + "summary": "Similar Creators", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13001400", "x-sdk-class-name": "XiaohongshuPgyResource", @@ -62606,7 +62518,7 @@ }, "/api/xiaohongshu-pgy/api/solar/note/noteId/detail/v1": { "get": { - "description": "Retrieve details for a specific note.", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) note Details data, including media and engagement signals, for content analysis, archiving, and campaign review.", "operationId": "apiSolarNoteNoteIdDetailV1", "parameters": [ { @@ -62737,9 +62649,9 @@ "tokenAuth": [] } ], - "summary": "Note Details (V1)", + "summary": "Note Details", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13002100", "x-sdk-class-name": "XiaohongshuPgyResource", @@ -62750,7 +62662,7 @@ "/api/xiaohongshu-pgy/get-kol-core-data/v1": { "get": { "deprecated": true, - "description": "Retrieve core performance data (Legacy).", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) creator Core Metrics data, including engagement and content metrics, for benchmarking, vetting, and campaign planning.", "operationId": "getKolDataCoreV1", "parameters": [ { @@ -62858,9 +62770,9 @@ "tokenAuth": [] } ], - "summary": "KOL Data Core (V1) [Deprecated]", + "summary": "Creator Core Metrics", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13003400", "x-sdk-class-name": "XiaohongshuPgyResource", @@ -62871,7 +62783,7 @@ "/api/xiaohongshu-pgy/get-kol-cost-effective/v1": { "get": { "deprecated": true, - "description": "Get cost-effectiveness data (Legacy).", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) cost Effectiveness Analysis data, including pricing, reach, and engagement efficiency indicators, for campaign evaluation.", "operationId": "getKolCostEffectiveV1", "parameters": [ { @@ -62914,9 +62826,9 @@ "tokenAuth": [] } ], - "summary": "KOL Cost-Effectiveness (V1) [Deprecated]", + "summary": "Cost Effectiveness Analysis", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13003200", "x-sdk-class-name": "XiaohongshuPgyResource", @@ -62927,7 +62839,7 @@ "/api/xiaohongshu-pgy/get-kol-data-summary/v1": { "get": { "deprecated": true, - "description": "Get data overview (Legacy).", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) creator Performance Overview data, including audience, content performance, and commercial indicators, for quick evaluation.", "operationId": "getKolDataSummaryV1", "parameters": [ { @@ -63007,9 +62919,9 @@ "tokenAuth": [] } ], - "summary": "KOL Data Overview (V1) [Deprecated]", + "summary": "Creator Performance Overview", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13003000", "x-sdk-class-name": "XiaohongshuPgyResource", @@ -63020,7 +62932,7 @@ "/api/xiaohongshu-pgy/get-kol-data-summary/v2": { "get": { "deprecated": true, - "description": "Get data overview (Legacy V2).", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) creator Performance Overview data, including audience, content performance, and commercial indicators, for quick evaluation.", "operationId": "getKolDataSummaryV2", "parameters": [ { @@ -63100,9 +63012,9 @@ "tokenAuth": [] } ], - "summary": "KOL Data Overview (V2) [Deprecated]", + "summary": "Creator Performance Overview", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13003100", "x-sdk-class-name": "XiaohongshuPgyResource", @@ -63113,7 +63025,7 @@ "/api/xiaohongshu-pgy/get-kol-fans-portrait/v1": { "get": { "deprecated": true, - "description": "Get fans portrait (Legacy).", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) follower Profile data, including audience demographics, interests, and distribution metrics, for creator evaluation, campaign planning, and creator benchmarking.", "operationId": "getKolFansPortraitV1", "parameters": [ { @@ -63502,9 +63414,9 @@ "tokenAuth": [] } ], - "summary": "KOL Follower Profile (V1) [Deprecated]", + "summary": "Follower Profile", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13002600", "x-sdk-class-name": "XiaohongshuPgyResource", @@ -63515,7 +63427,7 @@ "/api/xiaohongshu-pgy/get-kol-fans-summary/v1": { "get": { "deprecated": true, - "description": "Get fans summary (Legacy).", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) follower Analysis data, including core metrics, trend signals, and performance indicators, for creator evaluation, campaign planning, and creator benchmarking.", "operationId": "getKolFansSummaryV1", "parameters": [ { @@ -63574,9 +63486,9 @@ "tokenAuth": [] } ], - "summary": "KOL Follower Analysis (V1) [Deprecated]", + "summary": "Follower Analysis", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13002700", "x-sdk-class-name": "XiaohongshuPgyResource", @@ -63587,7 +63499,7 @@ "/api/xiaohongshu-pgy/get-kol-fans-trend/v1": { "get": { "deprecated": true, - "description": "Get fans growth trend (Legacy).", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) follower Growth Trend data, including historical audience changes over time, for creator evaluation, campaign planning, and creator benchmarking.", "operationId": "getKolFansTrendV1", "parameters": [ { @@ -63785,9 +63697,9 @@ "tokenAuth": [] } ], - "summary": "KOL Follower Trend (V1) [Deprecated]", + "summary": "Follower Growth Trend", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13002800", "x-sdk-class-name": "XiaohongshuPgyResource", @@ -63798,7 +63710,7 @@ "/api/xiaohongshu-pgy/get-kol-info/v1": { "get": { "deprecated": true, - "description": "Retrieve KOL profile information (Legacy).", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) creator Profile data, including audience and pricing data, for influencer vetting, benchmark analysis, and campaign planning.", "operationId": "getKolInfoV1", "parameters": [ { @@ -63988,9 +63900,9 @@ "tokenAuth": [] } ], - "summary": "KOL Profile (V1) [Deprecated]", + "summary": "Creator Profile", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13002400", "x-sdk-class-name": "XiaohongshuPgyResource", @@ -64000,7 +63912,7 @@ }, "/api/xiaohongshu-pgy/get-kol-note-list/v1": { "get": { - "description": "Retrieve list of notes for a specific KOL.", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) creator Note List data, including content metadata, publish time, and engagement indicators, for content analysis.", "operationId": "getKolNoteListV1", "parameters": [ { @@ -64107,9 +64019,9 @@ "tokenAuth": [] } ], - "summary": "KOL Note List (V1)", + "summary": "Creator Note List", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13002900", "x-sdk-class-name": "XiaohongshuPgyResource", @@ -64120,7 +64032,7 @@ "/api/xiaohongshu-pgy/get-kol-note-rate/v1": { "get": { "deprecated": true, - "description": "Get note performance rate (Legacy).", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) note Performance Rates data, including core metrics, trend signals, and performance indicators, for content efficiency analysis, creator benchmarking, and campaign planning.", "operationId": "getKolNoteRateV1", "parameters": [ { @@ -64293,9 +64205,9 @@ "tokenAuth": [] } ], - "summary": "KOL Note Rate (V1) [Deprecated]", + "summary": "Note Performance Rates", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13002500", "x-sdk-class-name": "XiaohongshuPgyResource", @@ -64306,7 +64218,7 @@ "/api/xiaohongshu-pgy/get-note-detail/v1": { "get": { "deprecated": true, - "description": "Get note details (Legacy).", + "description": "Get Xiaohongshu Creator Marketplace (Pugongying) note Details data, including media and engagement signals, for content analysis, archiving, and campaign review.", "operationId": "getNoteDetailV1", "parameters": [ { @@ -64420,9 +64332,9 @@ "tokenAuth": [] } ], - "summary": "Note Details (V1) [Deprecated]", + "summary": "Note Details", "tags": [ - "Xiaohongshu Pgy" + "Xiaohongshu Creator Marketplace (Pugongying)" ], "x-order": "13003300", "x-sdk-class-name": "XiaohongshuPgyResource", @@ -64432,7 +64344,7 @@ }, "/api/xiaohongshu/get-note-comment/v2": { "get": { - "description": "Retrieves comments for a Xiaohongshu note with pagination.\nThe response includes comment text, publish time, commenter information (when available),\nand other comment metadata.\n\nTypical use cases:\n- Sentiment and public-opinion monitoring based on comment content\n- Tracking comment volume and feedback trends over time\n- Collecting discussions for analytics, reporting, and dataset building\n", + "description": "Get Xiaohongshu (RedNote) note Comments data, including text, authors, and timestamps, for feedback analysis.", "operationId": "getNoteCommentV2", "parameters": [ { @@ -65375,9 +65287,9 @@ "tokenAuth": [] } ], - "summary": "Note Comments (V2)", + "summary": "Note Comments", "tags": [ - "Xiaohongshu" + "Xiaohongshu (RedNote)" ], "x-order": "12001700", "x-sdk-class-name": "XiaohongshuResource", @@ -65387,7 +65299,7 @@ }, "/api/xiaohongshu/get-note-comment/v4": { "get": { - "description": "Retrieves comments for a Xiaohongshu note.\n\nTypical use cases:\n- Quick lookup of the latest/top comments for a note\n- Comment snapshot for lightweight monitoring\n\nHighlights\n- This version only returns the first page of comments; subsequent pages are not available.\n- If you need to fetch more pages, use the Note Comments (V2) endpoint.\n", + "description": "Get Xiaohongshu (RedNote) note Comments data, including comment text, author profiles, and interaction data, for sentiment analysis and community monitoring.", "operationId": "getNoteCommentV4", "parameters": [ { @@ -65863,9 +65775,9 @@ "tokenAuth": [] } ], - "summary": "Note Comments (V4)", + "summary": "Note Comments", "tags": [ - "Xiaohongshu" + "Xiaohongshu (RedNote)" ], "x-order": "12001800", "x-sdk-class-name": "XiaohongshuResource", @@ -65875,7 +65787,7 @@ }, "/api/xiaohongshu/get-note-detail/v1": { "get": { - "description": "Retrieves detailed note data from Xiaohongshu, including the full note description,\nengagement metrics (likes, comments, collects, shares), and media information.\n\nThe response includes media download URLs for images and videos.\n\nTypical use cases:\n- Content analysis and review using full note text\n- Engagement tracking for creators, campaigns, and competitors\n- Collecting media assets (images/videos) for downstream processing or archiving\n- Building datasets for analytics, reporting, and automation\n", + "description": "Get Xiaohongshu (RedNote) note Details data, including media and engagement metrics, for content analysis, archiving, and campaign research.", "operationId": "getNoteDetailV1", "parameters": [ { @@ -66275,9 +66187,9 @@ "tokenAuth": [] } ], - "summary": "Note Details (V1)", + "summary": "Note Details", "tags": [ - "Xiaohongshu" + "Xiaohongshu (RedNote)" ], "x-order": "12001400", "x-sdk-class-name": "XiaohongshuResource", @@ -66288,7 +66200,7 @@ "/api/xiaohongshu/get-note-detail/v3": { "get": { "deprecated": true, - "description": "Retrieves detailed note data from Xiaohongshu, including the full note description,\nengagement metrics (likes, comments, collects, shares), and media information.\n\nThe response includes media download URLs for images and videos.\n\nTypical use cases:\n- Content analysis and review using full note text\n- Engagement tracking for creators, campaigns, and competitors\n- Collecting media assets (images/videos) for downstream processing or archiving\n- Building datasets for analytics, reporting, and automation\n", + "description": "Get Xiaohongshu (RedNote) note Details data, including media and engagement metrics, for content analysis, archiving, and campaign research.", "operationId": "getNoteDetailV3", "parameters": [ { @@ -66729,9 +66641,9 @@ "tokenAuth": [] } ], - "summary": "Note Details (V3)", + "summary": "Note Details", "tags": [ - "Xiaohongshu" + "Xiaohongshu (RedNote)" ], "x-order": "12001500", "x-sdk-class-name": "XiaohongshuResource", @@ -66742,7 +66654,7 @@ "/api/xiaohongshu/get-note-detail/v7": { "get": { "deprecated": true, - "description": "Retrieves detailed note data from Xiaohongshu, including the full note description,\nengagement metrics (likes, comments, collects, shares), and media information.\n\nThe response includes media download URLs for images and videos.\n\nTypical use cases:\n- Content analysis and review using full note text\n- Engagement tracking for creators, campaigns, and competitors\n- Collecting media assets (images/videos) for downstream processing or archiving\n- Building datasets for analytics, reporting, and automation\n", + "description": "Get Xiaohongshu (RedNote) note Details data, including media and engagement metrics, for content analysis, archiving, and campaign research.", "operationId": "getNoteDetailV7", "parameters": [ { @@ -67209,9 +67121,9 @@ "tokenAuth": [] } ], - "summary": "Note Details (V7)", + "summary": "Note Details", "tags": [ - "Xiaohongshu" + "Xiaohongshu (RedNote)" ], "x-order": "12001600", "x-sdk-class-name": "XiaohongshuResource", @@ -67221,7 +67133,7 @@ }, "/api/xiaohongshu/get-note-sub-comment/v2": { "get": { - "description": "Retrieves replies under a specific Xiaohongshu comment (also known as second-level comments),\nwith pagination when supported. The response includes reply text, publish time, replier information\n(when available), and other metadata.\n\nTypical use cases:\n- Deep sentiment analysis by including comment threads\n- Monitoring discussions under key comments\n- Collecting reply threads for analytics, reporting, and dataset building\n", + "description": "Get Xiaohongshu (RedNote) comment Replies data, including text, authors, and timestamps, for thread analysis and feedback research.", "operationId": "getNoteSubCommentV2", "parameters": [ { @@ -67548,9 +67460,9 @@ "tokenAuth": [] } ], - "summary": "Comment Replies (V2)", + "summary": "Comment Replies", "tags": [ - "Xiaohongshu" + "Xiaohongshu (RedNote)" ], "x-order": "12001900", "x-sdk-class-name": "XiaohongshuResource", @@ -67561,7 +67473,7 @@ "/api/xiaohongshu/get-user-note-list/v2": { "get": { "deprecated": true, - "description": "Retrieves a paginated list of notes published by a specific Xiaohongshu user.\nEach page returns basic note data (e.g., note ID, title/text snippet, publish time, cover/media info when available)\nand may include engagement counters depending on availability.\n\nTypical use cases:\n- Building a creator's content timeline and monitoring new posts\n- Batch collection for analytics, reporting, and dataset building\n- Creator/KOL and competitor monitoring\n", + "description": "Get Xiaohongshu (RedNote) user Published Notes data, including note metadata, covers, and publish times, for account monitoring.", "operationId": "getUserNoteListV2", "parameters": [ { @@ -67607,9 +67519,9 @@ "tokenAuth": [] } ], - "summary": "User Published Notes (V2)", + "summary": "User Published Notes", "tags": [ - "Xiaohongshu" + "Xiaohongshu (RedNote)" ], "x-order": "12001200", "x-sdk-class-name": "XiaohongshuResource", @@ -67619,7 +67531,7 @@ }, "/api/xiaohongshu/get-user-note-list/v4": { "get": { - "description": "Retrieves a paginated list of notes published by a specific Xiaohongshu user.\nEach page returns basic note data (e.g., note ID, title/text snippet, publish time, cover/media info when available)\nand may include engagement counters depending on availability.\n\nTypical use cases:\n- Building a creator's content timeline and monitoring new posts\n- Batch collection for analytics, reporting, and dataset building\n- Creator/KOL and competitor monitoring\n", + "description": "Get Xiaohongshu (RedNote) user Published Notes data, including note metadata, covers, and publish times, for account monitoring.", "operationId": "getUserNoteListV4", "parameters": [ { @@ -67730,9 +67642,9 @@ "tokenAuth": [] } ], - "summary": "User Published Notes (V4)", + "summary": "User Published Notes", "tags": [ - "Xiaohongshu" + "Xiaohongshu (RedNote)" ], "x-order": "12001300", "x-sdk-class-name": "XiaohongshuResource", @@ -67742,7 +67654,7 @@ }, "/api/xiaohongshu/get-user/v3": { "get": { - "description": "Retrieves Xiaohongshu user profile data, including user identifiers and profile metadata\n(e.g., nickname, avatar, bio), as well as public counters such as follower count and like count (when available).\n\nTypical use cases:\n- Identifying creators/KOLs and building creator lists\n- Enriching user records for analytics and reporting\n- Creator monitoring (profile and counter changes over time)\n", + "description": "Get Xiaohongshu (RedNote) user Profile data, including follower counts and bio details, for creator research, account analysis, and competitor monitoring.", "operationId": "getUserV3", "parameters": [ { @@ -67936,9 +67848,9 @@ "tokenAuth": [] } ], - "summary": "User Profile (V3)", + "summary": "User Profile", "tags": [ - "Xiaohongshu" + "Xiaohongshu (RedNote)" ], "x-order": "12001000", "x-sdk-class-name": "XiaohongshuResource", @@ -67949,7 +67861,7 @@ "/api/xiaohongshu/get-user/v4": { "get": { "deprecated": true, - "description": "Retrieves Xiaohongshu user profile data, including user identifiers and profile metadata\n(e.g., nickname, avatar, bio), as well as public counters such as follower count and like count (when available).\n\nTypical use cases:\n- Identifying creators/KOLs and building creator lists\n- Enriching user records for analytics and reporting\n- Creator monitoring (profile and counter changes over time)\n", + "description": "Get Xiaohongshu (RedNote) user Profile data, including follower counts and bio details, for creator research, account analysis, and competitor monitoring.", "operationId": "getUserV4", "parameters": [ { @@ -68183,9 +68095,9 @@ "tokenAuth": [] } ], - "summary": "User Profile (V4)", + "summary": "User Profile", "tags": [ - "Xiaohongshu" + "Xiaohongshu (RedNote)" ], "x-order": "12001100", "x-sdk-class-name": "XiaohongshuResource", @@ -68195,7 +68107,7 @@ }, "/api/xiaohongshu/search-note/v2": { "get": { - "description": "Searches Xiaohongshu notes by keyword and optional filters, returning a paginated result set.\nEach result typically includes basic note information (e.g., note ID, title/text snippet, cover/media info),\nauthor signals (when available), and engagement counters (when available).\n\nTypical use cases:\n- Topic/keyword research and trend analysis\n- Discovering notes for monitoring, analytics, and dataset building\n- Campaign and competitor content discovery\n", + "description": "Get Xiaohongshu (RedNote) note Search data, including snippets, authors, and media, for topic discovery.", "operationId": "getSearchNoteV2", "parameters": [ { @@ -68402,9 +68314,9 @@ "tokenAuth": [] } ], - "summary": "Note Search (V2)", + "summary": "Note Search", "tags": [ - "Xiaohongshu" + "Xiaohongshu (RedNote)" ], "x-order": "12002000", "x-sdk-class-name": "XiaohongshuResource", @@ -68415,7 +68327,7 @@ "/api/xiaohongshu/search-note/v3": { "get": { "deprecated": true, - "description": "Searches Xiaohongshu notes by keyword and optional filters, returning a paginated result set.\nEach result typically includes basic note information (e.g., note ID, title/text snippet, cover/media info),\nauthor signals (when available), and engagement counters (when available).\n\nTypical use cases:\n- Topic/keyword research and trend analysis\n- Discovering notes for monitoring, analytics, and dataset building\n- Campaign and competitor content discovery\n", + "description": "Get Xiaohongshu (RedNote) note Search data, including snippets, authors, and media, for topic discovery.", "operationId": "getSearchNoteV3", "parameters": [ { @@ -68493,9 +68405,9 @@ "tokenAuth": [] } ], - "summary": "Note Search (V3)", + "summary": "Note Search", "tags": [ - "Xiaohongshu" + "Xiaohongshu (RedNote)" ], "x-order": "12002100", "x-sdk-class-name": "XiaohongshuResource", @@ -68505,7 +68417,7 @@ }, "/api/xiaohongshu/search-recommend/v1": { "get": { - "description": "Retrieves keyword suggestions for Xiaohongshu search.\nGiven an input keyword prefix, this endpoint returns a list of recommended/related search terms\nthat can be used to refine queries.\n\nTypical use cases:\n- Expanding keyword sets for content research and SEO/pSEO workflows\n- Improving search coverage by using platform-recommended terms\n- Building autocomplete experiences and discovery tools\n", + "description": "Get Xiaohongshu (RedNote) keyword Suggestions data, including suggested queries, keyword variants, and query metadata, for expanding keyword sets for content research and seo/pseo workflows and improving search coverage by using platform-recommended terms.", "operationId": "searchRecommendV1", "parameters": [ { @@ -68796,9 +68708,9 @@ "tokenAuth": [] } ], - "summary": "Search Keyword Suggestions (V1)", + "summary": "Keyword Suggestions", "tags": [ - "Xiaohongshu" + "Xiaohongshu (RedNote)" ], "x-order": "12002500", "x-sdk-class-name": "XiaohongshuResource", @@ -68808,7 +68720,7 @@ }, "/api/xiaohongshu/search-user/v2": { "get": { - "description": "Searches Xiaohongshu users by keyword, returning a paginated result set with basic profile\ninformation (e.g., user ID, nickname, avatar, bio when available) and public counters/signals\n(when available).\n\nTypical use cases:\n- Finding creators/KOLs by niche, brand, or topic keywords\n- Building creator lists for monitoring and analytics\n- Discovering competitor accounts and related profiles\n", + "description": "Get Xiaohongshu (RedNote) user Search data, including profile metadata and public signals, for creator discovery and account research.", "operationId": "getSearchUserV2", "parameters": [ { @@ -69297,9 +69209,9 @@ "tokenAuth": [] } ], - "summary": "User Search (V2)", + "summary": "User Search", "tags": [ - "Xiaohongshu" + "Xiaohongshu (RedNote)" ], "x-order": "12002200", "x-sdk-class-name": "XiaohongshuResource", @@ -69309,7 +69221,7 @@ }, "/api/xiaohongshu/share-url-transfer/v1": { "get": { - "description": "Converts a shared RedNote note short link into a normal (resolved) note URL.\nThis is typically used to extract the note ID from a share link for downstream APIs\n(e.g., Note Details or Note Comments).\n\nTypical use cases:\n- Turning user-provided share links into structured identifiers (note ID)\n- Normalizing links before fetching note details, media, or comments\n- Automating workflows that start from share links\n", + "description": "Get Xiaohongshu (RedNote) share Link Resolution data, including helping extract note IDs, for downstream note and comment workflows.", "operationId": "shareUrlTransferV1", "parameters": [ { @@ -69343,9 +69255,9 @@ "tokenAuth": [] } ], - "summary": "Share Link Convert (V3)", + "summary": "Share Link Resolution", "tags": [ - "Xiaohongshu" + "Xiaohongshu (RedNote)" ], "x-order": "12002400", "x-sdk-class-name": "XiaohongshuResource", @@ -69355,7 +69267,7 @@ }, "/api/youku/get-user-detail/v1": { "get": { - "description": "This API retrieves detailed profile information of a specific Youku creator/user, including user ID, username, avatar, signature/description, follower count, following count, total videos, and verification status.\n\nTypical use cases:\n- Analyzing creator influence and audience size.\n- Monitoring account growth and verification status.\n- Fetching basic user info for social CRM.\n", + "description": "Get YOUKU user Profile data, including user ID, username, and avatar, for analyzing creator influence and audience size, monitoring account growth and verification status, and fetching basic user info for social crm.", "operationId": "getUserDetailV1", "parameters": [ { @@ -69607,9 +69519,9 @@ "tokenAuth": [] } ], - "summary": "User Profile (V1)", + "summary": "User Profile", "tags": [ - "Youku" + "YOUKU" ], "x-order": "23001200", "x-sdk-class-name": "YoukuResource", @@ -69619,7 +69531,7 @@ }, "/api/youku/get-video-detail/v1": { "get": { - "description": "This API retrieves detailed information of a specific Youku video, including video ID, title, description, cover image, duration, tags, play count, like count, publish time, and the video's detail page URL.\n\nTypical use cases:\n- Fetching comprehensive metadata for a single video.\n- Tracking engagement metrics like play counts and likes.\n- Integrating detailed video info into third-party dashboards.\n", + "description": "Get YOUKU video Details data, including video ID, title, and description, for fetching comprehensive metadata for a single video, tracking engagement metrics like play counts and likes, and integrating detailed video info into third-party dashboards.", "operationId": "getVideoDetailV1", "parameters": [ { @@ -69825,9 +69737,9 @@ "tokenAuth": [] } ], - "summary": "Video Details (V1)", + "summary": "Video Details", "tags": [ - "Youku" + "YOUKU" ], "x-order": "23001100", "x-sdk-class-name": "YoukuResource", @@ -69837,7 +69749,7 @@ }, "/api/youku/search-video/v1": { "get": { - "description": "This API performs a keyword-based search on Youku, returning a list of videos that match the search term.\nReturned fields include video ID, title, cover image, duration, play count, publish time, and the video's detail page URL.\n\nTypical use cases:\n- Keyword-based video discovery.\n- Monitoring specific topics or trends on Youku.\n- Analyzing search results for market research.\n", + "description": "Get YOUKU video Search data, including video ID, title, and cover image, for keyword-based video discovery, monitoring specific topics or trends on youku, and analyzing search results for market research.", "operationId": "searchVideoV1", "parameters": [ { @@ -70203,9 +70115,9 @@ "tokenAuth": [] } ], - "summary": "Video Search (V1)", + "summary": "Video Search", "tags": [ - "Youku" + "YOUKU" ], "x-order": "23001000", "x-sdk-class-name": "YoukuResource", @@ -70213,9 +70125,58 @@ "x-sdk-resource": "youku" } }, + "/api/youtube/get-channel-videos/v1": { + "get": { + "description": "Retrieve a list of videos from a specific YouTube channel, providing detailed insights into content performance and upload history.", + "operationId": "getChannelVideosV1", + "parameters": [ + { + "description": "The unique identifier for a YouTube channel.", + "in": "query", + "name": "channelId", + "required": true, + "schema": { + "type": "string" + }, + "x-sdk-python-name": "channel_id" + }, + { + "description": "The cursor for pagination.", + "in": "query", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + }, + "x-sdk-python-name": "cursor" + } + ], + "responses": { + "default": { + "content": { + "application/json": {} + }, + "description": "default response" + } + }, + "security": [ + { + "tokenAuth": [] + } + ], + "summary": "Channel Videos", + "tags": [ + "YouTube" + ], + "x-order": "25001001", + "x-sdk-class-name": "YoutubeResource", + "x-sdk-method-name": "get_channel_videos_v1", + "x-sdk-resource": "youtube" + } + }, "/api/youtube/get-video-detail/v1": { "get": { - "description": "Retrieves detailed metadata for a specific YouTube video, including its title, description,\nview counts, channel information, and media assets.\n\nTypical use cases\n- Tracking video engagement and statistics\n- Extracting video metadata for content analysis\n- Verifying video availability and status\n", + "description": "Get YouTube video Details data, including its title, description, and view counts, for tracking video engagement and statistics, extracting video metadata for content analysis, and verifying video availability and status.", "operationId": "getVideoDetailV1", "parameters": [ { @@ -70274,7 +70235,7 @@ "tokenAuth": [] } ], - "summary": "Video Details (V1)", + "summary": "Video Details", "tags": [ "YouTube" ], @@ -70286,7 +70247,7 @@ }, "/api/zhihu/get-answer-list/v1": { "get": { - "description": "Retrieve the list of answers under a specific Zhihu question by its question ID.\n\nTypical use cases:\n- Analyzing user opinions and extracting high-quality responses.\n- Studying community engagement and topic discussions.\n", + "description": "Get Zhihu answer List data, including answer content, author profiles, and interaction metrics, for question analysis and answer research.", "operationId": "getAnswerListV1", "parameters": [ { @@ -70611,7 +70572,7 @@ "tokenAuth": [] } ], - "summary": "Answer List (V1)", + "summary": "Answer List", "tags": [ "Zhihu" ], @@ -70623,7 +70584,7 @@ }, "/api/zhihu/get-column-article-detail/v1": { "get": { - "description": "Retrieve detailed information for a specific Zhihu Column article by its article ID.\n\nTypical use cases:\n- In-depth content analysis of professional articles.\n- Creator performance evaluation and topic trend monitoring.\n", + "description": "Get Zhihu column Article Details data, including title, author, and content, for article archiving and content research.", "operationId": "getColumnArticleDetailV1", "parameters": [ { @@ -70912,7 +70873,7 @@ "tokenAuth": [] } ], - "summary": "Column Article Details (V1)", + "summary": "Column Article Details", "tags": [ "Zhihu" ], @@ -70924,7 +70885,7 @@ }, "/api/zhihu/get-column-article-list/v1": { "get": { - "description": "Retrieve the list of articles published under a specific Zhihu Column by its column ID.\n\nTypical use cases:\n- Tracking creator output and analyzing column performance.\n- Knowledge aggregation based on specific topics.\n", + "description": "Get Zhihu column Article List data, including article metadata and list ordering, for column monitoring and content collection.", "operationId": "getColumnArticleListV1", "parameters": [ { @@ -71046,7 +71007,7 @@ "tokenAuth": [] } ], - "summary": "Column Article List (V1)", + "summary": "Column Article List", "tags": [ "Zhihu" ], @@ -71058,7 +71019,7 @@ }, "/api/zhihu/search/v1": { "get": { - "description": "Search for Zhihu content (including questions, answers, and articles) by keyword.\n\nTypical use cases:\n- Topic discovery and competitive brand monitoring.\n- Identifying trending discussions and high-value creators.\n", + "description": "Get Zhihu keyword Search data, including matched results, metadata, and ranking signals, for topic discovery and content research.", "operationId": "searchV1", "parameters": [ { @@ -71234,7 +71195,7 @@ "tokenAuth": [] } ], - "summary": "Search (V1)", + "summary": "Keyword Search", "tags": [ "Zhihu" ], @@ -71255,107 +71216,5 @@ "description": "Generated server url", "url": "https://47.117.133.51" } - ], - "tags": [ - { - "description": "IMDb Data Services\n\nMain endpoints:\n- Movie and TV title details (metadata, ratings, cast, plot, awards, box office, etc.)\n- Search functionality (titles, people, etc.)\n- News and charts (top 250, streaming picks, news by category)\n\nTypical use cases:\n- Retrieve comprehensive metadata for specific movies or TV shows using IMDb IDs (tt-prefixed).\n- Search for titles and celebrities with customizable filters.\n- Track trending movies and top-rated content via chart rankings.\n", - "name": "IMDb" - }, - { - "description": "APIs for retrieving content, creator, and engagement data from Xiaohongshu.\n\nMain endpoints\n- Note Details: retrieve a single note/post with text (plain/rich when available), media (images/video),\n publish time, author info, and engagement metrics (when available).\n- User Published Notes: list notes published by a specific user with pagination, useful for creator monitoring\n and building content timelines.\n- Note Search: search notes by keyword and optional filters, returning paginated results for discovery and analysis.\n- User Search: search creators/users by keyword, returning basic profile signals for identification and tracking.\n- Note Comments: retrieve comments for a note with pagination, useful for sentiment and community feedback analysis.\n\nTypical use cases\n- Content research and trend analysis (keywords/topics/hashtags)\n- Creator/KOL monitoring and competitive intelligence\n- Brand reputation and sentiment monitoring based on notes and comments\n- Building datasets for analytics, reporting, and downstream automation\n", - "name": "Xiaohongshu" - }, - { - "description": "APIs for retrieving video content, creator, and engagement data from Douyin (TikTok China).\n\nMain endpoints\n- User Profile: retrieve profile information for a specific Douyin user (nickname, avatar, follower count, etc.).\n- User Published Videos: list videos published by a specific user with pagination, useful for creator monitoring.\n- Video Details: get comprehensive metadata for a single video, including play URL, statistics, and author info.\n- Video Search: search videos by keyword and optional filters (sort, publish time, duration).\n- User Search: search Douyin creators/users by keyword.\n- Video Comments: fetch top-level comments for a video with pagination.\n- Comment Replies: fetch nested replies for a specific top-level comment with paging.\n- Share Link Resolution: convert Douyin short share URLs to structured data.\n\nTypical use cases\n- Content research and trend analysis (keywords/topics/hashtags)\n- Creator/KOL monitoring and competitive intelligence\n- Brand reputation and sentiment monitoring based on videos and comments\n- Building datasets for analytics, reporting, and downstream automation\n", - "name": "Douyin" - }, - { - "description": "TikTok Shop Data Services.\n\nMain endpoints\n- Search Products: search for products on TikTok Shop based on keywords and region.\n- Product Detail: retrieve detailed information for a specific product on TikTok Shop.\n", - "name": "TikTok Shop" - }, - { - "description": "Facebook Data Services.\n\nMain endpoints:\n- Search Posts: Search for public posts using keywords and date ranges.\n\nTypical use cases:\n- Monitoring social media sentiment or trends related to specific topics.\n- Researching public discourse and engagement on Facebook.\n", - "name": "Facebook" - }, - { - "description": "Xiaohongshu Pgy (Pugongying) data services.", - "name": "Xiaohongshu Pgy" - }, - { - "description": "Unified APIs for product data on JD.com.\n\nIncluded endpoints\n- Product Details: retrieve product core information such as title, images, price, SKU/variants, shop info, and status.\n- Product Comments: fetch user reviews/comments with paging, useful for sentiment and public-opinion monitoring.\n\nTypical use cases\n- E-commerce analytics: product/brand/category analysis, trend tracking, and report generation.\n- Price monitoring: scheduled checks for price changes and availability status.\n- Review & sentiment monitoring: track comment volume, rating shifts, and negative/positive feedback signals.\n- Competitor intelligence: monitor competing products and compare pricing and review signals over time.\n", - "name": "JD" - }, - { - "description": "Bilibili API endpoints\n\nMain endpoints:\n- Video Details: Get video metadata, stats, and uploader info.\n- User Profile: Get user profile, videos, and stats.\n- Search: Keyword-based video search.\n- Interactions: Comments, replies, danmaku.\n\nTypical use cases:\n- Tracking video performance and engagement metrics.\n- Analyzing user/creator content and growth.\n- Gathering community feedback and trends.\n", - "name": "Bilibili" - }, - { - "description": "Weixin Official Account (WeChat) API\n\nMain endpoints:\n- User Published Posts: Retrieves posts from a specific official account.\n- Article Engagement Metrics: Retrieves read counts, likes, etc., for an article.\n- Article Comments: Retrieves user comments from an article.\n- Search: Keywords search for accounts and articles.\n- Article Details: Retrieves core metadata for an article.\n\nTypical use cases:\n- Monitoring account-level content and engagement.\n- Analyzing article-level performance metrics.\n- Collecting public community feedback and discussions.\n", - "name": "Weixin" - }, - { - "description": "Youku API for video search, video details, and user profile information.\n\nMain endpoints:\n- Search for videos by keyword.\n- Retrieve detailed metadata for specific videos.\n- Fetch comprehensive profile details for creators and users.\n\nTypical use cases:\n- Content monitoring and keyword-based trend analysis.\n- Data collection for video engagement metrics (play counts, likes).\n- Social media listening and creator influence assessment.\n", - "name": "Youku" - }, - { - "description": "Unified APIs for retrieving metadata and content details from YouTube.\n\nTypical use cases\n- Video monitoring: track view counts, engagement, and metadata changes for specific videos.\n- Content analysis: extract video titles, descriptions, and tags for trend research or content classification.\n- Marketing intelligence: monitor competitor channels or specific promotional content.\n- Media tracking: verify video status, availability, and basic metadata for platform monitoring.\n", - "name": "YouTube" - }, - { - "description": "Zhihu data services.\n\nMain endpoints:\n- Search: Retrieve content based on keywords.\n- Column: Access detailed information and article lists from specific columns.\n- Question/Answer: Fetch answer lists and engagement metrics for specific questions.\n\nTypical use cases:\n- Market research and consumer sentiment analysis.\n- Tracking expert opinions and professional knowledge trends.\n- Monitoring brand or product discussions on a leading knowledge-sharing platform.\n", - "name": "Zhihu" - }, - { - "description": "Douyin Xingtu data services.", - "name": "Douyin Xingtu" - }, - { - "description": "Unified APIs for retrieving data from Instagram, including user profiles, post details, published content, and reels/hashtag searches.\n\nMain endpoints\n- User Profile: Retrieves public profile information of an Instagram user, including follower count, following count, and post count.\n- Post Details: Retrieves detailed information of a public Instagram post by post code, including media content (images/videos) and engagement metrics.\n- User Published Posts: Retrieves a list of public posts published by an Instagram user, with pagination support.\n- Reels & Hashtag Search: Search public Instagram Reels or hashtag-specific posts by keywords or hashtag.\n\nTypical use cases\n- Tracking influencer performance and audience growth.\n- Monitoring trending content through keyword and hashtag searches.\n- Analyzing post engagement metrics for specific accounts or topics.\n", - "name": "Instagram" - }, - { - "description": "Amazon Data Services.\n\nMain endpoints\n- Product Details: retrieve comprehensive product information from Amazon based on the provided ASIN, including basic metadata (title, brand, category), media assets (images), availability, and pricing.\n- Product Top Reviews: retrieve top (most relevant or most helpful) public reviews for an Amazon product, including ratings, content, and Helpful vote counts.\n- Best Sellers: explore top-performing products across various categories on Amazon, including sales rank and popularity indicators.\n\nTypical use cases\n- E-commerce analytics: product/brand/category analysis, trend tracking, and report generation.\n- Price monitoring and availability tracking: scheduled checks for price changes and availability status on Amazon.\n- Review & sentiment monitoring: track consumer feedback and ratings to analyze product performance and customer satisfaction.\n- Competitor intelligence: monitor competing products on Amazon and compare pricing and review signals over time.\n", - "name": "Amazon" - }, - { - "description": "APIs for retrieving video content, creator, and engagement data from Kuaishou.\n\nMain endpoints\n- User Profile: retrieve profile information for a specific Kuaishou user (nickname, avatar, follower count, etc.).\n- User Published Videos: list videos published by a specific user with pagination.\n- Video Details: get comprehensive metadata for a single video, including play URL, statistics, and author info.\n- Video Search: search videos by keyword.\n- User Search: search Kuaishou creators/users by keyword.\n- Video Comments: fetch comments for a video with pagination.\n- Share Link Resolution: convert Kuaishou share URLs to structured data.\n\nTypical use cases\n- Content research and trend analysis\n- Creator/KOL monitoring\n- Brand reputation monitoring\n- Building datasets for analytics\n", - "name": "Kuaishou" - }, - { - "description": "Unified APIs for product data on Taobao and Tmall.\n\nAlthough Taobao and Tmall are separate marketplaces in Alibaba's ecosystem, on this API platform they share the same\nendpoint set and response model. No platform parameter is required — the APIs work in a unified manner across both.\n\nIncluded endpoints\n- Product Details: retrieve product core information such as title, images, price, SKU/variants (if available), shop info, and status.\n- Shop Product List: list products under a shop with pagination/sorting, useful for store monitoring and catalog building.\n- Product Search: search products by keyword/filters, useful for discovery, analysis, and building watchlists.\n- Product Comments: fetch user reviews/comments with paging, useful for sentiment and public-opinion monitoring.\n\nTypical use cases\n- E-commerce analytics: product/brand/category analysis, trend tracking, and report generation.\n- Price monitoring: scheduled checks for price changes, promotions, and availability status.\n- Review & sentiment monitoring: track comment volume, rating shifts, and negative/positive feedback signals.\n- Content enrichment: obtain product media (images) and basic metadata for catalogs or internal systems.\n- Competitor intelligence: monitor competing shops/products and compare pricing and review signals over time.\n", - "name": "Taobao & Tmall" - }, - { - "description": "APIs for Douban movie metadata, reviews, and comments.\n\nMain endpoints:\n- Movie Reviews: Retrieve long-form user reviews for movies.\n- Movie Review Details: Get detailed content of a specific movie review.\n- Movie Comments: Retrieve short user comments for movies.\n\nTypical use cases:\n- Sentiment analysis for film and media content.\n- Academic and market research on audience reception.\n", - "name": "Douban" - }, - { - "description": "APIs for retrieving posts, user profiles, engagement metrics, and trending topics from Weibo.\n\nMain endpoints\n- Keyword Search: search Weibo posts by keywords and time range, returning content and metrics.\n- User Profile: retrieve detailed information for a specified Weibo user.\n- Post Details: get comprehensive metadata for a single Weibo post.\n- User Published Posts: list posts published by a specific user with pagination.\n- User Fans/Followers: retrieve the follower and following lists for a user.\n- TV Video Details: get metadata and media URLs for Weibo TV components.\n- Hot Search: fetch current trending topics on Weibo.\n\nTypical use cases\n- Social media monitoring and brand sentiment analysis\n- Public opinion research and trend tracking\n- Creator and influencer identification and monitoring\n- Gathering public data for research or business intelligence\n", - "name": "Weibo" - }, - { - "description": "Unified search APIs across multiple social media platforms.\n\nIncluded endpoints\n- Unified Search: retrieve social media data from multiple sources (Weibo, Weixin, Douyin, etc.) in a single request.\n\nTypical use cases\n- Multi-platform trend analysis: search for specific keywords across different social media ecosystems.\n- Public opinion monitoring: track hot topics and sentiment shifts on a cross-platform scale.\n", - "name": "Search" - }, - { - "description": "Ke Holdings / Beike (Lianjia) Data API.\n\nMain endpoints:\n- Resale Housing Details: Comprehensive data for second-hand property listings.\n- Resale Housing List: Filterable list of available second-hand properties.\n- Community List: Details and statistics for residential communities (Xiaoqu).\n\nTypical use cases:\n- Property market analysis and valuation.\n- Tracking housing trends and availability in specific regions.\n- Community-level demographic and price research.\n", - "name": "Beike" - }, - { - "description": "TikTok Global Data (Overseas Version).\n\nMain endpoints:\n- User Profiles and published posts (V1).\n- Post details and metadata including engagement metrics (V1).\n- Keyword search for users and posts (V1).\n- Interactive data such as comments and sub-comments (V1).\n\nTypical use cases:\n- Global market analysis and influencer discovery.\n- Content performance tracking on TikTok.\n- Brand sentiment analysis via comment retrieval.\n- Cross-region trend monitoring.\n", - "name": "TikTok" - }, - { - "description": "X (formerly Twitter) Data Services.\n\nMain endpoints:\n- User Details: Retrieve basic profile information and statistics of X users.\n- User Published Posts: Access a user's tweet timeline with pagination support.\n\nTypical use cases:\n- Monitoring user account growth and engagement metrics.\n- Analyzing public tweet history for market research or brand sentiment.\n\nNotes:\n- Only public data is accessible via these endpoints.\n- User Rest ID is required for identifying the target account.\n", - "name": "X(Twitter)" - }, - { - "description": "APIs for retrieving data from Reddit, including post details, comments, and search results.\n\nReddit is a network of communities where people can dive into their interests, hobbies and passions.\nThese APIs allow for systematic extraction of public discussions and content.\n\nIncluded endpoints\n- Post Details: Retrieve comprehensive information about a specific post, including its content and engagement metrics.\n- Post Comments: Fetch the discussion thread for a given post with pagination support.\n- Search: Search for posts across Reddit based on keywords and filters.\n\nTypical use cases\n- Public opinion analysis: Track discussions around specific brands, products, or topics.\n- Market research: Understand community sentiment and emerging trends within specific subreddits.\n- Content aggregation: Collect high-quality community-driven content for research or archival purposes.\n", - "name": "Reddit" - }, - { - "description": "Toutiao (Jinri Toutiao) Data Services.\n\nMain endpoints:\n- Article Details: Retrieve comprehensive metadata and engagement metrics for Toutiao articles.\n- User Profile: Access detailed creator information, including verification status and performance stats.\n- Search: Perform keyword-based content discovery across the Toutiao ecosystem.\n\nTypical use cases:\n- Media monitoring and trend analysis.\n- Creator performance tracking and influencer profiling.\n- Content aggregation and keyword intelligence.\n", - "name": "Toutiao" - } ] }