@gbrlstr/kick-flow

v1.0.5

Published

5 months ago

A modern TypeScript library for the Kick.com API with automatic OAuth 2.1 management.

0High
0Medium
0Low

gbrldev

kick kick.com api client streaming typescript oauth zero-dependency auth bot

Kick Flow

This project is not affiliated with or endorsed by Kick.com API. This is an independent, community-driven library for interacting with the Kick.com API.

A modern TypeScript library for the Kick.com API with real-time WebSocket chat support.

✨ Features

🔧 Zero Dependencies - Built with Node.js native APIs
📝 Full TypeScript Support - Complete type definitions
🔐 OAuth 2.1 + PKCE - Automatic token management
🏗️ Modular Design - Organized API endpoints
🚀 Production Ready - Comprehensive error handling
💬 Real-time Chat - WebSocket connection to Kick.com chat events
🔄 Auto-reconnection - Automatic WebSocket reconnection with retry logic
🎯 Multi-chat Support - Connect to multiple chat rooms simultaneously
🛡️ Cloudflare Bypass - Automatic handling of Kick.com's protection

📦 Installation

npm install @gbrlstr/kick-flow

🚀 Quick Start

Basic API Usage

import { KickFlow } from '@gbrlstr/kick-flow';

const client = new KickFlow({
  clientId: 'your-client-id',
  clientSecret: 'your-client-secret',
});

// Get channel information
const channel = await client.channels.getChannel('gbrldev');
console.log(`${channel.user.username} has ${channel.followers_count} followers`);

// Get top live streams
const streams = await client.livestreams.getLivestreams({
  sort: 'viewer_count',
  limit: 10
});

Real-time Chat

// Connect to chat using channel name
const chatWS = await client.chat.connectToChatByChannel('gbrldev');

// Listen for messages
chatWS.on('message', (message) => {
  console.log(`${message.sender.username}: ${message.content}`);
});

// Connect to WebSocket
await chatWS.connect();

📖 Examples

We provide comprehensive examples for different use cases:

🔥 Simple API Usage

Basic demonstration of all API endpoints:

pnpm tsx examples/simple-api.ts

💬 WebSocket Chat

Real-time chat monitoring with automatic channel lookup:

pnpm tsx examples/websocket-simple.ts

⚡ Direct WebSocket

Fast connection using direct chatroom IDs:

pnpm tsx examples/websocket-direct.ts

🧠 Advanced API

Error handling, batch operations, and analytics:

pnpm tsx examples/advanced-api.ts

💡 Pro tip: Start with simple-api.ts to understand the basics, then try websocket-simple.ts for real-time chat!

🔐 Authentication

Bot Mode (Server-to-Server)

const client = new KickFlow({
  clientId: 'your-client-id',
  clientSecret: 'your-client-secret',
});

User Authentication (OAuth 2.1)

const client = new KickFlow({
  clientId: 'your-client-id',
  clientSecret: 'your-client-secret',
  redirectUri: 'http://localhost:3000/callback',
});

// Generate auth URL
const pkceParams = client.generatePKCEParams();
const authUrl = client.getAuthorizationUrl(pkceParams, ['public', 'chat:write']);

// Exchange code for token
const token = await client.exchangeCodeForToken({
  code: authorizationCode,
  codeVerifier: pkceParams.codeVerifier,
});

📡 API Reference

📺 Channels

// Get channel information (includes followers, live status, etc.)
const channel = await client.channels.getChannel('username');

// Get multiple channels
const channels = await client.channels.getChannels({ 
  slug: ['user1', 'user2'] 
});

🎮 Categories

// Search categories
const categories = await client.categories.getCategories({ q: 'gaming' });

// Get specific category
const category = await client.categories.getCategory(1);

🔴 Livestreams

// Get live streams with filters
const streams = await client.livestreams.getLivestreams({
  category_id: 1,
  language: 'en',
  sort: 'viewer_count',
  limit: 20
});

💬 Real-time Chat (WebSocket)

Connect by Channel Name (Recommended)

// Automatically gets chatroom ID and connects
const chatWS = await client.chat.connectToChatByChannel('channelname');

// Listen for events
chatWS.on('message', (message) => {
  console.log(`${message.sender.username}: ${message.content}`);
});

chatWS.on('user_joined', (user) => {
  console.log(`${user.username} joined!`);
});

chatWS.on('subscription', (sub) => {
  console.log(`${sub.username} subscribed for ${sub.months} months!`);
});

// Connect
await chatWS.connect();

Direct Connection (Faster)

// Connect using known chatroom ID (faster, no API call)
const chatWS = client.chat.connectToChat(12345678);
await chatWS.connect();

Finding Chatroom IDs

If you prefer direct connections, you can find chatroom IDs manually:

Open kick.com in your browser
Navigate to a channel (e.g., kick.com/xqc)
Open Developer Tools (F12)
Go to Network tab
Look for WebSocket connections or API calls
Extract the chatroom ID from the response

Or run: pnpm tsx examples/websocket-direct.ts guide

⚠️ Error Handling

The library provides specific error types for different scenarios:

import {
  KickFlow,
  KickOAuthError,
  KickNotFoundError,
  KickRateLimitError,
} from '@gbrlstr/kick-flow';

try {
  const result = await client.categories.getCategories({ q: 'gaming' });
} catch (error) {
  if (error instanceof KickOAuthError) {
    console.log('OAuth failed:', error.responseBody);
  } else if (error instanceof KickNotFoundError) {
    console.log('Resource not found');
  } else if (error instanceof KickRateLimitError) {
    console.log('Rate limited, retry after:', error.retryAfter, 'seconds');
  }
}

🛠️ Configuration

interface KickFlowConfig {
  clientId: string;           // Kick app client ID
  clientSecret: string;       // Kick app client secret
  redirectUri?: string;       // OAuth redirect URI (optional for bot mode)
  baseUrl?: string;          // API base URL (default: https://api.kick.com)
  oauthUrl?: string;         // OAuth URL (default: https://id.kick.com)
  debug?: boolean;           // Enable debug logging (default: false)
}

🎯 WebSocket Events

The WebSocket client supports all Kick.com chat events:

message - Chat messages (includes replies, emotes)
user_joined / user_left - User presence
subscription - New subscriptions
gift_subscription - Gift subscriptions
chatroom_updated - Chat settings changes
connect / disconnect - Connection status
error - Connection errors