twurple

Twurple

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

• Query the Helix API
• 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 Helix API
• @twurple/chat - connect to and interact with Twitch Chat
• @twurple/pubsub - listen to events using the Twitch PubSub interface
• @twurple/eventsub-http - listen to events using EventSub over HTTP/WebHooks
• @twurple/eventsub-ws - listen to events using EventSub over WebSockets

If you're getting stuck...

You can join the Twitch API Libraries Discord Server and ask in #twurple for support.

Special thanks

• discord.js for major inspiration on the structure of the libraries (or, as it was back then, the library)
• All the people who contributed to Twurple
• My sponsors (maybe you want to become one too?)