twitcheasy-twitch-bottwitch-authtwitch-auth-tmitwitch-chat-clienttwitch-eventsubtwitch-pubsub-clienttwitch-webhooks
Welcome

Basic usage

Getting startedCreating a client instanceCalling the Twitch APIFAQ

Upgrading

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

Classes

ApiClientBadgesApiBitsApiChannelChannelApiChannelFollowChannelPlaceholderChannelSubscriptionChatApiChatBadgeListChatBadgeSetChatBadgeVersionChatEmoteListChattersListCheermoteListConfigErrorCreatedVideoEmoteSetListHelixApiGroupHelixBanHelixBanEventHelixBitsApiHelixBitsLeaderboardHelixBitsLeaderboardEntryHelixChannelHelixChannelApiHelixChannelEditorHelixChannelPointsApiHelixChannelSearchResultHelixCheermoteListHelixClipHelixClipApiHelixCustomRewardHelixCustomRewardRedemptionHelixEventSubApiHelixEventSubSubscriptionHelixExtensionsApiHelixExtensionTransactionHelixFollowHelixGameHelixGameApiHelixHypeTrainApiHelixHypeTrainContributionHelixHypeTrainEventHelixInstalledExtensionHelixInstalledExtensionListHelixModerationApiHelixModeratorHelixModeratorEventHelixPaginatedRequestHelixPaginatedRequestWithTotalHelixPrivilegedUserHelixSearchApiHelixStreamHelixStreamApiHelixStreamMarkerHelixStreamMarkerWithVideoHelixSubscriptionHelixSubscriptionApiHelixSubscriptionEventHelixTagHelixTagApiHelixTeamHelixTeamApiHelixTeamWithUsersHelixUserHelixUserApiHelixUserBlockHelixUserExtensionHelixUserRelationHelixVideoHelixVideoApiHelixWebHooksApiHelixWebHookSubscriptionKrakenApiGroupNoSubscriptionProgramErrorPrivilegedChannelPrivilegedUserSearchApiStreamStreamApiStreamNotLiveErrorSubscriptionTeamTeamApiTeamWithUsersUnsupportedApiUserUserApiUserBlockUserChatInfoUserFollowUserSubscriptionVideoVideoApi

Interfaces

ApiConfigChannelUpdateDataHelixBanFilterHelixBitsLeaderboardQueryHelixChannelSearchFilterHelixChannelUpdateHelixClipCreateParamsHelixClipFilterHelixCreateCustomRewardDataHelixCustomRewardRedemptionFilterHelixEventSubWebHookTransportOptionsHelixExtensionTransactionsFilterHelixExtensionTransactionsPaginatedFilterHelixFollowFilterHelixForwardPaginationHelixModeratorFilterHelixPaginatedChannelSearchFilterHelixPaginatedCustomRewardRedemptionFilterHelixPaginatedResponseHelixPaginatedResponseWithTotalHelixPaginatedResultHelixPaginatedResultWithTotalHelixPaginatedStreamFilterHelixPaginatedVideoFilterHelixPaginationHelixStreamFilterHelixUpdateCustomRewardDataHelixUserBlockAdditionalInfoHelixUserExtensionUpdatePayloadHelixUserExtensionUpdatePayloadActiveSlotHelixUserExtensionUpdatePayloadInactiveSlotHelixUserUpdateHelixVideoFilterHelixWebHookHubRequestHelixWebHookHubRequestOptionsVideoCreateDataVideoUpdateData

Enums

HelixBanEventTypeHelixBroadcasterTypeHelixModeratorEventTypeHelixStreamTypeHelixSubscriptionEventTypeStreamType

ChannelPlaceholder

A placeholder for a channel.

Overview

Properties

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()

async

Retrieves the channel data.

Return type: Channel

getCheermotes()

async

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

Return type: CheermoteList

getFollowers()

async

Retrieves the channel's followers.

Return type: Array<ChannelFollow>

getStream()

async

Retrieves the channel's stream data.

Return type: Stream | null

getSubscriptionBy(user)

async

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()

async

Retrieves the channel's subscribers.

Return type: Array<ChannelSubscription>

hasSubscriber(user)

async

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