Connect to live stream

WSSwss://ws.eulerstream.com

Open a WebSocket connection to wss://ws.eulerstream.com to receive real-time TikTok LIVE events. Pass parameters as query string values in the connection URL.

Query Parameters

One ofOne authentication parameter required
jwtKeystring

JWT key obtained from an OAuth token exchange or API key exchange. Mutually exclusive with apiKey.

apiKeystring

Your Euler Stream API key for authentication. Mutually exclusive with jwtKey.

uniqueId*string

The TikTok username of the LIVE stream to connect to (e.g. "charlidamelio").

schemaVersionenum= "v1"

The protobuf schema version used for decoding TikTok messages.

features.bundleEventsenum= true

When enabled, multiple events are bundled into a single WebSocket message frame for efficiency.

features.rawMessagesenum= false

When enabled, raw undecoded protobuf bytes are forwarded instead of parsed JSON.

features.normalizeUniqueIdenum= true

Automatically normalise the uniqueId value (e.g. strip a leading @).

features.syntheticPresenceenum= true

Generate synthetic join / leave events for viewers based on presence tracking.

features.syntheticPresenceLeaveAfternumber= 300

Number of seconds of viewer inactivity before a synthetic leave event is emitted.

features.closeInactiveWebSocketAfternumber= 300

Number of seconds with no TikTok messages before the server automatically closes the WebSocket.

Responses

No response body.

Response1000

No response body.


Get WebSockets

GEThttps://api.eulerstream.com/webcast/websockets/{account_id}

Retrieve the currently connected WebSocket clients for your account.

Path Parameters

account_id*number (double)

Responses

code*number (double)
messagestring
webSocketIdsstring[]
connectionsnumber (double)
Response200

Retrieve WebSocket state

GEThttps://api.eulerstream.com/webcast/websockets/{account_id}/{websocket_id}

Retrieve the currently connected WebSocket clients for your account.

Path Parameters

account_id*number (double)
websocket_id*string

Responses

code*number (double)
messagestring
stateobject
Response200