Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions justoneapi/generated/resources/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -45,6 +46,7 @@
"tiktok_shop": TiktokShopResource,
"toutiao": ToutiaoResource,
"twitter": TwitterResource,
"web": WebResource,
"weibo": WeiboResource,
"weixin": WeixinResource,
"xiaohongshu": XiaohongshuResource,
Expand Down Expand Up @@ -73,6 +75,7 @@
"TiktokShopResource",
"ToutiaoResource",
"TwitterResource",
"WebResource",
"WeiboResource",
"WeixinResource",
"XiaohongshuResource",
Expand Down
42 changes: 8 additions & 34 deletions justoneapi/generated/resources/amazon.py
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand All @@ -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).
Expand All @@ -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').
Expand All @@ -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
Expand Down
42 changes: 6 additions & 36 deletions justoneapi/generated/resources/beike.py
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand All @@ -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).
Expand All @@ -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).
Expand Down
75 changes: 18 additions & 57 deletions justoneapi/generated/resources/bilibili.py
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand All @@ -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).
Expand All @@ -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).
Expand All @@ -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).
Expand All @@ -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).
Expand All @@ -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.
Expand All @@ -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/).
Expand All @@ -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).
Expand All @@ -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).
Expand Down
Loading