Examples

Runnable example scripts for every resource in the SDK.

Quickstart

Set your API key and run any example:

export TIKHUB_API_KEY="YOUR_API_KEY"

python examples/health_check.py        # smallest possible call
python examples/quickstart.py          # 4 useful endpoints, hand-written
python examples/douyin_web.py          # all 76 Douyin web endpoints
python examples/tiktok_app_v3.py       # all 75 TikTok app endpoints

Every script is fully self-contained — you can copy any one file out of the repo and run it with just pip install tikhub.

What's in each file

Every per-resource file:

1. Imports TikHub and TikHubError.
2. Defines a tiny demo() helper that calls one endpoint, prints a truncated JSON response, and continues on error.
3. Calls every endpoint on that resource using the example values from spec/openapi.json.

# excerpt from examples/douyin_web.py
def main() -> None:
    with TikHub() as client:  # reads $TIKHUB_API_KEY

        # GET /api/v1/douyin/web/fetch_one_video
        # 获取单个作品数据/Get single video data
        demo("fetch_one_video", lambda: client.douyin_web.fetch_one_video(aweme_id="..."))

        # POST /api/v1/douyin/web/fetch_multi_video
        # 批量获取视频信息/Batch Get Video Information
        demo("fetch_multi_video", lambda: client.douyin_web.fetch_multi_video(body=[]))

        # ... and 74 more

Resource files (51)

All names match the SDK attribute on client.*. Endpoint counts in parentheses.

Platform	File(s)
Douyin	douyin_web.py (76) · douyin_app_v3.py (47) · douyin_search.py (19) · douyin_billboard.py (31) · douyin_creator.py (16) · douyin_creator_v2.py (14) · douyin_xingtu.py (22) · douyin_xingtu_v2.py (21)
TikTok	tiktok_web.py (59) · tiktok_app_v3.py (75) · tiktok_creator.py (14) · tiktok_analytics.py (4) · tiktok_ads.py (31) · tiktok_shop_web.py (15)
Xiaohongshu	xiaohongshu_web.py (17) · xiaohongshu_web_v2.py (18) · xiaohongshu_web_v3.py (11) · xiaohongshu_app.py (12) · xiaohongshu_app_v2.py (21)
Bilibili	bilibili_web.py (30) · bilibili_app.py (11)
Kuaishou	kuaishou_web.py (13) · kuaishou_app.py (20)
Weibo	weibo_web.py (11) · weibo_web_v2.py (33) · weibo_app.py (20)
WeChat	wechat_channels.py (10) · wechat_media_platform_web.py (10)
Zhihu	zhihu_web.py (34)
Toutiao	toutiao_web.py (2) · toutiao_app.py (5)
Xigua	xigua_app_v2.py (7)
PiPiXia	pipixia_app.py (17)
Lemon8	lemon8_app.py (16)
Sora2	sora2.py (16)
Instagram	instagram_v1.py (29) · instagram_v2.py (27) · instagram_v3.py (32)
YouTube	youtube_web.py (21) · youtube_web_v2.py (19)
Twitter / X	twitter_web.py (13)
Threads	threads_web.py (11)
Reddit	reddit_app.py (24)
LinkedIn	linkedin_web.py (25)
Utility	hybrid_parsing.py (1) · tikhub_user.py (6) · tikhub_downloader.py (2) · temp_mail.py (3) · ios_shortcut.py (1) · health_check.py (1) · demo.py (9)

Total: 51 resource files, 1002 demo calls.

What's NOT in here

• TikTok-Interaction-API (post_comment / like / follow / collect / forward / reply / apply) — these would actually mutate state. Use the SDK directly if you need them.
• sora2.upload_image — needs a real file to upload, can't be auto-generated as a one-liner.

Heads up

• Many calls will return HTTP 400 with "Request failed. Please retry" — that's TikHub's generic upstream error when the spec's example value (e.g. an aweme_id, note_id, share URL) has gone stale on the upstream platform. The SDK is wired correctly; the example value just no longer points at a real piece of content. Replace the value in the call with a real one and try again.
• Each demo call costs API quota. The largest file (douyin_web.py) makes 76 calls; the smallest makes 1.
• The demo() helper truncates responses to 600 chars. To see the full payload, replace demo(...) with a direct client.<resource>.<method>(...) call.

Regenerating

If TikHub publishes a new spec version, refresh everything in three commands:

python scripts/refresh_spec.py        # pulls latest openapi.json
python scripts/generate_resources.py  # rewrites src/tikhub/resources/*.py
python scripts/generate_examples.py   # rewrites this directory