Skip to content

Latest commit

 

History

History
416 lines (316 loc) · 51.8 KB

File metadata and controls

416 lines (316 loc) · 51.8 KB

Just One API Logo

PyPI version License

English | 简体中文

Just One API - Python SDK

Official Python SDK for accessing Just One API - a unified data service platform that provides structured data from social media, e-commerce, and content platforms.

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.

Platform Overview

The documentation center helps you browse endpoint health, versioned API paths, request parameters, and platform-specific usage notes.

Just One API documentation overview

The console provides API token management, balance visibility, request logs, usage trends, and spending analytics.

Just One API console overview

Installation

pip install justoneapi

Quick Start

from justoneapi import JustOneAPIClient

client = JustOneAPIClient(token="your_token")

# Example: Douyin video search
response = client.douyin.search_video_v4(keyword="deepseek")

print(response.success)  # True only when code == 0
print(response.code)     # Business code returned by the API
print(response.message)  # Server message
print(response.data)     # Actual payload

Response Shape

Every API method returns an ApiResponse instance with these fields:

Field Type Description
success bool True only when code == 0.
code Any Raw business code returned by the API.
message str Server message.
data Any Response payload from the API.
raw_json dict Full response payload before SDK normalization.

Error Handling

By default, business failures do not raise exceptions. You can check response.success, response.code, and response.message.

If you prefer exceptions for non-zero business codes:

from justoneapi import JustOneAPIClient, BusinessError

client = JustOneAPIClient(
    token="your_token",
    raise_on_business_error=True,
)

try:
    response = client.douyin.search_video_v4(keyword="deepseek")
except BusinessError as exc:
    print(exc.response.code)
    print(exc.response.message)

Authentication

All API requests require a valid API token.

Register here:

Documentation

Full API documentation:

The documentation includes:

  • Request parameters
  • Response fields
  • Error codes
  • Platform-specific examples

Official Website

Contact

If you have questions, feedback, or partnership inquiries:

Service Overview

The API list below is generated from OpenAPI and shows the current public API categories, endpoint names, and versions. See the online API documentation for full request and response details.

Social Media

Taobao and Tmall

Xiaohongshu (RedNote)

Xiaohongshu Creator Marketplace (Pugongying)

Douyin (TikTok China)

Douyin E-commerce

Douyin Creator Marketplace (Xingtu)

Kuaishou

Weibo

Bilibili

JD.com

WeChat Official Accounts

Douban Movie

TikTok

TikTok Shop

YOUKU

Instagram

YouTube

Reddit

Toutiao

Zhihu

Amazon

Facebook

Twitter

Beike

IMDb

Web Page

License

This project is licensed under the MIT License.