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

ChannelPlaceholder

A placeholder for a channel.

Overview

Properties

id

Methods

This is used for example when you only have retrieved user data, but not channel data. This can do anything you can do with only a channel ID, as it's equivalent to the user ID.

Properties

id

Type: string

The ID of the channel.

Methods

getChannel()

Retrieves the channel data.

Return type: Channel

getCheermotes()

Retrieves the list of cheermotes you can use in the channel.

Return type: CheermoteList

getFollowers()

Retrieves the channel's followers.

Return type: Array<ChannelFollow>

getStream()

Retrieves the channel's stream data.

Return type: Stream | null

getSubscriptionBy(user)

Retrieves the subscription data for the given user to the channel.

Throws if the channel doesn't have a subscription program or the user is not subscribed to it.

This method requires access to the channel. If you only have access to the user, use User#getSubscriptionTo instead.

Parameter	Type	Required	Default	Description
user	UserIdResolvable		none	The user you want to get the subscription data for.

Return type: ChannelSubscription | null

getSubscriptions()

Retrieves the channel's subscribers.

Return type: Array<ChannelSubscription>

hasSubscriber(user)

Checks whether the given user is subscribed to the channel.

Parameter	Type	Required	Default	Description
user	UserIdResolvable		none	The user you want to check the subscription for.

Return type: boolean