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

Main classes

Classes

ApiReportedRequest ChatMessageDroppedError ConfigError HelixAdSchedule 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 HelixHypeTrain HelixHypeTrainAllTimeHigh HelixHypeTrainContribution HelixHypeTrainSharedParticipant HelixHypeTrainStatus HelixInstalledExtension HelixInstalledExtensionList HelixModeratedChannel HelixModerator HelixPaginatedEventSubSubscriptionsRequest HelixPaginatedRequest HelixPaginatedRequestWithTotal HelixPaginatedScheduleSegmentRequest HelixPaginatedSubscriptionsRequest HelixPoll HelixPollChoice HelixPrediction HelixPredictionOutcome HelixPredictor HelixPrivilegedChatSettings HelixPrivilegedUser HelixRaid HelixSchedule HelixScheduleSegment HelixSentChatMessage HelixSharedChatSession HelixSharedChatSessionParticipant HelixShieldModeStatus HelixStream HelixStreamMarker HelixStreamMarkerWithVideo HelixSubscription HelixTeam HelixTeamWithUsers HelixUnbanRequest HelixUser HelixUserBlock HelixUserEmote HelixUserExtension HelixUserRelation HelixUserSubscription HelixVideo HelixWarning StreamNotLiveError

Interfaces

ApiConfig CheermoteDisplayInfo 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 HelixSendChatMessageAsAppParams HelixSendChatMessageParams HelixStreamFilter HelixUpdateChatSettingsParams HelixUpdateCustomRewardData HelixUpdateScheduleSegmentData HelixUserBlockAdditionalInfo HelixUserEmotesFilter HelixUserExtensionUpdatePayload HelixUserExtensionUpdatePayloadActiveSlot HelixUserExtensionUpdatePayloadInactiveSlot HelixUserUpdate HelixVideoFilter

HelixHypeTrain

Data about the currently running Hype Train.

Overview

Properties

Methods

getBroadcastera

Properties

broadcasterDisplayName

Type: string

The display name of the broadcaster where the Hype Train is happening.

broadcasterId

Type: string

The user ID of the broadcaster where the Hype Train is happening.

broadcasterName

Type: string

The name of the broadcaster where the Hype Train is happening.

eventId

Type: string

The unique ID of the Hype Train event.

expiryDate

Type: Date

The time when the Hype Train is set to expire.

goal

Type: number

The progress points goal to reach the next Hype Train level.

id

Type: string

The unique ID of the Hype Train.

isSharedTrain

Type: boolean

Whether the Hype Train is a shared train.

level

Type: number

The level of the Hype Train.

progress

Type: number

The amount progress points for the current level of the Hype Train.

startDate

Type: Date

The time when the Hype Train started.

topContributions

Type: HelixHypeTrainContribution[]

Array list of the top contributions to the Hype Train event for bits and subs.

total

Type: number

The total amount of progress points of the Hype Train.

type

Type: HelixHypeTrainType

The type of the Hype Train.

Methods

getBroadcaster()

Gets more information about the broadcaster where the Hype Train is happening.

Return type: HelixUser