Node.js module to receive live stream chat events like comments and gifts from TikTok LIVE. 

Node.js module to receive live stream chat events like comments and gifts from TikTok LIVE

zerodytrash

tiktok-live-connector

const { WebcastPushConnection, signatureProvider } = require('tiktok-live-connector');

// signatureProvider.signEvents.on('signSuccess', (data) => console.log(data));

signatureProvider.config.extraParams.apiKey = 'NDA2NDA5OTI3N2M4OTE0OGQ3NWEzOWQxMTg2NzFmODViYTIxN2NkNzYwNDdiYThkZWE3ZGM2';	

// Username of someone who is currently live

// Create a new wrapper object and pass the username

let tiktokLiveConnection = new WebcastPushConnection(tiktokUsername);

// Connect to the chat (await can be used as well)

tiktokLiveConnection.connect().then(state => {

    console.info(`Connected to roomId ${state.roomId}`);

    console.error('Failed to connect', err);

// Define the events that you want to handle

// In this case we listen to chat messages (comments)

tiktokLiveConnection.on('chat', data => {

    console.log(`${data.uniqueId} (userId:${data.userId}) writes: ${data.comment}`);

// And here we receive gifts sent to the streamer

tiktokLiveConnection.on('gift', data => {

    console.log(`${data.uniqueId} (userId:${data.userId}) sends ${data.giftId}`);

function _classPrivateMethodInitSpec(obj, privateSet) { _checkPrivateRedeclaration(obj, privateSet); privateSet.add(obj); }

function _classPrivateFieldInitSpec(obj, privateMap, value) { _checkPrivateRedeclaration(obj, privateMap); privateMap.set(obj, value); }

function _checkPrivateRedeclaration(obj, privateCollection) { if (privateCollection.has(obj)) { throw new TypeError("Cannot initialize the same private elements twice on an object"); } }

function _classPrivateFieldGet(receiver, privateMap) { var descriptor = _classExtractFieldDescriptor(receiver, privateMap, "get"); return _classApplyDescriptorGet(receiver, descriptor); }

function _classApplyDescriptorGet(receiver, descriptor) { if (descriptor.get) { return descriptor.get.call(receiver); } return descriptor.value; }

function _classPrivateFieldSet(receiver, privateMap, value) { var descriptor = _classExtractFieldDescriptor(receiver, privateMap, "set"); _classApplyDescriptorSet(receiver, descriptor, value); return value; }

function _classExtractFieldDescriptor(receiver, privateMap, action) { if (!privateMap.has(receiver)) { throw new TypeError("attempted to " + action + " private field on non-instance"); } return privateMap.get(receiver); }

function _classPrivateMethodGet(receiver, privateSet, fn) { if (!privateSet.has(receiver)) { throw new TypeError("attempted to get private field on non-instance"); } return fn; }

const TikTokHttpClient = require('./lib/tiktokHttpClient.js');

const WebcastWebsocket = require('./lib/webcastWebsocket.js');

} = require('./lib/webcastDataConverter.js');

const Config = require('./lib/webcastConfig.js');

 * Wrapper class for TikTok's internal Webcast Push Service

var _options = /*#__PURE__*/new WeakMap();

var _uniqueStreamerId = /*#__PURE__*/new WeakMap();

var _roomId = /*#__PURE__*/new WeakMap();

var _roomInfo = /*#__PURE__*/new WeakMap();

var _clientParams = /*#__PURE__*/new WeakMap();

var _httpClient = /*#__PURE__*/new WeakMap();

var _availableGifts = /*#__PURE__*/new WeakMap();

var _websocket = /*#__PURE__*/new WeakMap();

var _isConnecting = /*#__PURE__*/new WeakMap();

var _isConnected = /*#__PURE__*/new WeakMap();

var _isPollingEnabled = /*#__PURE__*/new WeakMap();

      if (roomData.statusCode) throw new Error(`API Error ${roomData.statusCode} (${roomData.message || 'Unknown Error'})`);

      _classPrivateFieldSet(this, _roomId, roomData.data.user.roomId);

      _classPrivateFieldGet(this, _clientParams).room_id = roomData.data.user.roomId;

    throw new Error(`Failed to retrieve room_id from page source. ${err.message}`);

    let response = await _classPrivateFieldGet(this, _httpClient).getJsonObjectFromWebcastApi('room/info/', _classPrivateFieldGet(this, _clientParams));

    _classPrivateFieldSet(this, _roomInfo, response.data);

    throw new Error(`Failed to fetch room info. ${err.message}`);

    let response = await _classPrivateFieldGet(this, _httpClient).getJsonObjectFromWebcastApi('gift/list/', _classPrivateFieldGet(this, _clientParams));

    _classPrivateFieldSet(this, _availableGifts, response.data.gifts);

    throw new Error(`Failed to fetch available gifts. ${err.message}`);

async function _startFetchRoomPolling2() {

  _classPrivateFieldSet(this, _isPollingEnabled, true);

  let sleepMs = ms => new Promise(resolve => setTimeout(resolve, ms));

  while (_classPrivateFieldGet(this, _isPollingEnabled)) {

      await _classPrivateMethodGet(this, _fetchRoomData, _fetchRoomData2).call(this, false);

      _classPrivateMethodGet(this, _handleError, _handleError2).call(this, err, 'Error while fetching webcast data via request polling');

    await sleepMs(_classPrivateFieldGet(this, _options).requestPollingIntervalMs);

async function _fetchRoomData2(isInitial) {

  let webcastResponse = await _classPrivateFieldGet(this, _httpClient).getDeserializedObjectFromWebcastApi('im/fetch/', _classPrivateFieldGet(this, _clientParams), 'WebcastResponse', isInitial);

  let upgradeToWsOffered = !!webcastResponse.wsUrl;

      throw new Error('Missing cursor in initial fetch response.');

      _classPrivateMethodGet(this, _handleError, _handleError2).call(this, null, 'Missing cursor in fetch response.');

  } // Set cursor and internal_ext param to continue with the next request

  if (webcastResponse.cursor) _classPrivateFieldGet(this, _clientParams).cursor = webcastResponse.cursor;

  if (webcastResponse.internalExt) _classPrivateFieldGet(this, _clientParams).internal_ext = webcastResponse.internalExt;

    // Upgrade to Websocket offered? => Try upgrade

    if (_classPrivateFieldGet(this, _options).enableWebsocketUpgrade && upgradeToWsOffered) {

      await _classPrivateMethodGet(this, _tryUpgradeToWebsocket, _tryUpgradeToWebsocket2).call(this, webcastResponse);

  } // Skip processing initial data if option disabled

  if (isInitial && !_classPrivateFieldGet(this, _options).processInitialData) {

  _classPrivateMethodGet(this, _processWebcastResponse, _processWebcastResponse2).call(this, webcastResponse);

async function _tryUpgradeToWebsocket2(webcastResponse) {

      imprp: ((_webcastResponse$wsPa = webcastResponse.wsParam) === null || _webcastResponse$wsPa === void 0 ? void 0 : _webcastResponse$wsPa.value) || '',

    }; // Wait until ws connected, then stop request polling

    await _classPrivateMethodGet(this, _setupWebsocket, _setupWebsocket2).call(this, webcastResponse.wsUrl, wsParams);

    _classPrivateFieldSet(this, _isWsUpgradeDone, true);

    _classPrivateFieldSet(this, _isPollingEnabled, false);

    this.emit(ControlEvents.WSCONNECTED, _classPrivateFieldGet(this, _websocket));

    _classPrivateMethodGet(this, _handleError, _handleError2).call(this, err, 'Upgrade to websocket failed');

async function _setupWebsocket2(wsUrl, wsParams) {

  return new Promise((resolve, reject) => {

  "description": "Node.js module to receive live stream chat events like comments and gifts from TikTok LIVE",

    "test": "echo \"Error: no test specified\" && exit 1",

    "format": "prettier --write src/**/*.js",

    "build": "babel src -d dist --copy-files && npx tsc"

    "url": "git+https://github.com/zerodytrash/TikTok-Live-Connector.git"

      "url": "https://www.patreon.com/zerody"

    "url": "https://github.com/zerodytrash/TikTok-Live-Connector/issues"

  "homepage": "https://github.com/zerodytrash/TikTok-Live-Connector#readme",

A Node.js library to receive live stream events such as comments and gifts in realtime from [TikTok LIVE](https://www.tiktok.com/live) by connecting to TikTok's internal WebCast push service. The 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](#chat), other events such as [Members Joining](#member), [Gifts](#gift), [Subscriptions](#subscribe), [Viewers](#roomuser), [Follows](#social), [Shares](#social), [Questions](#questionnew), [Likes](#like) and [Battles](#linkmicbattle) can be tracked. You can also send [automatic messages](#send-chat-messages) into the chat by providing your Session ID.

### Example Project: [https://tiktok-chat-reader.zerody.one/](https://tiktok-chat-reader.zerody.one/)

Do you prefer other programming languages?

- **Python** rewrite: [TikTokLive](https://github.com/isaackogan/TikTokLive) by [@isaackogan](https://github.com/isaackogan)

- **Java** rewrite: [TikTokLiveJava](https://github.com/jwdeveloper/TikTokLiveJava) by [@jwdeveloper](https://github.com/jwdeveloper)

- **C#** rewrite: [TikTokLiveSharp](https://github.com/frankvHoof93/TikTokLiveSharp) by [@frankvHoof93](https://github.com/frankvHoof93)

- **Go** rewrite: [GoTikTokLive](https://github.com/Davincible/gotiktoklive) by [@Davincible](https://github.com/Davincible)

**NOTE:** This is not an official API. It's a reverse engineering project.

**NOTE:** This JavaScript library is intended for use in [Node.js](https://nodejs.org/) environments. If you want to process or display the data in the browser (client-side), you need to transfer the data from the Node.js environment to the browser. A good approach for this is to use [Socket.IO](https://socket.io/) or a different low-latency communication framework. A complete example project can be found here: [TikTok-Chat-Reader](https://github.com/zerodytrash/TikTok-Chat-Reader)

> **UPDATE**: Due to a change on the part of TikTok, versions prior **v0.9.23** are no longer functional. If you are using one of these versions, upgrade to the latest version using the `npm update` command.

- [Params and options](#params-and-options)

const { WebcastPushConnection } = require('tiktok-live-connector');

let tiktokUsername = "officialgeilegisela";

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

To create a new `WebcastPushConnection` object the following parameters are required.

`WebcastPushConnection(uniqueId, [options])`

| 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. `fetchRoomInfoOnConnect` (default: `true`) Define if you want to fetch all room information on [`connect()`](#methods). 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()`](#methods) 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](#gift). `enableWebsocketUpgrade` (default: `true`) Define if you want to use a WebSocket connection instead of request polling if TikTok offers it. `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 (**sessionid** cookie value) if you want to send automated chat messages via the [`sendMessage()`](#methods) function. See [Example](#send-chat-messages) `clientParams` (default: `{}`) Custom client params for Webcast API. `requestHeaders` (default: `{}`) Custom request headers passed to [axios](https://github.com/axios/axios). `websocketHeaders` (default: `{}`) Custom websocket headers passed to [websocket.client](https://github.com/theturtle32/WebSocket-Node). `requestOptions` (default: `{}`) Custom request options passed to [axios](https://github.com/axios/axios). Here you can specify an `httpsAgent` to use a proxy and a `timeout` value. See [Example](#connect-via-proxy). `websocketOptions` (default: `{}`) Custom websocket options passed to [websocket.client](https://github.com/theturtle32/WebSocket-Node). Here you can specify an `agent` to use a proxy and a `timeout` value. See [Example](#connect-via-proxy). |

let tiktokLiveConnection = new WebcastPushConnection(tiktokUsername, {

> Due to the increased signature requirements by TikTok, sending chat messages is currently not possible.

You can send chat messages via the [`sendMessage()`](#methods) function to automatically respond to chat commands for example. For this you need to provide your Session ID. 

To get the Session ID from your account, open TikTok in your web browser and make sure you are logged in, then press F12 to open the developer tools. Switch to the **Application** tab and select **Cookies** on the left side. Then take the value of the cookie with the name **`sessionid`**.

WARNING: Use of this function is at your own risk. Spamming messages can lead to the suspension of your TikTok account. Be careful!

let tiktokLiveConnection = new WebcastPushConnection('@username', {

    sessionId: 'f7fbba3a57e48dd1ecd0b7b72cb27e6f' // Replace this with the Session ID of your TikTok account

tiktokLiveConnection.connect().catch(err => console.log(err));

    if (data.comment.toLowerCase() === '!dice') {

        let diceResult = Math.ceil(Math.random() * 6);

        tiktokLiveConnection.sendMessage(`@${data.uniqueId} you rolled a ${diceResult}`).catch(err => console.error(err));

[proxy-agent](https://www.npmjs.com/package/proxy-agent) supports `http`, `https`, `socks4` and `socks5` proxies:

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

const ProxyAgent = require('proxy-agent');

        httpsAgent: new ProxyAgent('https://username:password@host:port'),

        agent: new ProxyAgent('https://username:password@host:port'),

Your improvements are welcome! Feel free to open an <a href="https://github.com/zerodytrash/TikTok-Live-Connector/issues">issue</a> or <a href="https://github.com/zerodytrash/TikTok-Live-Connector/pulls">pull request</a>.

		@@ -8,3 +8,3 @@ const { WebcastPushConnection, signatureProvider } = require('tiktok-live-connector');
		// Username of someone who is currently live
		let tiktokUsername = "deryaoffiziell";
		let tiktokUsername = "lazyzerodyf";

		@@ -11,0 +11,0 @@ // Create a new wrapper object and pass the username

		@@ -525,2 +525,3 @@ "use strict";
		});
		if (roomData.statusCode) throw new Error(`API Error ${roomData.statusCode} (${roomData.message \|\| 'Unknown Error'})`);

		@@ -527,0 +528,0 @@ _classPrivateFieldSet(this, _roomId, roomData.data.user.roomId);

		{
		"name": "tiktok-live-connector",
		"version": "1.1.4",
		"version": "1.1.5",
		"description": "Node.js module to receive live stream chat events like comments and gifts from TikTok LIVE",
		@@ -5,0 +5,0 @@ "main": "index.js",

		@@ -1658,2 +1658,4 @@ # TikTok-Live-Connector
		### Send Chat Messages
		> Due to the increased signature requirements by TikTok, sending chat messages is currently not possible.

		You can send chat messages via the [`sendMessage()`](#methods) function to automatically respond to chat commands for example. For this you need to provide your Session ID.
		@@ -1660,0 +1662,0 @@

Improved metrics