tiktok-live-api 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +72 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -54,6 +54,78 @@ client.connect();
54
54
 
55
55
  That's it. **No complex setup, no protobuf, no reverse engineering, no breakages when TikTok updates.**
56
56
 
57
+ ---
58
+
59
+ ## šŸš€ Try It Now — 60-Second Live Demo
60
+
61
+ Copy-paste this into a file and run it. Connects to a live TikTok stream, prints every event for 60 seconds, then exits. Works on the free Sandbox tier.
62
+
63
+ **Save as `demo.mjs` and run with `node demo.mjs`:**
64
+
65
+ ```javascript
66
+ // demo.mjs — TikTok LIVE in 60 seconds
67
+ // npm install tiktok-live-api
68
+ import { TikTokLive } from 'tiktok-live-api';
69
+
70
+ const API_KEY = 'YOUR_API_KEY'; // Get free key → https://tik.tools
71
+ const LIVE_USERNAME = 'tv_asahi_news'; // Any live TikTok username
72
+
73
+ const client = new TikTokLive(LIVE_USERNAME, { apiKey: API_KEY });
74
+ let events = 0;
75
+
76
+ client.on('chat', e => { events++; console.log(`šŸ’¬ ${e.user.uniqueId}: ${e.comment}`); });
77
+ client.on('gift', e => { events++; console.log(`šŸŽ ${e.user.uniqueId} sent ${e.giftName} (${e.diamondCount}šŸ’Ž)`); });
78
+ client.on('like', e => { events++; console.log(`ā¤ļø ${e.user.uniqueId} liked Ɨ ${e.likeCount}`); });
79
+ client.on('member', e => { events++; console.log(`šŸ‘‹ ${e.user.uniqueId} joined`); });
80
+ client.on('follow', e => { events++; console.log(`āž• ${e.user.uniqueId} followed`); });
81
+ client.on('roomUserSeq', e => { events++; console.log(`šŸ‘€ Viewers: ${e.viewerCount}`); });
82
+
83
+ client.on('connected', () => console.log(`\nāœ… Connected to @${LIVE_USERNAME} — listening for 60s...\n`));
84
+ client.on('disconnected', () => console.log(`\nšŸ“Š Done! Received ${events} events.\n`));
85
+
86
+ client.connect();
87
+ setTimeout(() => { client.disconnect(); }, 60_000);
88
+ ```
89
+
90
+ <details>
91
+ <summary><strong>šŸ”Œ Pure WebSocket version (no SDK, any language)</strong></summary>
92
+
93
+ ```javascript
94
+ // ws-demo.mjs — Pure WebSocket, zero SDK
95
+ // npm install ws
96
+ import WebSocket from 'ws';
97
+
98
+ const API_KEY = 'YOUR_API_KEY';
99
+ const LIVE_USERNAME = 'tv_asahi_news';
100
+
101
+ const ws = new WebSocket(`wss://api.tik.tools?uniqueId=${LIVE_USERNAME}&apiKey=${API_KEY}`);
102
+ let events = 0;
103
+
104
+ ws.on('open', () => console.log(`\nāœ… Connected to @${LIVE_USERNAME} — listening for 60s...\n`));
105
+ ws.on('message', (raw) => {
106
+ const msg = JSON.parse(raw);
107
+ events++;
108
+ const d = msg.data || {};
109
+ const user = d.user?.uniqueId || '';
110
+ switch (msg.event) {
111
+ case 'chat': console.log(`šŸ’¬ ${user}: ${d.comment}`); break;
112
+ case 'gift': console.log(`šŸŽ ${user} sent ${d.giftName} (${d.diamondCount}šŸ’Ž)`); break;
113
+ case 'like': console.log(`ā¤ļø ${user} liked Ɨ ${d.likeCount}`); break;
114
+ case 'member': console.log(`šŸ‘‹ ${user} joined`); break;
115
+ case 'roomUserSeq': console.log(`šŸ‘€ Viewers: ${d.viewerCount}`); break;
116
+ case 'roomInfo': console.log(`šŸ“” Room: ${msg.roomId}`); break;
117
+ default: console.log(`šŸ“¦ ${msg.event}`); break;
118
+ }
119
+ });
120
+ ws.on('close', () => console.log(`\nšŸ“Š Done! Received ${events} events.\n`));
121
+
122
+ setTimeout(() => ws.close(), 60_000);
123
+ ```
124
+
125
+ </details>
126
+
127
+ ---
128
+
57
129
  ## JavaScript (CommonJS)
58
130
 
59
131
  ```javascript
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tiktok-live-api",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "Unofficial TikTok LIVE API Client — Real-time chat, gifts, viewers, battles, and AI live captions from any TikTok livestream. Managed WebSocket API with 99.9% uptime.",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",