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

HelixHypeTrainApi

The Helix API methods that deal with Hype Trains.

Overview

Methods

getHypeTrainStatusForBroadcastera

Can be accessed using client.hypeTrain on an ApiClient instance.

Example

const api = new ApiClient({ authProvider });
const hypeTrainStatus = await api.hypeTrain.getHypeTrainStatusForBroadcaster('125328655');

Methods

getHypeTrainStatusForBroadcaster(broadcaster)

Gets the Hype Train status and statistics for the specified broadcaster.

Parameter	Type	Required	Default	Description
broadcaster	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		none	The broadcaster to fetch Hype Train info for.

Return type: HelixHypeTrainStatus