TikTok Live Connector

Node.js library to receive live stream events (comments, gifts, etc.) in realtime from TikTok LIVE.

1589

344

TypeScript

TikTok-Live-Connector

A Node.js library to receive live stream events such as comments and gifts in realtime
from TikTok LIVE by connecting to TikTok’s internal Webcast push service.
This package includes a wrapper that connects to the Webcast service using just the username (@uniqueId).
This allows you to connect to your own live chat as well as the live chat of other streamers. No credentials are
required. Besides Chat Comments, other events such
as Members Joining, Gifts, Subscriptions, Viewers, Follows, Shares, Questions, Likes
and Battles can be tracked.

Connections
Downloads
Stars
Issues
Forks

📌 2.X.X Now Available - Upgrade Now!

We are thrilled to announce that the 2.0.0 release of TikTok Live Connector is now available!
This release converts the package to exclusively typescript-based, also providing complete backwards compatibility for
users.

Upgrade Guide

Install via npm i [email protected]
Switch WebcastPushConnection to TikTokLiveConnection (or keep for legacy support)
Switch Event Names to WebcastEvent.EVENT_NAME from event_name format
That’s it! You’re good to go!
If you have any issues, please open an issue on GitHub or ask on Discord.

Breaking Changes

WebcastPushConnection has been renamed to TikTokLiveConnection
CommonJS support has been removed
Data fetching functions have been renamed

Do you prefer other programming languages?

Python rewrite: TikTokLive
by @isaackogan and @eulerstream
Java rewrite: TikTokLiveJava
by @jwdeveloper and @kohlerpop1
Go rewrite: GoTikTokLive
by @steampoweredtaco and @davincible
C# rewrite: TikTokLiveSharp
by @frankvHoof93

Getting Started
Params and Options
Methods
Properties
Events
Examples

Getting Started

Install the package via NPM

npm i tiktok-live-connector

Create your first TikTok LIVE chat connection

// Username of someone who is currently live
import { TikTokLiveConnection, WebcastEvent } from 'tiktok-live-connector';

const tiktokUsername = 'officialgeilegisela';

// Create a new wrapper object and pass the username
const connection = new TikTokLiveConnection(tiktokUsername);

// Connect to the chat (await can be used as well)
connection.connect().then(state => {
    console.info(`Connected to roomId ${state.roomId}`);
}).catch(err => {
    console.error('Failed to connect', err);
});

// Define the events that you want to handle
// In this case we listen to chat messages (comments)
connection.on(WebcastEvent.CHAT, data => {
    console.log(`${data.user.uniqueId} (userId:${data.user.uniqueId}) writes: ${data.comment}`);
});

// And here we receive gifts sent to the streamer
connection.on(WebcastEvent.GIFT, data => {
    console.log(`${data.user.uniqueId} (userId:${data.user.userId}) sends ${data.giftId}`);
});

// ...and more events described in the documentation below

Params and Options

To create a new TikTokLiveConnection object the following parameters can be specified.

TikTokLiveConnection(uniqueId, [options])

