README.md

⚠ WARNING

This is a future version still in development. For a stable version, check out the versions/4.5 branch.

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 EventSub
• 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/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 💻

This project follows the all-contributors specification. Contributions of any kind welcome!