Twurple

A set of libraries that aims to cover all of the existing Twitch APIs.

Query the Kraken v5 & Helix APIs
Build a chat bot
React to custom redemptions, subscriptions, follows and much more using PubSub and WebHooks
Do all this without caring about the expiry of your access tokens - we can refresh them automatically

Installation

To add Twurple to your project, just execute:

yarn add @twurple/auth

or using npm:

npm install @twurple/auth

Documentation

A good place to start with this library is the documentation which also includes a complete reference of all classes and interfaces, as well as changes and deprecations between major versions.

Additional packages

The mentioned @twurple/auth package only provides authentication functionality. All the other things are located in separate packages:

@twurple/api - make calls to the Kraken and Helix APIs
@twurple/chat - connect to and interact with Twitch Chat
@twurple/pubsub - listen to events using the Twitch PubSub interface
@twurple/webhooks - listen to events using WebHooks
@twurple/eventsub - listen to events using EventSub

If you're getting stuck...

You can join the Discord server for support.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

_{Daniel Fischer} 💻 📖 💡 🚇 🚧 👀 🔧	_{Martin Giger} 💻 💬	_{Jakub Kohout} 💻	_{Joe Lafiosca} 💻	_{Dustin Dawes} 💻	_{Jasper Abbink} 💻	_lclc98 💻
_{Haley Hitch} 💻	_Akira 💻	_{Lewis Gibson} 💻	_{VyrtualSynthese} 💻	_{Nick Ferraro} 💻	_{Jacob Foster} 💬 💻	_{Aaron Kc Hsu} 💻
_{Erik Guzman} 💻	_Trezy 💻	_{Travis Tarr} 💻	_{Grégoire Joncour} 💻	_{Maciej Trębacz} 💻	_{Justus Fluegel} 💻	_{Daniel Huber} 💻
_Adam 💻	_{Corbin Crutchley} 💻	_{Sam Hirst} 💻	_Cλctysman 💻