Param Name	Required	Description
uniqueId	Yes	The unique username of the broadcaster. You can find this name in the URL. Example: `https://www.tiktok.com/@officialgeilegisela/live` => `officialgeilegisela`
options	No	Here you can set the following optional connection properties. If you do not specify a value, the default value will be used. `processInitialData` (default: `true`) Define if you want to process the initital data which includes old messages of the last seconds. `signApiKey` (default: `null`) Configure a Sign API key. This API key will be used to generate the URL to facilitate connections to the TikTok LIVE WebSocket server. `fetchRoomInfoOnConnect` (default: `true`) Define if you want to fetch all room information on `connect()`. If this option is enabled, the connection to offline rooms will be prevented. If enabled, the connect result contains the room info via the `roomInfo` attribute. You can also manually retrieve the room info (even in an unconnected state) using the `getRoomInfo()` function. `enableExtendedGiftInfo` (default: `false`) Define if you want to receive extended information about gifts like gift name, cost and images. This information will be provided at the gift event. `requestPollingIntervalMs` (default: `1000`) Request polling interval if WebSocket is not used. `sessionId` (default: `null`) Here you can specify the current Session ID of your TikTok account `ttTargetIdc` (default: `null`) The tt-target-idc cookie, representing the TikTok datacenter the account is registered in (based on the sign-up region) `webClientParams` (default: `{}`) Custom client params for Webcast API. `webClientHeaders` (default: `{}`) Custom request headers passed to axios. `websocketHeaders` (default: `{}`) Custom websocket headers passed to websocket.client. `webClientOptions` (default: `{}`) Custom request options passed to axios. Here you can specify an `httpsAgent` to use a proxy and a `timeout` value. See Example. `wsClientParams` (default: `${}`) WebSocket parameters to be appended to the connection url. `wsClientHeaders` (default: {}) Custom WebSocket headers to be sent when connecting. `wsClientOptions` (default: `{}`) Custom websocket options passed to websocket.client. Here you can specify an `agent` to use a proxy and a `timeout` value. See Example. `authenticateWs` (default: `false`) By default, WebSocket connections are not authenticated, even when passing a sessionid, for security. This is because ‘signing’ (generating the URL) for connecting is done by a 3rd-party freeware service. It must be manually enabled, and you assume the risks associated with sending over a session id when you enable it. `preferredAgentIds` (default: `[]`) WebSocket URL generation is done by a 3rd-party service. This option allows you to specify a specific ‘agent’ on the 3rd-party service to handle the URL generation. `connectWithUniqueId` (default: `false`) This option allows the 3rd-party service to determine the Room ID for you, rather than retrieving it through scraping. This may be preferable on low-quality IPs, as it bypasses captchas. `disableEulerFallbacks` (default: false) This option disables the Euler Stream API “fallback” routes used by default when scraping fails. `signedWebSocketProvider` (default: `(props: FetchSignedWebSocketParams) => Promise<ProtoMessageFetchResult>`) The function responsible for signing (generating a valid WebSocket URL) can be swapped out for your own backend, if you do not want to use the free 3rd-party service bundled into the client that generates them.

Example Options

const tikTokLiveConnection = new TikTokLiveConnection(tiktokUsername, {
    processInitialData: false,
    enableExtendedGiftInfo: true,
    requestPollingIntervalMs: 2000,
    signApiKey: 'your-api-key',
    webClientParams: {
        "app_language": "en-US",
        "device_platform": "web"
    },
    webClientHeaders: {
        "headerName": "headerValue"
    },
    wsClientHeaders: {
        "headerName": "headerValue"
    },
    wsClientParams: {
        "app_language": "en-US",
    },
    webClientOptions: {
        timeout: 10000
    },
    wsClientOptions: {
        timeout: 10000
    }
});

Methods

Method Name	Description
connect(`[roomId]`)	Connects to the live stream chat. Returns a `Promise` which will be resolved when the connection is successfully established. Optionally, you can provide a Room Id to bypass Room Id scraping.
disconnect()	Disconnects from the stream if connected.
sendMessage(`<content>`)	Send a message to a TikTok LIVE chat. Simply speciy the message you want to send, and voila! Requires an API key. Example
fetchRoomId(`[uniqueId]`)	Fetch the Room Id associated with the currently configured `uniqueId`. Optionally, provide a `uniqueId` for a different user to check. Returns a `Promise` which is resolved when the Room Id is fetched.
fetchIsLive()	Fetch whether the user is currently streaming. Returns a `Promise` which resolves when the state is fetched.
waitUntilLive()	Returns a blocking promise that resolves when the user goes live.
fetchRoomInfo()	Gets the current room info from TikTok API including streamer info, room status and statistics. Returns a `Promise` which will be resolved when the API request is done. Note: You can call this function even if you’re not connected. Example
fetchAvailableGifts()	Gets a list of all available gifts including gift name, image url, diamont cost and a lot of other information. Returns a `Promise` that will be resolved when all available gifts has been retrieved from the API. Note: You can call this function even if you’re not connected. Example

