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

HelixVideoApi

The Helix API methods that deal with videos.

Overview

Methods

Can be accessed using client.helix.videos on an ApiClient instance.

Example

const api = new ApiClient(new StaticAuthProvider(clientId, accessToken));
const { data: videos } = await api.helix.videos.getVideosByUser('125328655');

Methods

deleteVideosByIds(ids)

Deletes videos by its IDs.

Parameter	Type	Required	Default	Description
ids	Array<string>		none	The IDs of the videos to delete.

Return type: void

getVideoById(id)

Retrieves the video data for the given video ID.

Parameter	Type	Required	Default	Description
id	string		none	The video ID you want to look up.

Return type: HelixVideo | null

getVideosByGame(gameId, filter)

Retrieves the videos of the given game.

Parameter	Type	Required	Default	Description
gameId	string		none	The game you want to retrieve videos from.
filter	HelixVideoFilter		{}	Additional filters for the result set.

Return type: HelixPaginatedResult<HelixVideo>

getVideosByGamePaginated(gameId, filter)

Creates a paginator for videos of the given game.

Parameter	Type	Required	Default	Description
gameId	string		none	The game you want to retrieve videos from.
filter	HelixVideoFilter		{}	Additional filters for the result set.

Return type: HelixPaginatedRequest<HelixVideoData, HelixVideo>

getVideosByIds(ids)

Retrieves the video data for the given list of video IDs.

Parameter	Type	Required	Default	Description
ids	string \| Array<string>		none	The video IDs you want to look up.

Return type: Array<HelixVideo>

getVideosByUser(user, filter)

Retrieves the videos of the given user.

Parameter	Type	Required	Default	Description
user	UserIdResolvable		none	The user you want to retrieve videos from.
filter	HelixPaginatedVideoFilter		{}	Additional filters for the result set.

Return type: HelixPaginatedResult<HelixVideo>

getVideosByUserPaginated(user, filter)

Creates a paginator for videos of the given user.

Parameter	Type	Required	Default	Description
user	UserIdResolvable		none	The user you want to retrieve videos from.
filter	HelixVideoFilter		{}	Additional filters for the result set.

Return type: HelixPaginatedRequest<HelixVideoData, HelixVideo>