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

HelixClipApi

The Helix API methods that deal with clips.

Overview

Methods

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

Example

const api = new ApiClient(new StaticAuthProvider(clientId, accessToken));
const clipId = await api.helix.clips.createClip({ channelId: '125328655' });

Methods

createClip(params)

async

Creates a clip of a running stream.

Returns the ID of the clip.

Parameter Type Required Default Description
params HelixClipCreateParams none see below
params.channelId string none

The ID of the broadcaster of which you want to create a clip.

params.createAfterDelay boolean none

Add a delay before the clip creation that accounts for the usual delay in the viewing experience.

Return type: string

getClipById(id)

async

Retrieves the clip identified by the given ID.

Parameter Type Required Default Description
id string none

The clip ID.
Return type: HelixClip | null

getClipsByIds(ids)

async

Retrieves the clips identified by the given IDs.

Parameter Type Required Default Description
ids Array<string> none

The clip IDs.
Return type: Array<HelixClip>

getClipsForBroadcaster(user, filter)

async

Retrieves the latest clips for the specified broadcaster.

Parameter Type Required Default Description
user UserIdResolvable none

The broadcaster to fetch clips for.
filter HelixClipFilter {}
filter.endDate string none

The latest date to find clips for.
filter.limit number none

The maximum number of results to retrieve. Defaults to 20.

filter.startDate string none

The earliest date to find clips for.
Return type: HelixPaginatedResult<HelixClip>

getClipsForBroadcasterPaginated(user, filter)

Creates a paginator for the latest clips for the specified broadcaster.

Parameter Type Required Default Description
user UserIdResolvable none

The broadcaster to fetch clips for.
filter HelixClipFilter {}
filter.endDate string none

The latest date to find clips for.
filter.limit number none

The maximum number of results to retrieve. Defaults to 20.

filter.startDate string none

The earliest date to find clips for.
Return type: HelixPaginatedRequest<HelixClipData, HelixClip>

getClipsForGame(gameId, filter)

async

Retrieves the latest clips for the specified game.

Parameter Type Required Default Description
gameId string none

The game ID.
filter HelixClipFilter {}
filter.endDate string none

The latest date to find clips for.
filter.limit number none

The maximum number of results to retrieve. Defaults to 20.

filter.startDate string none

The earliest date to find clips for.
Return type: HelixPaginatedResult<HelixClip>

getClipsForGamePaginated(gameId, filter)

Creates a paginator for the latest clips for the specified game.

Parameter Type Required Default Description
gameId string none

The game ID.
filter HelixClipFilter {}
filter.endDate string none

The latest date to find clips for.
filter.limit number none

The maximum number of results to retrieve. Defaults to 20.

filter.startDate string none

The earliest date to find clips for.
Return type: HelixPaginatedRequest<HelixClipData, HelixClip>