TikTok LIVE Anchors
Fetch information about a TikTok LIVE anchor (host) by their unique ID.
Retrieve Room ID
Fetch Room ID for a given uniqueId & whether that user is live.
Path Parameters
Responses
Response Attributes
Retrieve Webcast user ID
Resolve a TikTok
Path Parameters
Responses
Response Attributes
Retrieve Webcast user earnings
Retrieve TikTok LIVE earnings for a specific user.
Path Parameters
Query Parameters
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
Response Attributes
Retrieve Webcast gift gallery
Retrieve the TikTok LIVE gift gallery (sponsorable gifts + sponsorship progress) for a creator.
The gallery is rendered per-viewer, so a session is required.
Path Parameters
Query Parameters
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
Response Attributes
Gallery entrance payload. Only the fields we model are typed; the rest of
the (large) TikTok response rides through as any.
Retrieve room info
Retrieve TikTok Live Room Information
Path Parameters
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
Response Attributes
Which source produced data. CACHE / CACHE_UNVERIFIED indicate the
room info came out of Euler's cache — CACHE means its live state was
revalidated, CACHE_UNVERIFIED means it could not be. Without this,
X-Cache-Hit is a bare boolean and those two are indistinguishable.
Retrieve room cover
Fetch TikTok LIVE Stream Cover URL given a uniqueId.
Path Parameters
Query Parameters
trueHeader 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
Response Attributes
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
100Header 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
Response Attributes
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
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
Response Attributes
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
Query Parameters
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
Response Attributes