TikTok WebSocket API
Manage WebSocket connections and state.
Connect to live stream
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
JWT key obtained from an OAuth token exchange or API key exchange. Mutually exclusive with apiKey.
Your Euler Stream API key for authentication. Mutually exclusive with jwtKey.
The TikTok username of the LIVE stream to connect to (e.g. "charlidamelio").
"v1"The protobuf schema version used for decoding TikTok messages.
trueWhen enabled, multiple events are bundled into a single WebSocket message frame for efficiency.
falseWhen enabled, raw undecoded protobuf bytes are forwarded instead of parsed JSON.
trueAutomatically normalise the uniqueId value (e.g. strip a leading @).
trueGenerate synthetic join / leave events for viewers based on presence tracking.
300Number of seconds of viewer inactivity before a synthetic leave event is emitted.
300Number of seconds with no TikTok messages before the server automatically closes the WebSocket.
Responses
No response body.
No response body.
Get WebSockets
Retrieve the currently connected WebSocket clients for your account.
Path Parameters
Responses
Retrieve WebSocket state
Retrieve the currently connected WebSocket clients for your account.