justoneapi 2.0.2__tar.gz → 3.0.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (60) hide show
  1. {justoneapi-2.0.2 → justoneapi-3.0.0}/PKG-INFO +7 -7
  2. {justoneapi-2.0.2 → justoneapi-3.0.0}/README.md +6 -6
  3. justoneapi-3.0.0/justoneapi/_version.py +1 -0
  4. {justoneapi-2.0.2 → justoneapi-3.0.0}/justoneapi/generated/models.py +1 -0
  5. {justoneapi-2.0.2 → justoneapi-3.0.0}/justoneapi/generated/resources/__init__.py +6 -0
  6. {justoneapi-2.0.2 → justoneapi-3.0.0}/justoneapi/generated/resources/amazon.py +9 -35
  7. {justoneapi-2.0.2 → justoneapi-3.0.0}/justoneapi/generated/resources/beike.py +6 -36
  8. {justoneapi-2.0.2 → justoneapi-3.0.0}/justoneapi/generated/resources/bilibili.py +20 -59
  9. {justoneapi-2.0.2 → justoneapi-3.0.0}/justoneapi/generated/resources/douban.py +14 -38
  10. {justoneapi-2.0.2 → justoneapi-3.0.0}/justoneapi/generated/resources/douyin.py +19 -70
  11. justoneapi-3.0.0/justoneapi/generated/resources/douyin_ec.py +30 -0
  12. {justoneapi-2.0.2 → justoneapi-3.0.0}/justoneapi/generated/resources/douyin_xingtu.py +197 -88
  13. justoneapi-3.0.0/justoneapi/generated/resources/facebook.py +82 -0
  14. {justoneapi-2.0.2 → justoneapi-3.0.0}/justoneapi/generated/resources/imdb.py +57 -114
  15. {justoneapi-2.0.2 → justoneapi-3.0.0}/justoneapi/generated/resources/instagram.py +10 -35
  16. justoneapi-3.0.0/justoneapi/generated/resources/jd.py +76 -0
  17. {justoneapi-2.0.2 → justoneapi-3.0.0}/justoneapi/generated/resources/kuaishou.py +21 -49
  18. {justoneapi-2.0.2 → justoneapi-3.0.0}/justoneapi/generated/resources/reddit.py +6 -32
  19. {justoneapi-2.0.2 → justoneapi-3.0.0}/justoneapi/generated/resources/search.py +3 -14
  20. justoneapi-3.0.0/justoneapi/generated/resources/taobao.py +235 -0
  21. {justoneapi-2.0.2 → justoneapi-3.0.0}/justoneapi/generated/resources/tiktok.py +14 -66
  22. {justoneapi-2.0.2 → justoneapi-3.0.0}/justoneapi/generated/resources/tiktok_shop.py +4 -16
  23. justoneapi-3.0.0/justoneapi/generated/resources/toutiao.py +96 -0
  24. {justoneapi-2.0.2 → justoneapi-3.0.0}/justoneapi/generated/resources/twitter.py +5 -18
  25. justoneapi-3.0.0/justoneapi/generated/resources/web.py +70 -0
  26. {justoneapi-2.0.2 → justoneapi-3.0.0}/justoneapi/generated/resources/weibo.py +49 -68
  27. {justoneapi-2.0.2 → justoneapi-3.0.0}/justoneapi/generated/resources/weixin.py +14 -34
  28. {justoneapi-2.0.2 → justoneapi-3.0.0}/justoneapi/generated/resources/xiaohongshu.py +34 -144
  29. {justoneapi-2.0.2 → justoneapi-3.0.0}/justoneapi/generated/resources/xiaohongshu_pgy.py +52 -61
  30. justoneapi-3.0.0/justoneapi/generated/resources/youku.py +73 -0
  31. justoneapi-3.0.0/justoneapi/generated/resources/youtube.py +53 -0
  32. {justoneapi-2.0.2 → justoneapi-3.0.0}/justoneapi/generated/resources/zhihu.py +8 -24
  33. {justoneapi-2.0.2 → justoneapi-3.0.0}/justoneapi.egg-info/PKG-INFO +7 -7
  34. {justoneapi-2.0.2 → justoneapi-3.0.0}/justoneapi.egg-info/SOURCES.txt +2 -0
  35. {justoneapi-2.0.2 → justoneapi-3.0.0}/tests/test_codegen.py +33 -0
  36. {justoneapi-2.0.2 → justoneapi-3.0.0}/tests/test_generated_surface.py +5 -0
  37. justoneapi-2.0.2/justoneapi/_version.py +0 -1
  38. justoneapi-2.0.2/justoneapi/generated/resources/facebook.py +0 -46
  39. justoneapi-2.0.2/justoneapi/generated/resources/jd.py +0 -98
  40. justoneapi-2.0.2/justoneapi/generated/resources/taobao.py +0 -349
  41. justoneapi-2.0.2/justoneapi/generated/resources/toutiao.py +0 -123
  42. justoneapi-2.0.2/justoneapi/generated/resources/youku.py +0 -89
  43. justoneapi-2.0.2/justoneapi/generated/resources/youtube.py +0 -36
  44. {justoneapi-2.0.2 → justoneapi-3.0.0}/LICENSE +0 -0
  45. {justoneapi-2.0.2 → justoneapi-3.0.0}/justoneapi/__init__.py +0 -0
  46. {justoneapi-2.0.2 → justoneapi-3.0.0}/justoneapi/_exceptions.py +0 -0
  47. {justoneapi-2.0.2 → justoneapi-3.0.0}/justoneapi/_resource.py +0 -0
  48. {justoneapi-2.0.2 → justoneapi-3.0.0}/justoneapi/_response.py +0 -0
  49. {justoneapi-2.0.2 → justoneapi-3.0.0}/justoneapi/_transport.py +0 -0
  50. {justoneapi-2.0.2 → justoneapi-3.0.0}/justoneapi/client.py +0 -0
  51. {justoneapi-2.0.2 → justoneapi-3.0.0}/justoneapi/config.py +0 -0
  52. {justoneapi-2.0.2 → justoneapi-3.0.0}/justoneapi/generated/__init__.py +0 -0
  53. {justoneapi-2.0.2 → justoneapi-3.0.0}/justoneapi/log.py +0 -0
  54. {justoneapi-2.0.2 → justoneapi-3.0.0}/justoneapi.egg-info/dependency_links.txt +0 -0
  55. {justoneapi-2.0.2 → justoneapi-3.0.0}/justoneapi.egg-info/requires.txt +0 -0
  56. {justoneapi-2.0.2 → justoneapi-3.0.0}/justoneapi.egg-info/top_level.txt +0 -0
  57. {justoneapi-2.0.2 → justoneapi-3.0.0}/pyproject.toml +0 -0
  58. {justoneapi-2.0.2 → justoneapi-3.0.0}/setup.cfg +0 -0
  59. {justoneapi-2.0.2 → justoneapi-3.0.0}/tests/test_integration_smoke.py +0 -0
  60. {justoneapi-2.0.2 → justoneapi-3.0.0}/tests/test_runtime.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: justoneapi
