Skip to content

TikTok LIVE Connector

Docs Events API

Start here

Getting Started Connection lifecycle Migration

Configuration

Connection options Signing and provider clients Authentication Environment variables Presets and protocol defaults

Guides

Applications and overlays Battles and cohosting Gifts and streaks Power-Ups Room information and viewers Send chat messages

Events

Event catalog Control events Battles and cohosting Chat and audience Games, commerce, and partnerships Gifts and goals Moderation and access Rankings Room messages and display Stream control Subscriptions and super fans

Advanced

HTTP client and cookies Protobuf and decoding HTTP routes and overrides Public types and utilities WebSocket client

Troubleshooting Contributing to the docs Hosting

API reference

Enumerations

BaseFetchRoute CompositeFetchRoute ConnectState ControlEvent ErrorReason EulerFetchRoute WebcastEvent

Classes

AlreadyConnectedError AlreadyConnectingError AuthenticatedWebSocketConnectionError ConnectTimeoutError InvalidRequestError InvalidResponseCompositeError InvalidResponseError InvalidSchemaNameError InvalidUniqueIdError PremiumFeatureError SchemaDecodeError SignAPIError SignatureMissingTokensError SignatureRateLimitError TikTokLiveConnection TikTokLiveError UserOfflineError WebcastHttpClient WebcastWebSocketClient

Interfaces

AbstractWebcastCookieJar BaseProtoMessage WebcastGiftMessage

Type Aliases

BasicWebcastEventMessage ClientEventMap CookieSessionBundle DecodedData DecodedWebcastPushFrame DevicePreset EulerRouteRequestOptions EventHandler FetchIsLiveRouteParams FetchRoomIdFromEulerRouteParams FetchRoomIdRouteParams FetchRoomInfoFromApiRouteParams FetchRoomInfoFromApiRouteResponse FetchRoomInfoFromEulerRouteParams FetchRoomInfoFromHtmlRouteParams FetchRoomInfoFromHtmlRouteResponse FetchSignedWebSocketFromEulerRouteParams FetchSignedWebSocketFromEulerRouteResponse FetchWebcastSignatureFromEulerRouteParams GetWebConfigParams GetWebSocketConfigParams HttpRoute IWebcastDeserializeConfig LocationPreset OAuthTokenSessionBundle RoomGiftGalleryFromEulerResponse RoomGiftGalleryFromEulerRouteParams RoomGiftInfo RoomGiftsFromEulerResponse RoomGiftsFromEulerRouteParams RoomGiftsResponse RoomGiftsRouteParams RoomInfo RoomInfoResponse RoomInfoRouteParams ScreenPreset SendRoomChatFromEulerRouteParams SessionBundle SignConfig TikTokLiveConnectionBundledAuthOptions TikTokLiveConnectionMutableOptions TikTokLiveConnectionOptions TikTokLiveConnectionProviderOptions TikTokLiveConnectionState TikTokLiveConstructorConnectionOptions WebcastEventMessage WebcastGotHttpConfig WebcastHttpClientRequestParams WebcastHttpCompositeRouteArgs WebcastHttpEulerRouteArgs WebcastHttpRouteArgs WebcastMessage WebcastSignerParams WebcastSignerResponse WebcastTypedClient WebcastTypedWebSocket WebcastWebConfigDefaults WebcastWebSocketConfig WebcastWebSocketConfigDefaults WebcastWebSocketEventMap WebSocketDynamicParams WebSocketParams WrappedHttpRoute

Variables

BaseProtoMessage Devices fetchIsLiveComposite fetchRoomGiftGalleryFromEulerRoute fetchRoomGiftsFromEulerRoute fetchRoomGiftsRoute fetchRoomIdComposite fetchRoomIdFromEulerRoute fetchRoomInfoFromApiLiveRoute fetchRoomInfoFromEulerRoute fetchRoomInfoFromHtmlRoute fetchRoomInfoRoute fetchSignedWebSocketFromEulerRoute fetchWebcastSignatureFromEulerRoute IsLiveRouteConfig LIBRARY_IDENTITY Locations RoomIdRouteConfig RoomInfoFromHtmlRouteConfig RouteConfig Screens sendRoomChatFromEulerRoute SignConfig UserAgents VERSION WebcastDeserializeConfig WebcastEventMap WebcastGiftMessage WebcastWebConfigDefaults WebSocketConfigDefaults

Functions

createBaseWebcastPushFrame createEulerClient createRoute createWebSocketProvider deserializeMessage deserializeWebSocketMessage generateDeviceId generateUniqId getRandomDevicePreset getRandomLocationPreset getRandomPresets getRandomScreenPreset getWebConfig getWebSocketConfigDefaults HandleError userAgentToDevicePreset validateAndNormalizeUniqueId

Protobuf schema

TagItem_EventTrackingFieldsEntry

Properties

Section titled “Properties”

key

Section titled “key”

key: string

value

Section titled “value”

value: string

On this page

Overview
Properties
- key
- value

Unofficial project, not affiliated with TikTok or ByteDance Ltd. Signing by Euler Stream. Source on GitHub.

Docs Events API

Start here

Getting Started Connection lifecycle Migration

Configuration

Connection options Signing and provider clients Authentication Environment variables Presets and protocol defaults

Guides

Applications and overlays Battles and cohosting Gifts and streaks Power-Ups Room information and viewers Send chat messages

Events

Event catalog Control events Battles and cohosting Chat and audience Games, commerce, and partnerships Gifts and goals Moderation and access Rankings Room messages and display Stream control Subscriptions and super fans

Advanced

HTTP client and cookies Protobuf and decoding HTTP routes and overrides Public types and utilities WebSocket client

API reference