REST API Overview

13+ REST endpoints for signing TikTok URLs, checking live status, fetching room data, rankings, and more.

Base URL

https://api.tik.tools

All endpoints require an apiKey query parameter.

Authentication

Pass your API key as a query parameter on every request:

https://api.tik.tools/webcast/check_alive?apiKey=YOUR_KEY&unique_id=streamer

Response Format

All endpoints return JSON with a consistent structure:

{
  "status_code": 0,
  "data": { ... }
}

A status_code of 0 indicates success. Non-zero codes indicate an error with a message field.

Endpoints

Stream Discovery

Method	Endpoint	Description	Min Tier
GET	/webcast/check_alive	Check if a user is live	Sandbox
POST	/webcast/bulk_live_check	Batch live status check (up to 100 users)	Sandbox
POST	/webcast/room_id	Resolve username to room ID	Sandbox
GET	/webcast/hashtag_list	Trending live hashtags	Sandbox

Stream Data

Method	Endpoint	Description	Min Tier
POST	/webcast/room_info	Stream metadata, viewer count, host profile	Sandbox
POST	/webcast/room_video	HLS/FLV stream URLs	Sandbox
GET	/webcast/room_cover	Stream cover/thumbnail image	Sandbox
GET	/webcast/rankings	Real-time gifter leaderboard	Sandbox
POST	/webcast/fetch	HTTP long-polling for events	Sandbox

Signing & Credentials

Method	Endpoint	Description	Min Tier
POST	/webcast/sign_url	Sign any TikTok URL (X-Bogus)	Sandbox
POST	/webcast/sign_websocket	Sign a WebSocket URL	Sandbox
POST	/webcast/ws_credentials	Pre-signed WS credentials	Sandbox

Identity & Info

Method	Endpoint	Description	Min Tier
POST	/webcast/resolve_user_ids	Resolve numeric user IDs to usernames	Sandbox
GET	/webcast/gift_info	Gift catalog with diamond values	Sandbox

Account

Method	Endpoint	Description	Min Tier
GET	/webcast/rate_limits	Check your quota and limits	Sandbox
POST	/authentication/jwt	Generate JWT for frontend auth	Sandbox