TikTok LIVE Anchors
Fetch information about a TikTok LIVE anchor (host) by their unique ID.
Retrieve room cover
Fetch TikTok LIVE Stream Cover URL given a uniqueId.
Path Parameters
The unique ID of the TikTok to fetch the cover for.
Query Parameters
trueWhether to redirect to the URL directly
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
Fetch Webcast URL by unique ID
Fetch the WebSocket URL & first payload for a TikTok LIVE Room given the anchor's unique ID (handle).
Resolves the handle to its current Room ID, then behaves exactly as fetching by Room ID. Requires the Business plan.
Path Parameters
The unique ID (handle) of the TikTok user whose LIVE room to connect to.
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.
Retrieve Webcast gift gallery
Retrieve the TikTok LIVE gift gallery (sponsorable gifts, special gift lists and sponsorship progress) for a creator, live or not.
The gallery is rendered per-viewer, so a session is required.
Path Parameters
The creator's unique ID (handle).
Query Parameters
Webcast language for locale-based fields
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}.
Responses
The creator's gift gallery: the fields of the former gallery entrance plus the gallery's own.
Retrieve Webcast user earnings
Retrieve TikTok LIVE earnings for a specific user.
Path Parameters
The unique ID (username) of the user to fetch earnings for.
Query Parameters
Earnings period
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}.
Responses
Retrieve Webcast user ID
Resolve a TikTok @unique_id (handle) to its numeric TikTok user ID.
Path Parameters
The unique ID (handle) of the TikTok user.
Responses
Retrieve live analytics user interactions
Find out how long a user watched your stream, the # of comments sent, likes, the comments themselves, and more analytics data.
Note: The session you attach must own the livestream to check analytics for a given room_id.
Returns details about a user's activity in a room including comments, likes, shares, and watch duration.
Path Parameters
The room ID of the livestream
Query Parameters
The numeric user ID to get interactions for
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}.
Responses
Retrieve live analytics video detail
Retrieve detailed analytics for a specific past livestream.
Note: The session you attach must own the livestream to check analytics for a given room_id.
Path Parameters
The room ID of the livestream to get analytics for
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}.
Responses
Retrieve live analytics video list
Retrieve the list of past livestreams with analytics for the authenticated user.
Note: The session you attach must own the livestream to check analytics for a given room_id.
Query Parameters
10Number of videos to retrieve (default: 10)
0Pagination offset (default: 0)
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}.
Responses
Retrieve Room ID
Fetch the Room ID for a creator, by handle or numeric user ID, and whether they are live.
Path Parameters
The creator: a TikTok handle (unique_id) by default, or a numeric TikTok user ID when creator_id_type is numeric_id.
Query Parameters
What creator_id is: unique_id (a handle, the default) or numeric_id (a numeric TikTok user ID). A numeric ID skips the handle lookup and still finds the creator after a handle change.
Responses
Why the answer came out as it did, or null when there is nothing to add. Only a 404 carries it today; read it on any answer.
Retrieve room info
Retrieve TikTok Live Room Information for a creator, by handle or numeric user ID.
Path Parameters
The creator: a TikTok handle (unique_id) by default, or a numeric TikTok user ID when creator_id_type is numeric_id.
Query Parameters
What creator_id is: unique_id (a handle, the default) or numeric_id (a numeric TikTok user ID). A numeric ID skips the handle lookup and still finds the creator after a handle change.
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; ALERTS means the live check answered offline and no room was fetched.
Why the answer came out as it did, or null when there is nothing to add. Only a 404 carries it today; read it on any answer.
Retrieve room info from html
Retrieve TikTok Live Room Information from the state the creator's LIVE page (tiktok.com/@{unique_id}/live) renders. data.raw is that page's LiveRoom state.
Path Parameters
The unique ID (handle) of the TikTok user.
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; ALERTS means the live check answered offline and no room was fetched.
The WAF solver's own error text, when TikTok served a challenge page that could not be solved.