Skip to content

Commit 5068d4d

Browse files
github-actions[bot]github-actions[bot]
committed
chore: sync OpenAPI spec and generated SDK v3.0.6
# OpenAPI Sync Summary - Paths: 237 -> 298 - Tags: 0 -> 0 - Added operationId count: 65 - Removed operationId count: 4 - Changed operationId count: 63 ## Added operationId - getApiAmazonSearchProductsV1 [GET /api/amazon/search-products/v1] - getApiDewuSearchItemListV1 [GET /api/dewu/search-item-list/v1] - getApiDouyinXingtuGwApiAggregatorGetAuthorContractBaseInfo [GET /api/douyin-xingtu/gw/api/aggregator/get_author_contract_base_info] - getApiDouyinXingtuGwApiAggregatorGetAuthorLiveStatisticsV1 [GET /api/douyin-xingtu/gw/api/aggregator/get_author_live_statistics/v1] - getApiDouyinXingtuGwApiAggregatorGetAuthorLiveWatchDistributionV1 [GET /api/douyin-xingtu/gw/api/aggregator/get_author_live_watch_distribution/v1] - getApiDouyinHotSearchV1 [GET /api/douyin/hot-search/v1] - getApiJdGetItemCommentsV2 [GET /api/jd/get-item-comments/v2] - getApiJdGetItemDetailV3 [GET /api/jd/get-item-detail/v3] - getApiJdSearchItemListV2 [GET /api/jd/search-item-list/v2] - getApiTaobaoGetShopItemListV4 [GET /api/taobao/get-shop-item-list/v4] - getApiTaobaoGetSocialFeedV1 [GET /api/taobao/get-social-feed/v1] - getApiTwitterSearchV1 [GET /api/twitter/search/v1] - getApiWeixinChannelsConvertExportIdV1 [GET /api/weixin-channels/convert-export-id/v1] - getApiWeixinChannelsGetBoundChannelV1 [GET /api/weixin-channels/get-bound-channel/v1] - getApiWeixinChannelsGetVideoBasicInfoV1 [GET /api/weixin-channels/get-video-basic-info/v1] - getApiWeixinChannelsGetVideoDownloadUrlV1 [GET /api/weixin-channels/get-video-download-url/v1] - getApiWeixinChannelsGetVideoTitleV1 [GET /api/weixin-channels/get-video-title/v1] - getApiWeixinConvertArticleLinkV1 [GET /api/weixin/convert-article-link/v1] - getApiWeixinGetAccountBasicInfoV1 [GET /api/weixin/get-account-basic-info/v1] - getApiWeixinGetAccountOriginalCountV1 [GET /api/weixin/get-account-original-count/v1] - getApiWeixinGetAccountPrincipalInfoV1 [GET /api/weixin/get-account-principal-info/v1] - getApiWeixinGetAccountTodayArticlesV1 [GET /api/weixin/get-account-today-articles/v1] - getApiWeixinGetArticleDetailV2 [GET /api/weixin/get-article-detail/v2] - getApiWeixinGetArticleDetailV3 [GET /api/weixin/get-article-detail/v3] - getApiWeixinGetArticleDetailV4 [GET /api/weixin/get-article-detail/v4] - getApiWeixinGetArticleDetailV5 [GET /api/weixin/get-article-detail/v5] - getApiWeixinGetArticleMetricsV1 [GET /api/weixin/get-article-metrics/v1] - getApiWeixinGetArticleMetricsV2 [GET /api/weixin/get-article-metrics/v2] - getApiWeixinGetArticleSubCommentV1 [GET /api/weixin/get-article-sub-comment/v1] - getApiWeixinSearchArticleHotV1 [GET /api/weixin/search-article-hot/v1] - getApiWeixinSearchSuggestionsV1 [GET /api/weixin/search-suggestions/v1] - getApiWeixinSearchWechatIndexV1 [GET /api/weixin/search-wechat-index/v1] - getApiXianyuGetItemDetailV1 [GET /api/xianyu/get-item-detail/v1] - getApiXianyuSearchItemListV1 [GET /api/xianyu/search-item-list/v1] - getApiXiaohongshuGetUserNoteListV1 [GET /api/xiaohongshu/get-user-note-list/v1] - getApiXiaohongshuGetUserNoteListV3 [GET /api/xiaohongshu/get-user-note-list/v3] - getApiXiaohongshuSearchNoteV1 [GET /api/xiaohongshu/search-note/v1] - getApiYoutubeGetVideoCaptionsV1 [GET /api/youtube/get-video-captions/v1] - getApiYoutubeSearchV1 [GET /api/youtube/search/v1] - getApiZhihuGetUserArticlesV1 [GET /api/zhihu/get-user-articles/v1] - getApiZhihuGetUserFollowCollectionsV1 [GET /api/zhihu/get-user-follow-collections/v1] - getApiZhihuGetUserFollowColumnsV1 [GET /api/zhihu/get-user-follow-columns/v1] - getApiZhihuGetUserFollowQuestionsV1 [GET /api/zhihu/get-user-follow-questions/v1] - getApiZhihuGetUserFollowTopicsV1 [GET /api/zhihu/get-user-follow-topics/v1] - getApiZhihuGetUserFolloweesV1 [GET /api/zhihu/get-user-followees/v1] - getApiZhihuGetUserFollowersV1 [GET /api/zhihu/get-user-followers/v1] - getApiZhihuGetUserIncludedArticlesV1 [GET /api/zhihu/get-user-included-articles/v1] - getApiZhihuGetUserInfoV1 [GET /api/zhihu/get-user-info/v1] - postApiWeixinChannelsGetAccountVideosV1 [POST /api/weixin-channels/get-account-videos/v1] - postApiWeixinChannelsGetVideoCommentV1 [POST /api/weixin-channels/get-video-comment/v1] - postApiWeixinChannelsGetVideoMetricsV1 [POST /api/weixin-channels/get-video-metrics/v1] - postApiWeixinChannelsGetVideoSubCommentV1 [POST /api/weixin-channels/get-video-sub-comment/v1] - postApiWeixinChannelsSearchAccountV1 [POST /api/weixin-channels/search-account/v1] - postApiWeixinChannelsSearchAccountV2 [POST /api/weixin-channels/search-account/v2] - postApiWeixinChannelsSearchAccountV3 [POST /api/weixin-channels/search-account/v3] - postApiWeixinChannelsSearchVideoV1 [POST /api/weixin-channels/search-video/v1] - postApiWeixinChannelsSearchVideoV2 [POST /api/weixin-channels/search-video/v2] - postApiWeixinGetAccountHistoryArticlesV1 [POST /api/weixin/get-account-history-articles/v1] - postApiWeixinGetAccountHistoryArticlesV2 [POST /api/weixin/get-account-history-articles/v2] - postApiWeixinGetArticleCommentV1 [POST /api/weixin/get-article-comment/v1] - postApiWeixinSearchAccountV1 [POST /api/weixin/search-account/v1] - postApiWeixinSearchAccountV2 [POST /api/weixin/search-account/v2] - postApiWeixinSearchArticleV1 [POST /api/weixin/search-article/v1] - postApiWeixinSearchArticleV2 [POST /api/weixin/search-article/v2] - postApiWeixinSearchMiniprogramV1 [POST /api/weixin/search-miniprogram/v1] ## Removed operationId - getApiWeixinGetArticleCommentV1 [GET /api/weixin/get-article-comment/v1] - getApiWeixinGetArticleFeedbackV1 [GET /api/weixin/get-article-feedback/v1] - getApiWeixinGetUserPostV1 [GET /api/weixin/get-user-post/v1] - getApiWeixinSearchV1 [GET /api/weixin/search/v1] ## Changed operationId - getApi1688GetItemDetailV1 [GET /api/1688/get-item-detail/v1] - getApi1688SearchItemListV1 [GET /api/1688/search-item-list/v1] - getApiAmazonGetBestSellersV1 [GET /api/amazon/get-best-sellers/v1] - getApiBeikeCommunityListV1 [GET /api/beike/community/list/v1] - getApiBeikeErshoufangDetailV1 [GET /api/beike/ershoufang/detail/v1] - getApiBeikeGetErshoufangListV1 [GET /api/beike/get-ershoufang-list/v1] - getApiDouyinEcGetItemDetailV1 [GET /api/douyin-ec/get-item-detail/v1] - getApiDouyinXingtuGetAuthorCommerceSeedBaseInfoV1 [GET /api/douyin-xingtu/get-author-commerce-seed-base-info/v1] - getApiDouyinXingtuGetAuthorCommerceSpreadInfoV1 [GET /api/douyin-xingtu/get-author-commerce-spread-info/v1] - getApiDouyinXingtuGetAuthorContentHotKeywordsV1 [GET /api/douyin-xingtu/get-author-content-hot-keywords/v1] - getApiDouyinXingtuGetAuthorHotCommentTokensV1 [GET /api/douyin-xingtu/get-author-hot-comment-tokens/v1] - getApiDouyinXingtuGetKolAudienceDistributionV1 [GET /api/douyin-xingtu/get-kol-audience-distribution/v1] - getApiDouyinXingtuGetKolConvertAbilityV1 [GET /api/douyin-xingtu/get-kol-convert-ability/v1] - getApiDouyinXingtuGetKolConvertVideosOrProductsV1 [GET /api/douyin-xingtu/get-kol-convert-videos-or-products/v1] - getApiDouyinXingtuGetKolCpInfoV1 [GET /api/douyin-xingtu/get-kol-cp-info/v1] - getApiDouyinXingtuGetKolDailyFansV1 [GET /api/douyin-xingtu/get-kol-daily-fans/v1] - getApiDouyinXingtuGetKolFansDistributionV1 [GET /api/douyin-xingtu/get-kol-fans-distribution/v1] - getApiDouyinXingtuGetKolInfoV1 [GET /api/douyin-xingtu/get-kol-info/v1] - getApiDouyinXingtuGetKolLinkInfoV1 [GET /api/douyin-xingtu/get-kol-link-info/v1] - getApiDouyinXingtuGetKolLinkStructV1 [GET /api/douyin-xingtu/get-kol-link-struct/v1] - getApiDouyinXingtuGetKolMarketingInfoV1 [GET /api/douyin-xingtu/get-kol-marketing-info/v1] - getApiDouyinXingtuGetKolRecVideosV1 [GET /api/douyin-xingtu/get-kol-rec-videos/v1] - getApiDouyinXingtuGetKolShowItemsV2V1 [GET /api/douyin-xingtu/get-kol-show-items-v2/v1] - getApiDouyinXingtuGetKolSpreadInfoV1 [GET /api/douyin-xingtu/get-kol-spread-info/v1] - getApiDouyinXingtuGetKolTouchDistributionV1 [GET /api/douyin-xingtu/get-kol-touch-distribution/v1] - getApiDouyinXingtuGetVideoDetailV1 [GET /api/douyin-xingtu/get-video-detail/v1] - getApiDouyinXingtuGwApiAggregatorGetAuthorCommerceSeedBaseInfoV1 [GET /api/douyin-xingtu/gw/api/aggregator/get_author_commerce_seed_base_info/v1] - getApiDouyinXingtuGwApiAggregatorGetAuthorCommerceSpreadInfoV1 [GET /api/douyin-xingtu/gw/api/aggregator/get_author_commerce_spread_info/v1] - getApiDouyinXingtuGwApiAggregatorGetAuthorSideBaseInfoV1 [GET /api/douyin-xingtu/gw/api/aggregator/get_author_side_base_info/v1] - getApiDouyinXingtuGwApiAuthorGetAuthorBaseInfoV1 [GET /api/douyin-xingtu/gw/api/author/get_author_base_info/v1] - getApiDouyinXingtuGwApiDataGetAuthorHotCommentTokensV1 [GET /api/douyin-xingtu/gw/api/data/get_author_hot_comment_tokens/v1] - getApiDouyinXingtuGwApiDataSpItemReportDetailV1 [GET /api/douyin-xingtu/gw/api/data_sp/item_report_detail/v1] - getApiDouyinXingtuGwApiGauthorGetAuthorContentHotKeywordsV1 [GET /api/douyin-xingtu/gw/api/gauthor/get_author_content_hot_keywords/v1] - getApiDouyinXingtuGwApiGsearchSearchForAuthorSquareV1 [GET /api/douyin-xingtu/gw/api/gsearch/search_for_author_square/v1] - getApiDouyinXingtuSearchKolSimpleV1 [GET /api/douyin-xingtu/search-kol-simple/v1] - getApiJdGetItemDetailV2 [GET /api/jd/get-item-detail/v2] - getApiTaobaoGetItemDetailV2 [GET /api/taobao/get-item-detail/v2] - getApiToutiaoSearchV1 [GET /api/toutiao/search/v1] - getApiWeixinGetArticleDetailV1 [GET /api/weixin/get-article-detail/v1] - getApiXiaohongshuPgyApiSolarCooperatorBloggerV2V1 [GET /api/xiaohongshu-pgy/api/solar/cooperator/blogger/v2/v1] - getApiXiaohongshuPgyApiSolarKolDataV2NotesDetailV1 [GET /api/xiaohongshu-pgy/api/solar/kol/dataV2/notesDetail/v1] - getApiXiaohongshuPgyGetKolCoreDataV1 [GET /api/xiaohongshu-pgy/get-kol-core-data/v1] - getApiXiaohongshuPgyGetKolCostEffectiveV1 [GET /api/xiaohongshu-pgy/get-kol-cost-effective/v1] - getApiXiaohongshuPgyGetKolDataSummaryV2 [GET /api/xiaohongshu-pgy/get-kol-data-summary/v2] - getApiXiaohongshuPgyGetKolFansPortraitV1 [GET /api/xiaohongshu-pgy/get-kol-fans-portrait/v1] - getApiXiaohongshuPgyGetKolFansSummaryV1 [GET /api/xiaohongshu-pgy/get-kol-fans-summary/v1] - getApiXiaohongshuPgyGetKolFansTrendV1 [GET /api/xiaohongshu-pgy/get-kol-fans-trend/v1] - getApiXiaohongshuPgyGetKolInfoV1 [GET /api/xiaohongshu-pgy/get-kol-info/v1] - getApiXiaohongshuPgyGetKolNoteListV1 [GET /api/xiaohongshu-pgy/get-kol-note-list/v1] - getApiXiaohongshuPgyGetKolNoteRateV1 [GET /api/xiaohongshu-pgy/get-kol-note-rate/v1] - getApiXiaohongshuPgyGetNoteDetailV1 [GET /api/xiaohongshu-pgy/get-note-detail/v1] - getApiXiaohongshuGetNoteCommentV2 [GET /api/xiaohongshu/get-note-comment/v2] - getApiXiaohongshuGetNoteCommentV3 [GET /api/xiaohongshu/get-note-comment/v3] - getApiXiaohongshuGetNoteCommentV4 [GET /api/xiaohongshu/get-note-comment/v4] - getApiXiaohongshuGetNoteDetailV2 [GET /api/xiaohongshu/get-note-detail/v2] - getApiXiaohongshuGetNoteDetailV3 [GET /api/xiaohongshu/get-note-detail/v3] - getApiXiaohongshuGetNoteDetailV4 [GET /api/xiaohongshu/get-note-detail/v4] - getApiXiaohongshuGetNoteDetailV7 [GET /api/xiaohongshu/get-note-detail/v7] - getApiXiaohongshuGetUserNoteListV2 [GET /api/xiaohongshu/get-user-note-list/v2] - getApiXiaohongshuGetUserV4 [GET /api/xiaohongshu/get-user/v4] - getApiXiaohongshuSearchNoteV2 [GET /api/xiaohongshu/search-note/v2] - getApiXiaohongshuSearchNoteV3 [GET /api/xiaohongshu/search-note/v3] - getApiXiaohongshuSearchNoteV4 [GET /api/xiaohongshu/search-note/v4]
1 parent 2a94549 commit 5068d4d