Properties

Property Name	Description
webClient: `TikTokWebClient`	An API wrapper for TikTok with routes for scraping the TikTok site & internal APIs. This is used to fetch the initial data and room info.
wsClient: `TikTokWsClient \| null`	The WebSocket client object. This manages the lifecycle of the WebSocket connection to TikTok, and is where all events originate from.
options: `TikTokLiveConnectionOptions`	Options described in Params and Options
roomInfo: `RoomInfoResponse`	The room info object. This contains all information about the current room.
availableGifts: `RoomGiftInfo`	The list of available gifts. This is only filled if `enableExtendedGiftInfo` is set to `true`.
isConnecting: `boolean`	Indicates whether the connection is currently being established.
isConnected: `boolean`	Indicates whether the connection is currently established.
webClientParams: `Record<string, string>`	Base URI parameters that are sent with every request of `TikTokWebClient`.
roomId: `string`	The current room id. This is only available after a successful connection.
state: `TikTokLiveConnectionState`	The current state of the connection. Includes info such as connection status, Room Id, room info, etc.

Signing Configuration

It is possible to configure the 3rd-party library used to generate
WebSocket URLs, a process referred to as ‘signing’. An example is provided below:

// SignConfig is an instance of Partial<ClientConfiguration>
import { SignConfig } from 'tiktok-live-connector';

SignConfig.apiKey = "your api key" // An API key created at https://www.eulerstream.com
SignConfig.basePath = "https://your-custom-sign-server.com" // Optionally, you can even define your own server
SignConfig.baseOptions.headers['X-Custom-Header'] = 'Custom-Header-Value'

Accessing TikTok LIVE Routes

The TikTokWebClient object is used to access TikTok’s internal API routes. This object is available via
the webClient property of the TikTokLiveConnection object.

The following routes come bundled with the web client:

connection.webClient.fetchRoomInfo
connection.webClient.sendRoomChat
connection.webClient.fetchRoomInfoFromApiLive
connection.webClient.fetchRoomInfoFromHtml
connection.webClient.fetchSignedWebSocketFromEuler
connection.webClient.fetchRoomIdFromEuler
connection.webClient.fetchRoomInfoFromEuler

Example Usage:

All routes are callable classes that accepts a singular object with the required parameters, and return a promise
that resolves with the route data. For instance, here is how you can fetch Room Info from the page HTML:

const connection = new TikTokLiveConnection('officialgeilegisela');

connection.webClient.fetchRoomInfoFromHtml({ uniqueId: uniqueId })
    .then((response: FetchRoomInfoFromHtmlRouteResponse) => {
        console.log('Room Info:', response.data);
    });

Accessing 3rd-Party Routes

The TikTokWebClient comes bundled with an instance of EulerSigner, a 3rd-party library that provides the WebSocket
connection URL used to
connect to TikTok LIVE.

This is publicly accessible via connection.webClient.webSigner and exposes additional 3rd-party routes related to
TikTok LIVE.

Example 1: Fetching Rate Limits

For example, here’s how you can fetch the rate limits for your current API key:

import { SignConfig } from 'tiktok-live-connector';
import { IGetRateLimits } from '@eulerstream/euler-api-sdk';

// Configure an API Key
SignConfig.apiKey = 'your api key'; // An API key created at https://www.eulerstream.com

// Create a connection
const connection = new TikTokLiveConnection();

// Fetch the limits
connection.webClient.webSigner.webcast.getRateLimits()
    .then((response: AxiosResponse<IGetRateLimits>) => {
        console.log('Rate Limits:', response.data);
    });

Example 2: Using JWT Authentication

