TwurpleAuthenticationGetting dataExamplesFAQMigration
Reference
apiapi-callauthauth-tmichatcommoneasy-botebs-helpereventsub-baseeventsub-httpeventsub-wspubsub

Main classes

ApiClient

Helix APIs

BitsChannelsChannel pointsCharity CampaignsChatClipsContent classification labelsEntitlements (Drops)EventSubExtensionsGamesHype TrainsModerationPollsPredictionsRaidsScheduleSearchStreamsSubscriptionsTeamsUsersVideosWhispers

Classes

ApiReportedRequestConfigErrorHelixBanHelixBanUserHelixBitsLeaderboardHelixBitsLeaderboardEntryHelixBlockedTermHelixChannelHelixChannelEditorHelixChannelEmoteHelixChannelFollowerHelixChannelReferenceHelixChannelSearchResultHelixCharityCampaignHelixCharityCampaignAmountHelixCharityCampaignDonationHelixChatBadgeSetHelixChatBadgeVersionHelixChatChatterHelixChatSettingsHelixCheermoteListHelixClipHelixContentClassificationLabelHelixCustomRewardHelixCustomRewardRedemptionHelixDropsEntitlementHelixEmoteHelixEmoteFromSetHelixEventSubConduitHelixEventSubConduitShardHelixEventSubSubscriptionHelixExtensionBitsProductHelixExtensionTransactionHelixFollowHelixFollowedChannelHelixGameHelixGoalHelixGoalApiHelixHypeTrainContributionHelixHypeTrainEventHelixInstalledExtensionHelixInstalledExtensionListHelixModeratedChannelHelixModeratorHelixPaginatedEventSubSubscriptionsRequestHelixPaginatedRequestHelixPaginatedRequestWithTotalHelixPaginatedScheduleSegmentRequestHelixPaginatedSubscriptionsRequestHelixPollHelixPollChoiceHelixPredictionHelixPredictionOutcomeHelixPredictorHelixPrivilegedChatSettingsHelixPrivilegedUserHelixRaidHelixScheduleHelixScheduleSegmentHelixSentChatMessageHelixShieldModeStatusHelixStreamHelixStreamMarkerHelixStreamMarkerWithVideoHelixSubscriptionHelixTeamHelixTeamWithUsersHelixUserHelixUserBlockHelixUserExtensionHelixUserRelationHelixUserSubscriptionHelixVideoStreamNotLiveError

Interfaces

ApiConfigHelixBanFilterHelixBanUserRequestHelixBitsLeaderboardQueryHelixChannelSearchFilterHelixChannelUpdateHelixClipCreateParamsHelixClipFilterHelixCreateCustomRewardDataHelixCreatePollDataHelixCreatePredictionDataHelixCreateScheduleSegmentDataHelixCustomRewardRedemptionFilterHelixDropsEntitlementFilterHelixDropsEntitlementPaginatedFilterHelixEventSubConduitShardsOptionsHelixEventSubConduitTransportOptionsHelixEventSubDropEntitlementGrantFilterHelixEventSubWebHookTransportOptionsHelixEventSubWebSocketTransportOptionsHelixExtensionBitsProductUpdatePayloadHelixExtensionTransactionsFilterHelixExtensionTransactionsPaginatedFilterHelixForwardPaginationHelixModeratorFilterHelixPaginatedChannelSearchFilterHelixPaginatedClipFilterHelixPaginatedCustomRewardRedemptionFilterHelixPaginatedEventSubSubscriptionsResultHelixPaginatedResultHelixPaginatedResultWithTotalHelixPaginatedScheduleFilterHelixPaginatedStreamFilterHelixPaginatedSubscriptionsResultHelixPaginatedVideoFilterHelixPaginationHelixScheduleFilterHelixScheduleSettingsUpdateHelixSendChatAnnouncementParamsHelixSendChatMessageParamsHelixStreamFilterHelixUpdateChatSettingsParamsHelixUpdateCustomRewardDataHelixUpdateScheduleSegmentDataHelixUserBlockAdditionalInfoHelixUserExtensionUpdatePayloadHelixUserExtensionUpdatePayloadActiveSlotHelixUserExtensionUpdatePayloadInactiveSlotHelixUserUpdateHelixVideoFilter

Type aliases

HelixBitsLeaderboardPeriodHelixBroadcasterTypeHelixChannelEmoteSubscriptionTierHelixChatAnnouncementColorHelixChatBadgeScaleHelixChatUserColorHelixCustomRewardRedemptionStatusHelixCustomRewardRedemptionTargetStatusHelixDropsEntitlementFulfillmentStatusHelixDropsEntitlementUpdateStatusHelixEventSubConduitShardsTransportOptionsHelixEventSubSubscriptionStatusHelixEventSubTransportOptionsHelixExtensionSlotTypeHelixGoalTypeHelixHypeTrainContributionTypeHelixHypeTrainEventTypeHelixPollStatusHelixPredictionOutcomeColorHelixPredictionStatusHelixStreamTypeHelixUserExtensionUpdatePayloadSlotHelixVideoType

HelixDropsEntitlementFilter

Filters for drops entitlement queries.

{
The fulfillment status to find entitlements for.
fulfillmentStatus:
HelixDropsEntitlementFulfillmentStatus

The fulfillment status of a drop entitlement.

Aliased type: "CLAIMED" | "FULFILLED"

The ID of the game to find entitlements for.
gameId: string
The user to find entitlements for.
user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

}

Properties

fulfillmentStatus

Type:
HelixDropsEntitlementFulfillmentStatus

The fulfillment status of a drop entitlement.

Aliased type: "CLAIMED" | "FULFILLED"

The fulfillment status to find entitlements for.

gameId

Type: string

The ID of the game to find entitlements for.

user

Type:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

The user to find entitlements for.