19 files changed

Lines changed: 14156 additions & 4076 deletions

‎justoneapi/_version.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = "3.0.5"
1+
__version__ = "3.0.6"

‎justoneapi/generated/models.py‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,16 @@ class Code(Enum):
1919
field_302 = "302"
2020
field_303 = "303"
2121
field_400 = "400"
22+
field_404 = "404"
2223
field_500 = "500"
2324
field_600 = "600"
2425
field_601 = "601"
26+
field_602 = "602"
2527

2628

2729
class Result(BaseModel):
2830
code: Code | None = None
2931
data: dict[str, Any] | None = None
3032
message: str | None = None
3133
recordTime: AwareDatetime | None = None
34+
requestId: str | None = None

‎justoneapi/generated/resources/__init__.py‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
from justoneapi.generated.resources.amazon import AmazonResource
44
from justoneapi.generated.resources.beike import BeikeResource
55
from justoneapi.generated.resources.bilibili import BilibiliResource
6+
from justoneapi.generated.resources.dewu import DewuResource
67
from justoneapi.generated.resources.douban import DoubanResource
78
from justoneapi.generated.resources.douyin import DouyinResource
89
from justoneapi.generated.resources.douyin_ec import DouyinEcResource
@@ -24,6 +25,8 @@
2425
from justoneapi.generated.resources.web import WebResource
2526
from justoneapi.generated.resources.weibo import WeiboResource
2627
from justoneapi.generated.resources.weixin import WeixinResource
28+
from justoneapi.generated.resources.weixin_channels import WeixinChannelsResource
29+
from justoneapi.generated.resources.xianyu import XianyuResource
2730
from justoneapi.generated.resources.xiaohongshu import XiaohongshuResource
2831
from justoneapi.generated.resources.xiaohongshu_pgy import XiaohongshuPgyResource
2932
from justoneapi.generated.resources.youku import YoukuResource
@@ -34,6 +37,7 @@
3437
"amazon": AmazonResource,
3538
"beike": BeikeResource,
3639
"bilibili": BilibiliResource,
40+
"dewu": DewuResource,
3741
"douban": DoubanResource,
3842
"douyin": DouyinResource,
3943
"douyin_ec": DouyinEcResource,
@@ -55,6 +59,8 @@
5559
"web": WebResource,
5660
"weibo": WeiboResource,
5761
"weixin": WeixinResource,
62+
"weixin_channels": WeixinChannelsResource,
63+
"xianyu": XianyuResource,
5864
"xiaohongshu": XiaohongshuResource,
5965
"xiaohongshu_pgy": XiaohongshuPgyResource,
6066
"youku": YoukuResource,
@@ -66,6 +72,7 @@
6672
"AmazonResource",
6773
"BeikeResource",
6874
"BilibiliResource",
75+
"DewuResource",
6976
"DoubanResource",
7077
"DouyinResource",
7178
"DouyinEcResource",
@@ -87,6 +94,8 @@
8794
"WebResource",
8895
"WeiboResource",
8996
"WeixinResource",
97+
"WeixinChannelsResource",
98+
"XianyuResource",
9099
"XiaohongshuResource",
91100
"XiaohongshuPgyResource",
92101
"YoukuResource",