If you intend to run the TikTok-Live-Connector in a client environment (e.g. a bundled desktop app), you won’t want to
give the user your API key. Instead, you can create a JWT for the user to connect to the API.

Server-Side:

First, generate the JWT and return it to your user:

import { SignConfig, TikTokWebClient } from './src';

SignConfig.apiKey = 'your_api_key_here';
const connection = new TikTokWebClient();

connection.webSigner.authentication.createJWT(
    122, // Your account ID
    {
        limits: {
            minute: 5,
            day: 5,
            hour: 5
        },
        expireAfter: 60 * 60 * 2 // 2 hours is the max accepted value
    }
).then((res) => {
    console.log('Generated JWT:', res.data.token);
});

Client-Side:

Then, use the JWT to connect to the API in the client-side NodeJS application:

import { SignConfig } from './config';
import { TikTokLiveConnection } from './client';

SignConfig.baseOptions.headers['x-jwt-key'] = 'generated-jwt-key';
const connection = new TikTokLiveConnection('tv_asahi_news');

Events

A TikTokLiveConnection object has the following events which can be handled with an event listener.

The simplest event handler is a connect event:

const connection = new TikTokLiveConnection('officialgeilegisela');
connection.on(ControlEvent.CONNECTED, () => console.log("Connected!"));

Control Events:

ControleEvent.CONNECTED or "connected"
ControleEvent.DISCONNECTED or "disconnected"
ControleEvent.STREAM_END or "streamEnd"
ControleEvent.RAW_DATA or "rawData"
ControleEvent.DECODED_DATA or "decodedData"
ControleEvent.WEBSOCKET_CONNECTED or "websocketConnected"
ControleEvent.ERROR or "error"
ControlEvent.WEBSOCKET_DATA or "websocketData"

Message Events:

WebcastEvent.CHAT or "chat"
WebcastEvent.GIFT or "gift"
WebcastEvent.MEMBER or "member"
WebcastEvent.LIKE or "like"
WebcastEvent.SOCIAL or "social"
WebcastEvent.ENVELOPE or "envelope"
WebcastEvent.QUESTION_NEW or "questionNew"
WebcastEvent.LINK_MIC_BATTLE or "linkMicBattle"
WebcastEvent.LINK_MIC_ARMIES or "linkMicArmies"
WebcastEvent.LIVE_INTRO or "liveIntro"
WebcastEvent.SUBSCRIBE or "subscribe"
WebcastEvent.FOLLOW or "follow"
WebcastEvent.SHARE or "share"
WebcastEvent.STREAM_END or "streamEnd"
WebcastEvent.ROOM_USER or "roomUser"
WebcastEvent.EMOTE or "emote"
WebcastEvent.FOLLOW or "follow"
WebcastEvent.SHARE or "share"
WebcastEvent.GOAL_UPDATE or "goalUpdate"
WebcastEvent.ROOM_MESSAGE or "roomMessage"
WebcastEvent.CAPTION_MESSAGE or "captionMessage"
WebcastEvent.IM_DELETE or "imDelete"
WebcastEvent.IN_ROOM_BANNER or "inRoomBanner"
WebcastEvent.RANK_UPDATE or "rankUpdate"
WebcastEvent.POLL_MESSAGE or "pollMessage"
WebcastEvent.RANK_TEXT or "rankText"
WebcastEvent.LINK_MIC_BATTLE_PUNISH_FINISH or "linkMicBattlePunishFinish"
WebcastEvent.LINK_MIC_BATTLE_TASK or "linkMicBattleTask"
WebcastEvent.LINK_MIC_FAN_TICKET_METHOD or "linkMicFanTicketMethod"
WebcastEvent.LINK_MIC_METHOD or "linkMicMethod"
WebcastEvent.UNAUTHORIZED_MEMBER or "unauthorizedMember"
WebcastEvent.OEC_LIVE_SHOPPING or "oecLiveShopping"
WebcastEvent.MSG_DETECT or "msgDetect"
WebcastEvent.LINK_MESSAGE or "linkMessage"
WebcastEvent.ROOM_VERIFY or "roomVerify"
WebcastEvent.LINK_LAYER or "linkLayer"
WebcastEvent.ROOM_PIN or "roomPin"

