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

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)

async

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)

async

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)

async

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)

async

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)

async

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>