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

PrivilegedChannel

A channel you have extended privileges for, i.e. the channel of the currently authenticated user.

Overview

Properties

Methods

Properties

email

Type: string

The channel's email address.

streamKey

Type: string

The channel's stream key.

Methods

getEditors()

Retrieves the list of editors of the channel.

Return type: Array<User>

resetStreamKey()

Resets the given channel's stream key.

Return type: string

startCommercial(length)

Starts a commercial in the channel.

Parameter	Type	Required	Default	Description
length	CommercialLength The possible lengths of a channel commercial. Aliased type: 30 \| 60 \| 90 \| 120 \| 150 \| 180		none	The length of the commercial.

Return type: void