Control Events

`connected`

Triggered when the connection is successfully established.

client.on(
    WebcastEvent.CONNECTED,
    (state: TikTokLiveConnectionState) => console.log('Hurray! Connected!', state)
);

`disconnected`

Triggered when the connection gets disconnected. In that case you can call connect() again to have a reconnect logic.
Note that you should wait a little bit before attempting a reconnect to to avoid being rate-limited.

connection.on(ControlEvent.DISCONNECTED, () => console.log('Disconnected :('));

`streamEnd`

Triggered when the live stream gets terminated by the host. Will also trigger the disconnected event.

connection.on(ControlEvent.STREAM_END, ({ action }: { action: ControlAction }) => {
    if (action === ControlAction.CONTROL_ACTION_STREAM_ENDED) {
        console.log('Stream ended by user');
    }
    if (action === ControlAction.CONTROL_ACTION_STREAM_SUSPENDED) {
        console.log('Stream ended by platform moderator (ban)');
    }
});

`rawData`

Triggered every time a protobuf encoded webcast message arrives. You can deserialize the binary object depending on the
use case with protobufjs.

connection.on(ControlEvent.RAW_DATA, (messageTypeName, binary) => {
    console.log(messageTypeName, binary);
});

`decodedData`

Triggered every time a decoded message arrives. This is the same as the rawData event but the binary object is already
decoded. You can use this event to handle the protobuf messages without the need of deserializing them yourself.

connection.on(ControlEvent.DECODED_DATA, (event: string, decodedData: any, binary: Uint8Array) => {
    console.log(event, decodedData);
});

`websocketConnected`

Will be triggered as soon as a WebSocket connection is established. The WebSocket client object is passed.

connection.on(ControlEvent.WEBSOCKET_CONNECTED, (client: TikTokWsClient) => {
    console.log('WebSocket Client:', websocketClient.connection);
});

`websocketdata`

Triggered every time a WebSocket message arrives. This is the same as the rawData event but the binary object is

`error`

General error event. You should handle this.

connection.on(ControlEvent.ERROR, err => {
    console.error('Error!', err);
});

Message Events

`member`

Triggered every time a new viewer joins the live stream.

connection.on(WebcastEvent.MEMBER, (data: WebcastMemberMessage) => {
    console.log(`${data.uniqueId} joins the stream!`);
});

`chat`

Triggered every time a new chat comment arrives.

connection.on(WebcastEvent.CHAT, (data: WebcastChatMessage) => {
    console.log(`${data.uniqueId} -> ${data.comment}`);
});

`gift`

Triggered every time a gift arrives. You will receive additional information via the extendedGiftInfo attribute when
you enable the enableExtendedGiftInfo option.

connection.on(WebcastEvent.GIFT, (event: WebcastGiftMessage) => {
    if (data.giftType === 1 && !data.repeatEnd) {
        // Streak in progress => show only temporary
        console.log(`${data.uniqueId} is sending gift ${data.giftName} x${data.repeatCount}`);
    } else {
        // Streak ended or non-streakable gift => process the gift with final repeat_count
        console.log(`${data.uniqueId} has sent gift ${data.giftName} x${data.repeatCount}`);
    }
});

`roomUser`

Triggered every time a statistic message arrives. This message currently contains the viewer count and a top gifter
list.

connection.on(WebcastEvent.ROOM_USER, data => {
    console.log(`Viewer Count: ${data.viewerCount}`);
});

`like`

Triggered when a viewer sends likes to the streamer. For streams with many viewers, this event is not always triggered
by TikTok.

