TikTok LIVE Rooms
Fetch information about a TikTok LIVE room by its room ID.
Fetch Webcast URL
Fetch the WebSocket URL & first payload for a TikTok LIVE Room given a Room ID.
Path Parameters
The room ID to fetch the Webcast URL for. Must be a numeric string.
Query Parameters
"ttlive-other"The client library identifier. Used for metrics.
Starting cursor for the webcast connection, if any
Override the user agent used for signing and fetching
trueWhether the client enters a room after connecting, or if it's done by query parameters
Transport for a webcast fetch, and this API's own query contract. The scrape server's webcastFetch route is web-only and carries no platform, so mobile is served by the mobile signing API (see fetchWebcastMobileUrl) instead.
Header Parameters
Access token from a 3rd-party Euler OAuth app.
Raw TikTok cookies for direct authentication.
Responses
Response type is application/protobuf, so there is no JSON preview.
Send room chat
Send a chat to a TikTok LIVE room.
Either targetRoomId or targetUniqueId must be provided to identify the room.
Path Parameters
Room ID
Header Parameters
Access token from a 3rd-party Euler OAuth app.
Raw TikTok cookies for direct authentication.
Request Body
RequiredThe payload configuration for sending a chat
The chat message content to send
The username of the room to send the chat to (either this or targetRoomId is required). Pass room_id = 0 to parameter for this to work.
The chat message content to send
The username of the room to send the chat to (either this or targetRoomId is required). Pass room_id = 0 to parameter for this to work.
Responses
Retrieve room gifts
Retrieve room-specific TikTok LIVE gift data.
Returns the ordered gift list for a specific room, along with room-specific overrides (sponsor info, gallery status, panel visibility). Use this alongside the /webcast/gift_info endpoint which provides the full gift catalog.
Path Parameters
The room ID of the TikTok LIVE session
Query Parameters
Webcast language for locale-based fields
Responses
Retrieve room info by Room ID
Retrieve TikTok LIVE room information by room ID.
Path Parameters
The TikTok LIVE room ID.
Header Parameters
Where a scraped image URL should be served from. Selected per-request via the x-image-source header. Defaults to {@link RouteImageSource.ORIGIN}.
Responses
Which source produced data. CACHE means the room came from the cache.
Retrieve room rankings
Retrieve the top viewers of a TikTok LIVE room: who is watching and how many coins each has given this LIVE, ranked. total is the audience count TikTok reports; ranks lists only the viewers it ranks.
Path Parameters
The numeric room ID of the LIVE.
Query Parameters
The numeric user ID of the room's host.
Header Parameters
Access token from a 3rd-party Euler OAuth app.
Raw TikTok cookies for direct authentication.
Where a scraped image URL should be served from. Selected per-request via the x-image-source header. Defaults to {@link RouteImageSource.ORIGIN}.