This documentation provides detailed guides and examples for using the Twitch Helix API wrapper.
- Quick Start - Installation, basic usage, authentication, and error handling
- Helix API - All API endpoints
- IRC Client - Real-time chat for bots
- Advanced Features - Batch operations, caching, EventSub
- Examples - Working code samples
| Category | Documentation |
|---|---|
| Ads | Start commercials, manage ad schedules |
| Analytics | Extension and game analytics |
| Auth | OAuth flows, token management, OIDC |
| Bits | Bits leaderboard, cheermotes |
| Channel Points | Custom rewards, redemptions |
| Channels | Channel info, followers, editors, VIPs |
| Charity | Charity campaigns and donations |
| Chat | Chatters, emotes, badges, settings, messages |
| Clips | Create and get clips |
| CCL | Content classification labels |
| Conduits | EventSub conduit management |
| Entitlements | Drops entitlements |
| Extensions | Extension management |
| Games | Game information |
| Goals | Creator goals |
| Guest Star | Guest star sessions |
| Hype Train | Hype train events and status |
| Ingest | Ingest server endpoints |
| Moderation | Bans, mods, AutoMod, shield mode |
| Polls | Create and manage polls |
| Predictions | Create and manage predictions |
| Raids | Start and cancel raids |
| Schedule | Stream schedule management |
| Search | Search categories and channels |
| Streams | Stream info, markers |
| Subscriptions | Subscriber info |
| Teams | Team information |
| Users | User info, blocks, extensions |
| Videos | VODs, highlights, uploads |
| Whispers | Send whisper messages |
| Category | Documentation |
|---|---|
| IRC Client | WebSocket-based chat client for building bots |
| Category | Documentation |
|---|---|
| EventSub | Event subscriptions (WebSocket & Webhooks) |
| PubSub Compatibility | PubSub-style API backed by EventSub |
| Advanced | Batch operations, rate limiting, caching, middleware |
See the examples directory for code samples:
- Basic Usage - Simple API calls and error handling
- Chat Bot - Building a chat bot
- API Usage - Common API patterns
- EventSub Webhooks - Webhook notifications
- EventSub WebSocket - Real-time events
- PubSub Migration - Migrating from PubSub to EventSub
- Extension JWT - Extension authentication