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

HelixSubscription

A (paid) subscription of a user to a broadcaster.

Overview

Properties

Methods

Properties

broadcasterDisplayName

Type: string

The display name of the broadcaster.

broadcasterId

Type: string

The user ID of the broadcaster.

broadcasterName

Type: string

The name of the broadcaster.

gifterDisplayName

Type: string | null

The display name of the gifter.

gifterId

Type: string | null

The user ID of the gifter.

gifterName

Type: string | null

The name of the gifter.

isGift

Type: boolean

Whether the subscription has been gifted by another user.

tier

Type: string

The tier of the subscription.

userDisplayName

Type: string

The display name of the subscribed user.

userId

Type: string

The user ID of the subscribed user.

userName

Type: string

The name of the subscribed user.

Methods

getBroadcaster()

Gets more information about the broadcaster.

Return type: HelixUser

getGifter()

Gets more information about the gifter.

Return type: HelixUser | null

getUser()

Gets more information about the subscribed user.

Return type: HelixUser