Retrieve room cover

GEThttps://api.eulerstream.com/webcast/anchors/{unique_id}/room_cover

Fetch TikTok LIVE Stream Cover URL given a uniqueId.

Path Parameters

unique_id*string

The unique ID of the TikTok to fetch the cover for.

Query Parameters

redirectboolean= true

Whether to redirect to the URL directly

Header Parameters

x-image-sourceenum

Where a scraped image URL should be served from. Selected per-request via the x-image-source header. Defaults to {@link RouteImageSource.ORIGIN}.

Responses

code*number (double)
messagestring
cover_urlstring
Response200

Fetch Webcast URL by unique ID

GEThttps://api.eulerstream.com/webcast/anchors/{unique_id}/connect

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

unique_id*string

The unique ID (handle) of the TikTok user whose LIVE room to connect to.

Query Parameters

clientstring= "ttlive-other"

The client library identifier. Used for metrics.

cursorstring

Starting cursor for the webcast connection, if any

user_agentstring

Override the user agent used for signing and fetching

client_enterboolean= true

Whether the client enters a room after connecting, or if it's done by query parameters

platformenum

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

One ofOne authentication header required
x-oauth-tokenstring

Access token from a 3rd-party Euler OAuth app.

x-cookie-headerstring

Raw TikTok cookies for direct authentication.

Responses

object
Response200

Response type is application/protobuf, so there is no JSON preview.


GEThttps://api.eulerstream.com/webcast/anchors/{unique_id}/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

unique_id*string

The creator's unique ID (handle).

Query Parameters

webcast_languageenum

Webcast language for locale-based fields

Header Parameters

One ofOne authentication header required
x-oauth-tokenstring

Access token from a 3rd-party Euler OAuth app.

x-cookie-headerstring

Raw TikTok cookies for direct authentication.

x-image-sourceenum

Where a scraped image URL should be served from. Selected per-request via the x-image-source header. Defaults to {@link RouteImageSource.ORIGIN}.

Responses

code*number (double)
messagestring
dataobject

The creator's gift gallery: the fields of the former gallery entrance plus the gallery's own.

Response200

Retrieve Webcast user earnings

GEThttps://api.eulerstream.com/webcast/anchors/{unique_id}/earnings

Retrieve TikTok LIVE earnings for a specific user.

Path Parameters

unique_id*string

The unique ID (username) of the user to fetch earnings for.

Query Parameters

periodenum

Earnings period

Header Parameters

One ofOne authentication header required
x-oauth-tokenstring

Access token from a 3rd-party Euler OAuth app.

x-cookie-headerstring

Raw TikTok cookies for direct authentication.

x-image-sourceenum

Where a scraped image URL should be served from. Selected per-request via the x-image-source header. Defaults to {@link RouteImageSource.ORIGIN}.

Responses

code*number (double)
messagestring
responseobject
Response200

Retrieve Webcast user ID

GEThttps://api.eulerstream.com/webcast/anchors/{unique_id}/user_id

Resolve a TikTok @unique_id (handle) to its numeric TikTok user ID.

Path Parameters

unique_id*string

The unique ID (handle) of the TikTok user.

Responses

code*number (double)
messagestring
numeric_user_idstring
Response200

Retrieve live analytics user interactions

GEThttps://api.eulerstream.com/webcast/anchors/me/rooms/{room_id}/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

room_id*string

The room ID of the livestream

Query Parameters

user_id*string

The numeric user ID to get interactions for

Header Parameters

One ofOne authentication header required
x-oauth-tokenstring

Access token from a 3rd-party Euler OAuth app.

x-cookie-headerstring

Raw TikTok cookies for direct authentication.

x-image-sourceenum

Where a scraped image URL should be served from. Selected per-request via the x-image-source header. Defaults to {@link RouteImageSource.ORIGIN}.

Responses

code*number (double)
messagestring
responseobject
Response200

Retrieve live analytics video detail

GEThttps://api.eulerstream.com/webcast/anchors/me/rooms/{room_id}/details

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

room_id*string

The room ID of the livestream to get analytics for

Header Parameters

One ofOne authentication header required
x-oauth-tokenstring

Access token from a 3rd-party Euler OAuth app.

x-cookie-headerstring

Raw TikTok cookies for direct authentication.

x-image-sourceenum

Where a scraped image URL should be served from. Selected per-request via the x-image-source header. Defaults to {@link RouteImageSource.ORIGIN}.

Responses

code*number (double)
messagestring
responseobject
Response200

Retrieve live analytics video list

GEThttps://api.eulerstream.com/webcast/anchors/me/rooms

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

countnumber (double)= 10

Number of videos to retrieve (default: 10)

offsetnumber (double)= 0

Pagination offset (default: 0)

Header Parameters

One ofOne authentication header required
x-oauth-tokenstring

Access token from a 3rd-party Euler OAuth app.

x-cookie-headerstring

Raw TikTok cookies for direct authentication.

x-image-sourceenum

Where a scraped image URL should be served from. Selected per-request via the x-image-source header. Defaults to {@link RouteImageSource.ORIGIN}.

Responses

code*number (double)
messagestring
responseobject
Response200

Retrieve Room ID

GEThttps://api.eulerstream.com/webcast/anchors/{creator_id}/room_id

Fetch the Room ID for a creator, by handle or numeric user ID, and whether they are live.

Path Parameters

creator_id*string

The creator: a TikTok handle (unique_id) by default, or a numeric TikTok user ID when creator_id_type is numeric_id.

Query Parameters

creator_id_typeenum

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

code*number (double)
messagestring
ok*boolean
routes_attempted*string[]
is_liveboolean
room_idstring
room_statusnumber (double)
sourcestring
detail*object

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.

Response200

Retrieve room info

GEThttps://api.eulerstream.com/webcast/anchors/{creator_id}/room_info

Retrieve TikTok Live Room Information for a creator, by handle or numeric user ID.

Path Parameters

creator_id*string

The creator: a TikTok handle (unique_id) by default, or a numeric TikTok user ID when creator_id_type is numeric_id.

Query Parameters

creator_id_typeenum

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

x-image-sourceenum

Where a scraped image URL should be served from. Selected per-request via the x-image-source header. Defaults to {@link RouteImageSource.ORIGIN}.

Responses

code*number (double)
messagestring
ok*boolean
routes_attempted*string[]
source*object

Which source produced data. CACHE means the room came from the cache; ALERTS means the live check answered offline and no room was fetched.

data*object
detail*object

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.

Response200

Retrieve room info from html

GEThttps://api.eulerstream.com/webcast/anchors/{unique_id}/room_info/crawled

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

unique_id*string

The unique ID (handle) of the TikTok user.

Header Parameters

x-image-sourceenum

Where a scraped image URL should be served from. Selected per-request via the x-image-source header. Defaults to {@link RouteImageSource.ORIGIN}.

Responses

code*number (double)
messagestring
ok*boolean
routes_attempted*string[]
source*object

Which source produced data. CACHE means the room came from the cache; ALERTS means the live check answered offline and no room was fetched.

data*object
detailstring

The WAF solver's own error text, when TikTok served a challenge page that could not be solved.

Response200