connection.on(WebcastEvent.LIKE, data => {
    console.log(`${data.uniqueId} sent ${data.likeCount} likes, total likes: ${data.totalLikeCount}`);
});

`social`

Triggered every time someone shares the stream or follows the host.

connection.on(WebcastEvent.SOCIAL, data => {
    console.log('social event data:', data);
});

`emote`

Triggered every time a subscriber sends an emote (sticker).

connection.on(WebcastEvent.EMOTE, (data: WebcastEmoteChatMessage) => {
    console.log('emote received', data);
});

`envelope`

Triggered every time someone sends a treasure chest.

connection.on(WebcastEvent.ENVELOPE, data => {
    console.log('envelope received', data);
});

`questionNew`

Triggered every time someone asks a new question via the question feature.

connection.on(WebcastEvent.QUESTION_NEW, data => {
    console.log(`${data.uniqueId} asks ${data.questionText}`);
});

`linkMicBattle`

Triggered every time a battle starts.

connection.on(WebcastEvent.LINK_MIC_BATTLE, (data) => {
    console.log(`New Battle: ${data.battleUsers[0].uniqueId} VS ${data.battleUsers[1].uniqueId}`);
});

`linkMicArmies`

Triggered every time a battle participant receives points. Contains the current status of the battle and the army that
suported the group.

connection.on(WebcastEvent.LINK_MIC_ARMIES, (data) => {
    console.log('linkMicArmies', data);
});

`liveIntro`

Triggered when a live intro message appears.

connection.on(WebcastEvent.LIVE_INTRO, (msg) => {
    console.log(msg);
});

`subscribe`

Triggers when a user creates a subscription.

connection.on(WebcastEvent.SUBSCRIBE, (data) => {
    console.log(data.uniqueId, 'subscribed!');
});

Custom Events

These events are based on message events.

`follow`

Triggers when a user follows the streamer. Based on social event.

connection.on(WebcastEvent.FOLLOW, (data) => {
    console.log(data.uniqueId, 'followed!');
});

`share`

Triggers when a user shares the stream. Based on social event.

connection.on(WebcastEvent.SHARE, (data) => {
    console.log(data.uniqueId, "shared the stream!");
})

`goalUpdate`

Triggered when a channel goal is updated.

`roomMessage`

No information available.

`captionMessage`

No information available.

`imDelete`

Triggered when a message is deleted in the chat.

`inRoomBanner`

Triggered when a banner is shown in the room.

`rankUpdate`

Triggered when a ranking update is received.

`pollMessage`

Triggered when a poll-related message is sent in the room.

`rankText`

Triggered when text related to rankings is displayed.

`linkMicBattlePunishFinish`

Triggered when a link mic battle punishment is finished.

`linkMicBattleTask`

Triggered when a new task is issued during a link mic battle.

`linkMicFanTicketMethod`

Triggered when a fan ticket-related method is invoked during a link mic session.

`linkMicMethod`

Triggered when a link mic method is used.

`unauthorizedMember`

Triggered when an unauthorized member tries to perform a restricted action.

`oecLiveShopping`

Triggered when a live shopping event occurs.

`msgDetect`

Triggered when the system detects a message for moderation or other purposes.

`linkMessage`

Triggered during a link mic session for various communication purposes.

`roomVerify`

Triggered when the system performs room verification.

`linkLayer`

Triggered when a new link mic layer is added or updated.

`roomPin`

Triggered when a message is pinned in the chat room.

Examples

Retrieve Room Info

const connection = new TikTokLiveConnection('@username');

connection.fetchRoomInfo().then((roomInfo: RoomInfoResponse) => {
    console.log(roomInfo);
    console.log(`Stream started timestamp: ${roomInfo.create_time}, Streamer bio: ${roomInfo.owner.bio_description}`);
    console.log(`HLS URL: ${roomInfo.stream_url.hls_pull_url}`); // Can be played or recorded with e.g. VLC
}).catch(err => {
    console.error(err);
});

