Twurple Authentication Getting data Examples FAQ Migration

Reference

api api-call auth auth-tmi chat common easy-bot ebs-helper eventsub-base eventsub-http eventsub-ws pubsub

Main classes

Classes

ApiReportedRequest ConfigError HelixBan HelixBanUser HelixBitsLeaderboard HelixBitsLeaderboardEntry HelixBlockedTerm HelixChannel HelixChannelEditor HelixChannelEmote HelixChannelFollower HelixChannelReference HelixChannelSearchResult HelixCharityCampaign HelixCharityCampaignAmount HelixCharityCampaignDonation HelixChatBadgeSet HelixChatBadgeVersion HelixChatChatter HelixChatSettings HelixCheermoteList HelixClip HelixContentClassificationLabel HelixCustomReward HelixCustomRewardRedemption HelixDropsEntitlement HelixEmote HelixEmoteFromSet HelixEventSubConduit HelixEventSubConduitShard HelixEventSubSubscription HelixExtensionBitsProduct HelixExtensionTransaction HelixFollow HelixFollowedChannel HelixGame HelixGoal HelixGoalApi HelixHypeTrainContribution HelixHypeTrainEvent HelixInstalledExtension HelixInstalledExtensionList HelixModeratedChannel HelixModerator HelixPaginatedEventSubSubscriptionsRequest HelixPaginatedRequest HelixPaginatedRequestWithTotal HelixPaginatedScheduleSegmentRequest HelixPaginatedSubscriptionsRequest HelixPoll HelixPollChoice HelixPrediction HelixPredictionOutcome HelixPredictor HelixPrivilegedChatSettings HelixPrivilegedUser HelixRaid HelixSchedule HelixScheduleSegment HelixSentChatMessage HelixShieldModeStatus HelixStream HelixStreamMarker HelixStreamMarkerWithVideo HelixSubscription HelixTeam HelixTeamWithUsers HelixUser HelixUserBlock HelixUserExtension HelixUserRelation HelixUserSubscription HelixVideo StreamNotLiveError

Interfaces

ApiConfig HelixBanFilter HelixBanUserRequest HelixBitsLeaderboardQuery HelixChannelSearchFilter HelixChannelUpdate HelixClipCreateParams HelixClipFilter HelixCreateCustomRewardData HelixCreatePollData HelixCreatePredictionData HelixCreateScheduleSegmentData HelixCustomRewardRedemptionFilter HelixDropsEntitlementFilter HelixDropsEntitlementPaginatedFilter HelixEventSubConduitShardsOptions HelixEventSubConduitTransportOptions HelixEventSubDropEntitlementGrantFilter HelixEventSubWebHookTransportOptions HelixEventSubWebSocketTransportOptions HelixExtensionBitsProductUpdatePayload HelixExtensionTransactionsFilter HelixExtensionTransactionsPaginatedFilter HelixForwardPagination HelixModeratorFilter HelixPaginatedChannelSearchFilter HelixPaginatedClipFilter HelixPaginatedCustomRewardRedemptionFilter HelixPaginatedEventSubSubscriptionsResult HelixPaginatedResult HelixPaginatedResultWithTotal HelixPaginatedScheduleFilter HelixPaginatedStreamFilter HelixPaginatedSubscriptionsResult HelixPaginatedVideoFilter HelixPagination HelixScheduleFilter HelixScheduleSettingsUpdate HelixSendChatAnnouncementParams HelixSendChatMessageParams HelixStreamFilter HelixUpdateChatSettingsParams HelixUpdateCustomRewardData HelixUpdateScheduleSegmentData HelixUserBlockAdditionalInfo HelixUserExtensionUpdatePayload HelixUserExtensionUpdatePayloadActiveSlot HelixUserExtensionUpdatePayloadInactiveSlot HelixUserUpdate HelixVideoFilter

HelixPollStatus

The different statuses a poll can have.

Aliased type: "ACTIVE" | "COMPLETED" | "TERMINATED" | "ARCHIVED" | "MODERATED" | "INVALID"