3
- Version: 2.0.2
3
+ Version: 3.0.0
4
4
  Summary: OpenAPI-driven Python SDK for Just One API
5
5
  Author-email: Just One API <support@justoneapi.com>
6
6
  Requires-Python: >=3.10
@@ -21,9 +21,9 @@ Dynamic: license-file
21
21
 
22
22
  # Just One API - Python SDK
23
23
 
24
- Official Python SDK for accessing [Just One API](https://justoneapi.com) - a unified data service platform that provides structured data from social media, e-commerce, and content platforms.
24
+ Official Python SDK for accessing [Just One API](https://justoneapi.com/en?utm_source=github.com&utm_medium=referral&utm_campaign=justoneapi_justoneapi_python&utm_content=repo_readme) - a unified data service platform that provides structured data from social media, e-commerce, and content platforms.
25
25
 
26
- Supported platforms include Taobao & Tmall, Xiaohongshu, Xiaohongshu Pugongying, Douyin, Douyin Xingtu, Kuaishou, Weibo, Bilibili, JD, WeChat, Douban, TikTok, TikTok Shop, Youku, Instagram, YouTube, Reddit, Toutiao, Zhihu, Amazon, Facebook, X (Twitter), Beike, IMDb, and more. To explore the full API catalog, visit the [official website](https://justoneapi.com).
26
+ Supported platforms include Taobao & Tmall, Xiaohongshu, Xiaohongshu Pugongying, Douyin, Douyin Xingtu, Kuaishou, Weibo, Bilibili, JD, WeChat, Douban, TikTok, TikTok Shop, Youku, Instagram, YouTube, Reddit, Toutiao, Zhihu, Amazon, Facebook, X (Twitter), Beike, IMDb, and more. To explore the full API catalog, visit the [official website]([https://justoneapi.com](https://justoneapi.com/en?utm_source=github.com&utm_medium=referral&utm_campaign=justoneapi_justoneapi_python&utm_content=repo_readme)).
27
27
 
28
28
  ## Installation
29
29
 
@@ -86,13 +86,13 @@ All API requests require a valid API token.
86
86
 
87
87
  Register here:
88
88
 
89
- - [Get API Token](https://dashboard.justoneapi.com/en/register)
89
+ - [Get API Token](https://dashboard.justoneapi.com/en/login?utm_source=github.com&utm_medium=referral&utm_campaign=justoneapi_justoneapi_python&utm_content=repo_readme)
90
90
 
91
91
  ## Documentation
92
92
 
93
93
  Full API documentation:
94
94
 
95
- - [API Documentation](https://docs.justoneapi.com/en)
95
+ - [API Documentation](https://docs.justoneapi.com/en?utm_source=github.com&utm_medium=referral&utm_campaign=justoneapi_justoneapi_python&utm_content=repo_readme)
96
96
 
97
97
  The documentation includes:
98
98
 
@@ -103,13 +103,13 @@ The documentation includes:
103
103
 
104
104
  ## Official Website
105
105
 
106
- - [Home Page](https://justoneapi.com)
106
+ - [Home Page](https://justoneapi.com/en?utm_source=github.com&utm_medium=referral&utm_campaign=justoneapi_justoneapi_python&utm_content=repo_readme)
107
107
 
108
108
  ## Contact
109
109
 
110
110
  If you have questions, feedback, or partnership inquiries:
111
111
 
112
- - [Contact Us](https://justoneapi.com/en/contact)
112
+ - [Contact Us](https://justoneapi.com/en/contact?utm_source=github.com&utm_medium=referral&utm_campaign=justoneapi_justoneapi_python&utm_content=repo_readme)
113
113
 
114
114
  ## License
115
115
 
@@ -5,9 +5,9 @@
5
5
 
6
6
  # Just One API - Python SDK
7
7
 
8
- Official Python SDK for accessing [Just One API](https://justoneapi.com) - a unified data service platform that provides structured data from social media, e-commerce, and content platforms.
8
+ Official Python SDK for accessing [Just One API](https://justoneapi.com/en?utm_source=github.com&utm_medium=referral&utm_campaign=justoneapi_justoneapi_python&utm_content=repo_readme) - a unified data service platform that provides structured data from social media, e-commerce, and content platforms.
9
9
 
10
- Supported platforms include Taobao & Tmall, Xiaohongshu, Xiaohongshu Pugongying, Douyin, Douyin Xingtu, Kuaishou, Weibo, Bilibili, JD, WeChat, Douban, TikTok, TikTok Shop, Youku, Instagram, YouTube, Reddit, Toutiao, Zhihu, Amazon, Facebook, X (Twitter), Beike, IMDb, and more. To explore the full API catalog, visit the [official website](https://justoneapi.com).
10
+ Supported platforms include Taobao & Tmall, Xiaohongshu, Xiaohongshu Pugongying, Douyin, Douyin Xingtu, Kuaishou, Weibo, Bilibili, JD, WeChat, Douban, TikTok, TikTok Shop, Youku, Instagram, YouTube, Reddit, Toutiao, Zhihu, Amazon, Facebook, X (Twitter), Beike, IMDb, and more. To explore the full API catalog, visit the [official website]([https://justoneapi.com](https://justoneapi.com/en?utm_source=github.com&utm_medium=referral&utm_campaign=justoneapi_justoneapi_python&utm_content=repo_readme)).
11
11
 
12
12
  ## Installation
13
13
 
@@ -70,13 +70,13 @@ All API requests require a valid API token.
70
70
 
71
71
  Register here:
72
72
 
73
- - [Get API Token](https://dashboard.justoneapi.com/en/register)
73
+ - [Get API Token](https://dashboard.justoneapi.com/en/login?utm_source=github.com&utm_medium=referral&utm_campaign=justoneapi_justoneapi_python&utm_content=repo_readme)
74
74
 
75
75
  ## Documentation
76
76
 
77
77
  Full API documentation:
78
78
 
79
- - [API Documentation](https://docs.justoneapi.com/en)
79
+ - [API Documentation](https://docs.justoneapi.com/en?utm_source=github.com&utm_medium=referral&utm_campaign=justoneapi_justoneapi_python&utm_content=repo_readme)
80
80
 
81
81
  The documentation includes:
82
82
 
@@ -87,13 +87,13 @@ The documentation includes:
87
87
 
88
88
  ## Official Website
89
89
 
90
- - [Home Page](https://justoneapi.com)
90
+ - [Home Page](https://justoneapi.com/en?utm_source=github.com&utm_medium=referral&utm_campaign=justoneapi_justoneapi_python&utm_content=repo_readme)
91
91
 
92
92
  ## Contact
93
93
 
94
94
  If you have questions, feedback, or partnership inquiries:
95
95
 
96
- - [Contact Us](https://justoneapi.com/en/contact)
96
+ - [Contact Us](https://justoneapi.com/en/contact?utm_source=github.com&utm_medium=referral&utm_campaign=justoneapi_justoneapi_python&utm_content=repo_readme)
97
97
 
98
98
  ## License
99
99
 
@@ -0,0 +1 @@
1
+ __version__ = "3.0.0"
@@ -13,6 +13,7 @@ class Code(Enum):
13
13
  field_0 = "0"
14
14
  field_100 = "100"
15
15
  field_101 = "101"
16
+ field_202 = "202"
16
17
  field_300 = "300"
17
18
  field_301 = "301"
18
19
  field_302 = "302"
@@ -5,6 +5,7 @@ from justoneapi.generated.resources.beike import BeikeResource
5
5
  from justoneapi.generated.resources.bilibili import BilibiliResource
6
6
  from justoneapi.generated.resources.douban import DoubanResource
7
7
  from justoneapi.generated.resources.douyin import DouyinResource
8
+ from justoneapi.generated.resources.douyin_ec import DouyinEcResource
8
9
  from justoneapi.generated.resources.douyin_xingtu import DouyinXingtuResource
9
10
  from justoneapi.generated.resources.facebook import FacebookResource
10
11
  from justoneapi.generated.resources.imdb import ImdbResource
@@ -18,6 +19,7 @@ from justoneapi.generated.resources.tiktok import TiktokResource
18
19
  from justoneapi.generated.resources.tiktok_shop import TiktokShopResource
19
20
  from justoneapi.generated.resources.toutiao import ToutiaoResource
20
21
  from justoneapi.generated.resources.twitter import TwitterResource
22
+ from justoneapi.generated.resources.web import WebResource
21
23
  from justoneapi.generated.resources.weibo import WeiboResource
22
24
  from justoneapi.generated.resources.weixin import WeixinResource
23
25
  from justoneapi.generated.resources.xiaohongshu import XiaohongshuResource
@@ -32,6 +34,7 @@ RESOURCE_CLASSES = {
32
34
  "bilibili": BilibiliResource,
33
35
  "douban": DoubanResource,
34
36
  "douyin": DouyinResource,
37
+ "douyin_ec": DouyinEcResource,
35
38
  "douyin_xingtu": DouyinXingtuResource,
36
39
  "facebook": FacebookResource,
37
40
  "imdb": ImdbResource,
@@ -45,6 +48,7 @@ RESOURCE_CLASSES = {
45
48
  "tiktok_shop": TiktokShopResource,
46
49
  "toutiao": ToutiaoResource,
47
50
  "twitter": TwitterResource,
51
+ "web": WebResource,
48
52
  "weibo": WeiboResource,
49
53
  "weixin": WeixinResource,
50
54
  "xiaohongshu": XiaohongshuResource,
@@ -60,6 +64,7 @@ __all__ = [
60
64
  "BilibiliResource",
61
65
  "DoubanResource",
62
66
  "DouyinResource",
67
+ "DouyinEcResource",
63
68
  "DouyinXingtuResource",
64
69
  "FacebookResource",
65
70
  "ImdbResource",
@@ -73,6 +78,7 @@ __all__ = [
73
78
  "TiktokShopResource",
74
79
  "ToutiaoResource",
75
80
  "TwitterResource",
81
+ "WebResource",
76
82
  "WeiboResource",
77
83
  "WeixinResource",
78
84
  "XiaohongshuResource",
@@ -16,16 +16,9 @@ class AmazonResource(BaseResource):
16
16
  country: str | None = "US",
17
17
  ) -> ApiResponse[Any]:
18
18
  """
19
- Product Details (V1)
19
+ Product Details
20
20
 
21
- Retrieves detailed product information from Amazon based on the provided ASIN.
22
- It returns core product data such as title, brand, price, availability, rating,
23
- review count, product images, category information, and other publicly available details.
24
-
25
- Typical use cases:
26
- - Building product catalogs and enriching item content (e.g., images)
27
- - Price monitoring and availability tracking
28
- - E-commerce analytics and competitor tracking
21
+ 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.
29
22
 
30
23
  Args:
31
24
  asin: ASIN (Amazon Standard Identification Number).
@@ -46,16 +39,9 @@ class AmazonResource(BaseResource):
46
39
  country: str | None = "US",
47
40
  ) -> ApiResponse[Any]:
48
41
  """
49
- Product Top Reviews (V1)
50
-
51
- Retrieves top (most relevant or most helpful) public reviews for an Amazon product based on the provided ASIN.
52
- It returns review details such as review ID, reviewer name, rating score,
53
- review title, review content, publish time, and helpful vote count (if available).
42
+ Product Top Reviews
54
43
 
55
- Typical use cases:
56
- - Sentiment analysis and consumer feedback tracking
57
- - Product research and quality assessment
58
- - Monitoring competitor customer experience
44
+ 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.
59
45
 
60
46
  Args:
61
47
  asin: ASIN (Amazon Standard Identification Number).
@@ -77,15 +63,9 @@ class AmazonResource(BaseResource):
77
63
  page: int | None = 1,
78
64
  ) -> ApiResponse[Any]:
79
65
  """
80
- Best Sellers (V1)
66
+ Best Sellers
81
67
 
82
- Retrieves top performing products for a given category on Amazon.
83
- Supports top level best sellers categories (e.g. software). In addition, subcategories / category path can be specified.
84
-
85
- Typical use cases:
86
- - Identifying trending products in specific categories
87
- - Market share analysis and category research
88
- - Tracking sales rank and popularity over time
68
+ 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.
89
69
 
90
70
  Args:
91
71
  category: Best sellers category to return products for (e.g. 'software' or 'software/229535').
@@ -101,7 +81,7 @@ class AmazonResource(BaseResource):
101
81
  },
102
82
  )
103
83
 
104
- def get_products_by_category_v1(
84
+ def get_category_products_v1(
105
85
  self,
106
86
  *,
107
87
  category_id: str,
@@ -110,15 +90,9 @@ class AmazonResource(BaseResource):
110
90
  page: int | None = 1,
111
91
  ) -> ApiResponse[Any]:
112
92
  """
113
- Products By Category (V1)
114
-
115
- Retrieves products under a specified Amazon category.
116
- Supports category-based product discovery and returns product information such as title, price, rating, review count, and other available marketplace fields.
93
+ Products By Category
117
94
 
118
- Typical use cases:
119
- - Discovering products within a specific category
120
- - Category research and competitor analysis
121
- - Monitoring product assortment, pricing, and popularity trends
95
+ 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.
122
96
 
123
97
  Args:
124
98
  category_id: For example: https://amazon.com/s?node=172282 - the Amazon Category ID is 172282
@@ -16,19 +16,9 @@ class BeikeResource(BaseResource):
16
16
  house_code: str,
17
17
  ) -> ApiResponse[Any]:
18
18
  """
19
- Resale Housing Details (V1)
19
+ Resale Housing Details
20
20
 
21
- Retrieves comprehensive information for a specific second-hand property listing on Beike (Lianjia).
22
-
23
- The data includes:
24
- - Pricing (total and unit price).
25
- - Physical attributes (area, layout, floor, orientation).
26
- - Listing metadata (tags, listing date).
27
- - Agent contact information.
28
-
29
- Typical use cases:
30
- - Displaying a full property profile to users.
31
- - Detailed price comparison between specific listings.
21
+ 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.
32
22
 
33
23
  Args:
34
24
  city_id: The ID of the city (e.g., '110000' for Beijing).
@@ -50,18 +40,9 @@ class BeikeResource(BaseResource):
50
40
  offset: int | None = 0,
51
41
  ) -> ApiResponse[Any]:
52
42
  """
53
- Resale Housing List (V1)
54
-
55
- Fetches a list of second-hand property listings from Beike (Lianjia) based on specified filters.
43
+ Resale Housing List
56
44
 
57
- Key features:
58
- - Supports filtering by city/region, price range, layout, and area.
59
- - Returns core listing details such as title, total price, unit price, and community info.
60
- - Provides house codes for fetching full details via the detail API.
61
-
62
- Typical use cases:
63
- - Building search result pages for property portals.
64
- - Aggregating market data for regional housing trends.
45
+ 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.
65
46
 
66
47
  Args:
67
48
  city_id: The ID of the city (e.g., '110000' for Beijing).
@@ -85,20 +66,9 @@ class BeikeResource(BaseResource):
85
66
  limit_offset: int | None = 0,
86
67
  ) -> ApiResponse[Any]:
87
68
  """
88
- Community List (V1)
89
-
90
- Retrieves a list of residential communities (Xiaoqu) from Beike (Lianjia) within a specified city.
91
-
92
- The data includes:
93
- - Community name and unique ID.
94
- - Average listing price and historical price trends.
95
- - Build year and architectural details.
96
- - Geographical coordinates and location information.
69
+ Community List
97
70
 
98
- Typical use cases:
99
- - Identifying popular residential areas in a city.
100
- - Comparing average housing prices across different communities.
101
- - Spatial analysis of property development patterns.
71
+ 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.
102
72
 
103
73
  Args:
104
74
  city_id: The ID of the city (e.g., '110000' for Beijing).
@@ -15,13 +15,9 @@ class BilibiliResource(BaseResource):
15
15
  bvid: str,
16
16
  ) -> ApiResponse[Any]:
17
17
  """
18
- Video Details (V2)
18
+ Video Details
19
19
 
20
- Retrieve comprehensive details about a specific Bilibili video, including metadata (title, tags, publishing time), statistics (views, likes, danmaku count), and uploader profile information.
21
-
22
- Typical use cases:
23
- - Tracking video performance and engagement metrics.
24
- - Analyzing content metadata and uploader information.
20
+ 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.
25
21
 
26
22
  Args:
27
23
  bvid: Bilibili Video ID (BVID).
@@ -40,13 +36,9 @@ class BilibiliResource(BaseResource):
40
36
  param: str | None = None,
41
37
  ) -> ApiResponse[Any]:
42
38
  """
43
- User Published Videos (V2)
44
-
45
- Retrieve a list of videos published by a specific Bilibili user, including video metadata, cover images, and engagement metrics.
39
+ User Published Videos
46
40
 
47
- Typical use cases:
48
- - Monitoring creator's content updates and publishing patterns.
49
- - Building user-specific video catalogs for analysis.
41
+ Get Bilibili user Published Videos data, including titles, covers, and publish times, for creator monitoring and content performance analysis.
50
42
 
51
43
  Args:
52
44
  uid: Bilibili User ID (UID).
@@ -66,13 +58,9 @@ class BilibiliResource(BaseResource):
66
58
  uid: str,
67
59
  ) -> ApiResponse[Any]:
68
60
  """
69
- User Profile (V2)
70
-
71
- Retrieve detailed profile information of a specific Bilibili user, including username, avatar, level, and verification status.
61
+ User Profile
72
62
 
73
- Typical use cases:
74
- - Analyzing creator's profile, level, and verification status.
75
- - Verifying user identity and social presence on Bilibili.
63
+ 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.
76
64
 
77
65
  Args:
78
66
  uid: Bilibili User ID (UID).
@@ -92,13 +80,9 @@ class BilibiliResource(BaseResource):
92
80
  page: str | None = None,
93
81
  ) -> ApiResponse[Any]:
94
82
  """
95
- Video Danmaku (V2)
83
+ Video Danmaku
96
84
 
97
- Retrieve danmaku (rolling comments) for a specific Bilibili video.
98
-
99
- Typical use cases:
100
- - Analyzing real-time viewer reactions and community trends.
101
- - Sentiment analysis based on rolling comments.
85
+ Get Bilibili video Danmaku data, including timeline positions and comment text, for audience reaction analysis and subtitle-style comment review.
102
86
 
103
87
  Args:
104
88
  aid: Bilibili Archive ID (AID).
@@ -121,13 +105,9 @@ class BilibiliResource(BaseResource):
121
105
  cursor: str | None = None,
122
106
  ) -> ApiResponse[Any]:
123
107
  """
124
- Video Comments (V2)
125
-
126
- Retrieve top-level comments for a specific Bilibili video, including commenter info, text, likes, and timestamps.
108
+ Video Comments
127
109
 
128
- Typical use cases:
129
- - Gathering detailed viewer feedback and community discussions.
130
- - Sentiment analysis and public opinion monitoring.
110
+ Get Bilibili video Comments data, including commenter profiles, text, and likes, for sentiment analysis and comment moderation workflows.
131
111
 
132
112
  Args:
133
113
  aid: Bilibili Archive ID (AID).
@@ -149,13 +129,9 @@ class BilibiliResource(BaseResource):
149
129
  order: str | None = "general",
150
130
  ) -> ApiResponse[Any]:
151
131
  """
152
- Video Search (V2)
132
+ Video Search
153
133
 
154
- Search for Bilibili videos based on keywords, returning matched videos with metadata, author information, and engagement stats.
155
-
156
- Typical use cases:
157
- - Discovering trending videos or creators by specific keywords.
158
- - Competitive analysis and market research on Bilibili.
134
+ Get Bilibili video Search data, including matched videos, creators, and engagement metrics, for topic research and content discovery.
159
135
 
160
136
  Args:
161
137
  keyword: Search keyword.
@@ -177,16 +153,9 @@ class BilibiliResource(BaseResource):
177
153
  share_url: str,
178
154
  ) -> ApiResponse[Any]:
179
155
  """
180
- Share Link Resolution (V1)
181
-
182
- Resolve Bilibili share URLs (e.g., https://b23.tv/...) to get the original content metadata.
183
-
184
- Typical use cases:
185
- - Converting shortened mobile share links to standard BVID/metadata.
186
- - Automating content extraction from shared social media links.
156
+ Share Link Resolution
187
157
 
188
- Highlights
189
- - Only supports share URLs starting with 'https://b23.tv/'.
158
+ 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.
190
159
 
191
160
  Args:
192
161
  share_url: Bilibili share URL (must start with https://b23.tv/).
@@ -198,19 +167,15 @@ class BilibiliResource(BaseResource):
198
167
  },
199
168
  )
200
169
 
201
- def get_user_relation_stat(
170
+ def get_user_relation_stat_v1(
202
171
  self,
203
172
  *,
204
173
  wmid: str,
205
174
  ) -> ApiResponse[Any]:
206
175
  """
207
- User Relation Stats (V1)
176
+ User Relation Stats
208
177
 
209
- Retrieve follower count and following count for a specific Bilibili user.
210
-
211
- Typical use cases:
212
- - Tracking creator's follower growth and audience reach.
213
- - Analyzing social influence and account popularity.
178
+ Get Bilibili user Relation Stats data, including following counts, for creator benchmarking and audience growth tracking.
214
179
 
215
180
  Args:
216
181
  wmid: Bilibili User ID (WMID).
@@ -222,7 +187,7 @@ class BilibiliResource(BaseResource):
222
187
  },
223
188
  )
224
189
 
225
- def get_video_caption_v1(
190
+ def get_video_caption_v2(
226
191
  self,
227
192
  *,
228
193
  bvid: str,
@@ -230,13 +195,9 @@ class BilibiliResource(BaseResource):
230
195
  cid: str,
231
196
  ) -> ApiResponse[Any]:
232
197
  """
233
- Video Captions (V2)
234
-
235
- Retrieve subtitle/caption information for a specific Bilibili video.
198
+ Video Captions
236
199
 
237
- Typical use cases:
238
- - Extracting textual content from video subtitles for indexing or analysis.
239
- - Multi-language content processing and accessibility analysis.
200
+ Get Bilibili video Captions data, including caption data, for transcript extraction and multilingual content analysis.
240
201
 
241
202
  Args:
242
203
  bvid: Bilibili Video ID (BVID).
@@ -7,7 +7,7 @@ from justoneapi._response import ApiResponse
7
7
 
8
8
 
9
9
  class DoubanResource(BaseResource):
10
- """Generated resource for Douban."""
10
+ """Generated resource for Douban Movie."""
11
11
 
12
12
  def get_movie_reviews_v1(
13
13
  self,
@@ -17,13 +17,9 @@ class DoubanResource(BaseResource):
17
17
  page: int | None = 1,
18
18
  ) -> ApiResponse[Any]:
19
19
  """
20
- Movie Reviews (V1)
20
+ Movie Reviews
21
21
 
22
- Retrieves long-form user reviews for a specific movie subject (identified by subjectId).
23
-
24
- Typical use cases:
25
- - Analyzing detailed audience feedback for movies.
26
- - Long-term trend analysis of viewer sentiment.
22
+ Get Douban movie Reviews data, including review titles, ratings, and snippets, for audience sentiment analysis and review research.
27
23
 
28
24
  Args:
29
25
  subject_id: The unique ID for a movie or TV subject on Douban.
@@ -39,19 +35,15 @@ class DoubanResource(BaseResource):
39
35
  },
40
36
  )
41
37
 
42
- def get_movie_review_details_v1(
38
+ def get_movie_review_detail_v1(
43
39
  self,
44
40
  *,
45
41
  review_id: str,
46
42
  ) -> ApiResponse[Any]:
47
43
  """
48
- Movie Review Details (V1)
49
-
50
- Retrieves the full content and metadata of a specific movie review (identified by reviewId).
44
+ Review Details
51
45
 
52
- Typical use cases:
53
- - Fetching the complete text of a single long review.
54
- - Analyzing the structured data and user engagement (likes, replies) of a specific review.
46
+ Get Douban movie Review Details data, including metadata, content fields, and engagement signals, for review archiving and detailed opinion analysis.
55
47
 
56
48
  Args:
57
49
  review_id: The unique ID for a specific review on Douban.
@@ -71,13 +63,9 @@ class DoubanResource(BaseResource):
71
63
  page: int | None = 1,
72
64
  ) -> ApiResponse[Any]:
73
65
  """
74
- Movie Comments (V1)
75
-
76
- Retrieves short user comments (short reviews) for a specific movie subject (identified by subjectId).
66
+ Comments
77
67
 
78
- Typical use cases:
79
- - Fast-paced sentiment analysis using quick viewer comments.
80
- - Monitoring initial audience reaction upon movie release.
68
+ Get Douban movie Comments data, including ratings, snippets, and interaction counts, for quick sentiment sampling and review monitoring.
81
69
 
82
70
  Args:
83
71
  subject_id: The unique ID for a movie or TV subject on Douban.
@@ -99,13 +87,9 @@ class DoubanResource(BaseResource):
99
87
  subject_id: str,
100
88
  ) -> ApiResponse[Any]:
101
89
  """
102
- Subject Details (V1)
90
+ Subject Details
103
91
 
104
- Retrieves detailed information for a specific subject identified by subjectId.
105
-
106
- Typical use cases:
107
- - Displaying complete subject metadata in applications or websites.
108
- - Supporting content analysis, cataloging, or detail page rendering.
92
+ Get Douban subject Details data, including title, rating, and cast, for title enrichment and catalog research.
109
93
 
110
94
  Args:
111
95
  subject_id: The unique ID for a movie or TV subject on Douban.
@@ -123,13 +107,9 @@ class DoubanResource(BaseResource):
123
107
  page: int | None = 1,
124
108
  ) -> ApiResponse[Any]:
125
109
  """
126
- Recent Hot Movie (V1)
127
-
128
- Retrieves the latest hot movies currently trending on the platform.
110
+ Recent Hot Movie
129
111
 
130
- Typical use cases:
131
- - Discovering recently popular movies.
132
- - Tracking current movie trends for content analysis or recommendation.
112
+ Get Douban recent Hot Movie data, including ratings, posters, and subject metadata, for movie discovery and trend monitoring.
133
113
 
134
114
  Args:
135
115
  page: Page number for pagination.
@@ -147,13 +127,9 @@ class DoubanResource(BaseResource):
147
127
  page: int | None = 1,
148
128
  ) -> ApiResponse[Any]:
149
129
  """
150
- Recent Hot Tv (V1)
151
-
152
- Retrieves the latest hot TV shows currently trending on the platform.
130
+ Recent Hot Tv
153
131
 
154
- Typical use cases:
155
- - Discovering recently popular TV shows.
156
- - Tracking current TV trends for content analysis or recommendation.
132
+ Get Douban recent Hot Tv data, including ratings, posters, and subject metadata, for series discovery and trend monitoring.
157
133
 
158
134
  Args:
159
135
  page: Page number for pagination.