‎justoneapi/generated/resources/amazon.py‎

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,44 @@
99
class AmazonResource(BaseResource):
1010
"""Generated resource for Amazon."""
1111

12+
def search_products_v1(
13+
self,
14+
*,
15+
keyword: str,
16+
country: str | None = "US",
17+
sort_by: str | None = "RELEVANCE",
18+
product_condition: str | None = "ALL",
19+
is_prime: bool | None = False,
20+
deals_and_discounts: str | None = "NONE",
21+
page: int | None = 1,
22+
) -> ApiResponse[Any]:
23+
"""
24+
Product Search
25+
26+
Search Amazon product listings by keyword or ASIN, including title, price, rating, Prime signals, product photos, delivery details, and pagination metadata for discovery, catalog enrichment, market research, price monitoring, and competitor analysis.
27+
28+
Args:
29+
keyword: Search keyword or ASIN to find Amazon products.
30+
country: Country code for the Amazon marketplace. Available Values: - `US`: United States - `AU`: Australia - `BR`: Brazil - `CA`: Canada - `CN`: China - `FR`: France - `DE`: Germany - `IN`: India - `IT`: Italy - `MX`: Mexico - `NL`: Netherlands - `SG`: Singapore - `ES`: Spain - `TR`: Turkey - `AE`: United Arab Emirates - `GB`: United Kingdom - `JP`: Japan - `SA`: Saudi Arabia - `PL`: Poland - `SE`: Sweden - `BE`: Belgium - `EG`: Egypt - `ZA`: South Africa - `IE`: Ireland
31+
sort_by: Sort order for Amazon product search results. Available Values: - `RELEVANCE`: Relevance - `LOWEST_PRICE`: Lowest Price - `HIGHEST_PRICE`: Highest Price - `REVIEWS`: Reviews - `NEWEST`: Newest - `BEST_SELLERS`: Best Sellers
32+
product_condition: Product condition filter for Amazon search results. Available Values: - `ALL`: All product conditions - `NEW`: New products - `USED`: Used products - `RENEWED`: Renewed products - `COLLECTIBLE`: Collectible products
33+
is_prime: Whether to return only Prime-eligible products.
34+
deals_and_discounts: Deals and discounts filter for Amazon search results. Available Values: - `NONE`: Do not filter by deals or discounts - `ALL_DISCOUNTS`: Return discounted products - `TODAYS_DEALS`: Return today's deals
35+
page: Page number for pagination.
36+
"""
37+
return self._get(
38+
"/api/amazon/search-products/v1",
39+
{
40+
"keyword": keyword,
41+
"country": country,
42+
"sortBy": sort_by,
43+
"productCondition": product_condition,
44+
"isPrime": is_prime,
45+
"dealsAndDiscounts": deals_and_discounts,
46+
"page": page,
47+
},
48+
)
49+
1250
def get_product_detail_v1(
1351
self,
1452
*,
@@ -68,7 +106,7 @@ def get_best_sellers_v1(
68106
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.
69107
70108
Args:
71-
category: Best sellers category to return products for (e.g. 'baby-products' or 'baby-products/166777011'). The value is derived from the URL path of the Amazon Best Sellers page, such as: https://www.amazon.com/Best-Sellers-Baby-Baby-Toddler-Feeding-Supplies/zgbs/baby-products/166777011
109+
category: Best sellers category path, for example 'baby-products' or 'baby-products/166777011', from an Amazon Best Sellers URL.
72110
country: Country code for the Amazon product. Available Values: - `US`: United States - `AU`: Australia - `BR`: Brazil - `CA`: Canada - `CN`: China - `FR`: France - `DE`: Germany - `IN`: India - `IT`: Italy - `MX`: Mexico - `NL`: Netherlands - `SG`: Singapore - `ES`: Spain - `TR`: Turkey - `AE`: United Arab Emirates - `GB`: United Kingdom - `JP`: Japan - `SA`: Saudi Arabia - `PL`: Poland - `SE`: Sweden - `BE`: Belgium - `EG`: Egypt - `ZA`: South Africa - `IE`: Ireland
73111
page: Page number for pagination.
74112
"""

‎justoneapi/generated/resources/dewu.py‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
from __future__ import annotations
2+
3+
from typing import Any
4+
5+
from justoneapi._resource import BaseResource
6+
from justoneapi._response import ApiResponse
7+
8+
9+
class DewuResource(BaseResource):
10+
"""Generated resource for Dewu (Poizon)."""
11+
12+
def search_item_list_v1(
13+
self,
14+
*,
15+
keyword: str,
16+
page: str | None = None,
17+
) -> ApiResponse[Any]:
18+
"""
19+
Product Search
20+
21+
Get Dewu (Poizon) product search results by keyword, including matched product data and pagination results, for product discovery, catalog research, price monitoring, and ecommerce market analysis.
22+
23+
Args:
24+
keyword: Search keyword.
25+
page: Page number for pagination. The first page is 1.
26+
"""
27+
return self._get(
28+
"/api/dewu/search-item-list/v1",
29+
{
30+
"keyword": keyword,
31+
"page": page,
32+
},
33+
)

‎justoneapi/generated/resources/douyin.py‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,68 @@ def search_video_v4(
4444
},
4545
)
4646

47+
def hot_search_v1(
48+
self,
49+
*,
50+
keyword: str | None = None,
51+
content_type: str | None = "ALL",
52+
video_type: str | None = "ALL",
53+
sort_type: str | None = "COMPREHENSIVE",
54+
page: int | None = 1,
55+
like_count_min: int | None = None,
56+
like_count_max: int | None = None,
57+
comment_count_min: int | None = None,
58+
comment_count_max: int | None = None,
59+
share_count_min: int | None = None,
60+
share_count_max: int | None = None,
61+
interaction_count_min: int | None = None,
62+
interaction_count_max: int | None = None,
63+
follower_count_min: int | None = None,
64+
follower_count_max: int | None = None,
65+
) -> ApiResponse[Any]:
66+
"""
67+
Hot Search
68+
69+
Get Douyin (TikTok China) hot content Search data, including ranked content items, creator signals, engagement metrics, enriched video metadata, and pagination, for trend discovery, content research, and campaign planning.
70+
71+
Args:
72+
keyword: Optional search keyword.
73+
content_type: Top-level content type. Only one content type can be selected. Available Values: - `ALL`: All content types. - `FASHION`: Fashion. - `TECHNOLOGY`: Technology. - `SCIENCE`: Science. - `PHOTOGRAPHY`: Photography and videography. - `FOOD`: Food. - `MOTHER_BABY`: Mother and baby. - `PARENTING`: Parenting. - `DRAMA`: Drama. - `GAME`: Game. - `AUTOMOTIVE`: Automotive. - `ANIMAL`: Animal. - `TRAVEL`: Travel. - `DANCE`: Dance. - `TRADITIONAL_CULTURE`: Traditional culture. - `ART`: Art. - `SPORTS`: Sports. - `MUSIC`: Music. - `LIFE_RECORD`: Life records. - `HOME_LIVING`: Home and living. - `LEISURE_ENTERTAINMENT`: Leisure entertainment. - `WORKPLACE`: Workplace. - `AGRICULTURE`: Agriculture. - `CASUAL`: Casual videos. - `ACG`: Animation, comics, and games. - `MOVIE`: Movie. - `TV_SERIES`: TV series. - `VARIETY_SHOW`: Variety show. - `CELEBRITY`: Celebrity. - `HUMANITIES_SOCIAL_SCIENCE`: Humanities and social science. - `EDUCATION_CAMPUS`: Education and campus. - `EMOTION`: Emotion. - `FINANCE`: Finance. - `PUBLIC_WELFARE`: Public welfare.
74+
video_type: Video type filter. Available Values: - `ALL`: All video types. - `XINGTU_VIDEO`: Xingtu commercial videos. - `NATURAL_VIDEO`: Natural videos.
75+
sort_type: Sorting criteria for hot content results. Available Values: - `COMPREHENSIVE`: Comprehensive ranking. - `HIGH_INTERACTION`: Highest interaction count. - `HIGH_LIKE`: Highest like count. - `HIGH_COMMENT`: Highest comment count. - `HIGH_SHARE`: Highest share count.
76+
page: Page number (starting from 1). Page size is fixed at 10.
77+
like_count_min: Minimum raw like count.
78+
like_count_max: Maximum raw like count.
79+
comment_count_min: Minimum raw comment count.
80+
comment_count_max: Maximum raw comment count.
81+
share_count_min: Minimum raw share count.
82+
share_count_max: Maximum raw share count.
83+
interaction_count_min: Minimum raw interaction count.
84+
interaction_count_max: Maximum raw interaction count.
85+
follower_count_min: Minimum raw creator follower count.
86+
follower_count_max: Maximum raw creator follower count.
87+
"""
88+
return self._get(
89+
"/api/douyin/hot-search/v1",
90+
{
91+
"keyword": keyword,
92+
"contentType": content_type,
93+
"videoType": video_type,
94+
"sortType": sort_type,
95+
"page": page,
96+
"likeCountMin": like_count_min,
97+
"likeCountMax": like_count_max,
98+
"commentCountMin": comment_count_min,
99+
"commentCountMax": comment_count_max,
100+
"shareCountMin": share_count_min,
101+
"shareCountMax": share_count_max,
102+
"interactionCountMin": interaction_count_min,
103+
"interactionCountMax": interaction_count_max,
104+
"followerCountMin": follower_count_min,
105+
"followerCountMax": follower_count_max,
106+
},
107+
)
108+
47109
def search_user_v2(
48110
self,
49111
*,

0 commit comments

Comments
 (0)