About this project

TikTok LIVE API for Node.js is an unofficial, reverse-engineered client that connects to TikTok LIVE streams and delivers real-time webcast events. It is not affiliated with ByteDance and is explicitly described as not production-ready; the README points to a hosted WebSocket API for production use. Key capabilities: - Connect to any creator's live stream using only their username (@uniqueId), with no login, credentials or app registration required. - Receive real-time events including chat comments, member joins, gifts, likes, follows, shares, questions, super fans, viewer counts and link-mic battles. - Emit raw and decoded protobuf messages, plus control events for connect, disconnect, WebSocket open, WebSocket data and errors. - Methods for room-id resolution, live-status checks, waiting until a streamer goes live, fetching room info and fetching the available gift list. - Options for authenticated WebSocket sessions, mobile WebSocket flow, extended gift info, initial data processing, custom HTTP/WebSocket client options and config overrides. - Route registry (RouteConfig) with individually exported handlers for TikTok webcast/web APIs, HTML scraping and Euler Stream provider endpoints; handlers can be swapped for caching or custom signing. - Signing is delegated to the Euler Stream sign server via the @eulerstream/euler-api-sdk package, configurable through SignConfig or a signApiKey option; JWT authentication is supported for client-facing deployments. - Docker usage is mentioned, and rewrites exist for Python, Java, Go and C#. Typical uses suggested by the README include TikTok chat bots, gift trackers, OBS overlays, donation alerts, moderation tools and livestream analytics. An example chat reader project is linked.