Retrieve Available Gifts

const connection = new TikTokLiveConnection('@username');

connection.fetchAvailableGifts().then((giftList: RoomGiftInfo) => {
    console.log(giftList);
    giftList.forEach(gift => {
        console.log(`id: ${gift.id}, name: ${gift.name}, cost: ${gift.diamond_count}`)
    });
}).catch(err => {
    console.error(err);
})

Proxied Connection

It is possible to proxy connections. The library proxy-agent
supports http, https, socks4 and socks5 proxies:

npm i proxy-agent

You can specify if you want to use a proxy for https requests, websockets or both:

import { TikTokLiveConnection } from 'tiktok-live-connector';
import ProxyAgent from 'proxy-agent';

const connection = new TikTokLiveConnection('@username', {
    webClientOptions: {
        httpsAgent: new ProxyAgent('https://username:password@host:port'),
        timeout: 10000 // 10 seconds
    },
    wsClientOptions: {
        agent: new ProxyAgent('https://username:password@host:port'),
        timeout: 10000 // 10 seconds
    }
});

// Connect as per usual

Authenticated Connection

You can connect to the TikTok LIVE with a specific account. To do so, log into your browser & into TikTok.
Then, simply extract the sessionid and tt-target-idc cookies. Both are needed to connect.

One is your account’s session token (keep this secret!), and the other is the datacenter the account is located in. This
tells TikTok where to look for your session, and is based
on your region (i.e. EU and NA will have different cookies, but all NA users will have the same cookie, such
as useast1a).

import { TikTokLiveConnection } from 'tiktok-live-connector';
import { connection } from 'websocket';

const connection = new TikTokLiveConnection(
    'tv_asahi_news',
    {
        sessionId: '<account_session_id>',
        ttTargetIdc: '<account_target_idc>',
    }
);

// Connect, then send a chat!
connection.connect().then(() => {
    connection.sendMessage('Connected');
    console.log('Connected to TikTok LIVE chat!');
}).catch(err => {
    console.error('Error connecting to TikTok LIVE chat:', err);
});

Send Messages

As of 2.0.2 you can now send messages to TikTok LIVE chats!

import { TikTokLiveConnection } from 'tiktok-live-connector';
import { connection } from 'websocket';

// Include in options
const connection = new TikTokLiveConnection(
    'tv_asahi_news',
    {
        sessionId: '<account_session_id>',
        ttTargetIdc: '<account_target_idc>'
    }
);

// OR, set it afterwards
connection.webClient.cookieJar.setSession('<account_session_id>', '<account_target_idc>');

// Connect, then send a chat!
connection.connect().then(async () => {
    await connection.sendMessage('Hello world!');
    console.log('Connected to TikTok LIVE chat!');
}).catch(err => {
    console.error('Error connecting to TikTok LIVE chat:', err);
});

Contributors

Zerody - Initial Reverse-Engineering and Protobuf-Decoding - Zerody
Isaac Kogan - TypeScript Rewrite, Sign-Server Maintainer - isaackogan

License

This project is licensed under the MIT License. See the LICENSE file for details.

TikTok Live Connector

TikTok-Live-Connector

📌 2.X.X Now Available - Upgrade Now!

Upgrade Guide

Breaking Changes

Do you prefer other programming languages?

Table of Contents

Getting Started

Params and Options

Example Options

Methods

Properties

Signing Configuration

Accessing TikTok LIVE Routes

Example Usage:

Accessing 3rd-Party Routes

Example 1: Fetching Rate Limits

Example 2: Using JWT Authentication

Server-Side:

Client-Side:

Events

Control Events:

Message Events:

Control Events

connected

disconnected

streamEnd

rawData

decodedData

websocketConnected

websocketdata

error

Message Events

member

chat

gift

roomUser

like

social

emote

envelope

questionNew

linkMicBattle

linkMicArmies

liveIntro

subscribe