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 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 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

HelixChannel

A Twitch channel.

Overview

Properties

Methods

Properties

contentClassificationLabels

Type: string[]

The content classification labels applied to the channel.

delay

Type: number

The stream delay of the channel, in seconds.

If you didn't request this with broadcaster access, this is always zero.

displayName

Type: string

The display name of the channel.

gameId

Type: string

The ID of the game currently played on the channel.

gameName

Type: string

The name of the game currently played on the channel.

id

Type: string

The ID of the channel.

isBrandedContent

Type: boolean

Whether the channel currently displays branded content (as specified by the broadcaster).

language

Type: string

The language of the channel.

name

Type: string

The name of the channel.

tags

Type: string[]

The tags applied to the channel.

title

Type: string

The title of the channel.

Methods

getBroadcaster()

Gets more information about the broadcaster of the channel.

Return type: HelixUser

getGame()

Gets information about the game that is being played on the stream.

Return type: HelixGame | null