twitch easy-twitch-bot twitch-auth twitch-auth-tmi twitch-chat-client twitch-eventsub twitch-pubsub-client twitch-webhooks

Basic usage

Getting started Creating a client instance Calling the Twitch API FAQ

Upgrading

Upgrading to 2.x Upgrading to 3.x Upgrading to 4.x

Classes

ApiClient BadgesApi BitsApi Channel ChannelApi ChannelFollow ChannelPlaceholder ChannelSubscription ChatApi ChatBadgeList ChatBadgeSet ChatBadgeVersion ChatEmote ChatEmoteList ChattersList CheermoteList ConfigError CreatedVideo EmoteSetList HelixApiGroup HelixBan HelixBanEvent HelixBitsApi HelixBitsLeaderboard HelixBitsLeaderboardEntry HelixChannel HelixChannelApi HelixChannelEditor HelixChannelEmote HelixChannelPointsApi HelixChannelSearchResult HelixChatApi HelixChatBadgeSet HelixChatBadgeVersion HelixCheermoteList HelixClip HelixClipApi HelixCustomReward HelixCustomRewardRedemption HelixEmote HelixEmoteFromSet HelixEventSubApi HelixEventSubSubscription HelixExtensionsApi HelixExtensionTransaction HelixFollow HelixGame HelixGameApi HelixHypeTrainApi HelixHypeTrainContribution HelixHypeTrainEvent HelixInstalledExtension HelixInstalledExtensionList HelixModerationApi HelixModerator HelixModeratorEvent HelixPaginatedRequest HelixPaginatedRequestWithTotal HelixPaginatedScheduleSegmentRequest HelixPoll HelixPollApi HelixPollChoice HelixPrediction HelixPredictionApi HelixPredictionOutcome HelixPredictor HelixPrivilegedUser HelixSchedule HelixScheduleApi HelixScheduleSegment HelixSearchApi HelixStream HelixStreamApi HelixStreamMarker HelixStreamMarkerWithVideo HelixSubscription HelixSubscriptionApi HelixSubscriptionEvent HelixTag HelixTagApi HelixTeam HelixTeamApi HelixTeamWithUsers HelixUser HelixUserApi HelixUserBlock HelixUserExtension HelixUserRelation HelixUserSubscription HelixVideo HelixVideoApi HelixWebHooksApi HelixWebHookSubscription KrakenApiGroup NoSubscriptionProgramError PrivilegedChannel PrivilegedUser SearchApi Stream StreamApi StreamNotLiveError Subscription Team TeamApi TeamWithUsers UnsupportedApi User UserApi UserBlock UserChatInfo UserFollow UserSubscription Video VideoApi

Interfaces

ApiConfig ChannelUpdateData CheermoteDisplayInfo CheermoteFormat HelixBanFilter HelixBitsLeaderboardQuery HelixChannelSearchFilter HelixChannelUpdate HelixClipCreateParams HelixClipData HelixClipFilter HelixCreateCustomRewardData HelixCreatePollData HelixCreatePredictionData HelixCreateScheduleSegmentData HelixCustomRewardRedemptionFilter HelixDateRangeData HelixEventSubWebHookTransportOptions HelixExtensionTransactionsFilter HelixExtensionTransactionsPaginatedFilter HelixFollowFilter HelixForwardPagination HelixGameData HelixModeratorFilter HelixPaginatedChannelSearchFilter HelixPaginatedCustomRewardRedemptionFilter HelixPaginatedResult HelixPaginatedResultWithTotal HelixPaginatedScheduleFilter HelixPaginatedScheduleResult HelixPaginatedStreamFilter HelixPaginatedVideoFilter HelixPagination HelixScheduleFilter HelixScheduleSettingsUpdate HelixScheduleSettingsUpdateVacation HelixStreamFilter HelixStreamMarkerData HelixStreamMarkerVideoData HelixUpdateCustomRewardData HelixUpdateScheduleSegmentData HelixUserBlockAdditionalInfo HelixUserExtensionUpdatePayload HelixUserExtensionUpdatePayloadActiveSlot HelixUserExtensionUpdatePayloadInactiveSlot HelixUserUpdate HelixVideoFilter HelixVideoMutedSegmentData HelixWebHookHubRequest HelixWebHookHubRequestOptions MessageCheermote TwitchCheermoteConfig UserChatInfoGlobalBadgeData VideoCreateData VideoUpdateData

Enums

CheermoteBackground CheermoteScale CheermoteState HelixBanEventType HelixBroadcasterType HelixModeratorEventType HelixStreamType HelixSubscriptionEventType HelixUserType StreamType

Welcome to Twitch.js

Welcome to the documentation of the API module of Twitch.js, a library for NodeJS and the browser that aims to provide an easy interface to all of Twitch's programmatically available features.

Please feel free to browse the menu on the left to get started with the library and to check out all the different available classes.

Authentication

This used to be the core package that provided both API and authentication functionality. In version 4.2, the package twitch-auth was created that now does the job of centralizing authentication.

Thus, you should first check out the twitch-auth documentation in order to set up authentication.

Additional packages

This package only provides API functionality. All the other things are located in other packages:

twitch-chat-client - connect to and interact with Twitch Chat
twitch-pubsub-client - listen to events using the Twitch PubSub interface
twitch-webhooks - listen to events using WebHooks

If you're getting stuck...

You can join the Discord Server for support.