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

HelixEmote

A Twitch emote.

Overview

Properties

Methods

Properties

formats

Type: HelixEmoteFormat[]

The formats that the emote is available in.

id

Type: string

The ID of the emote.

name

Type: string

The name of the emote.

scales

Type: HelixEmoteScale[]

The scales that the emote is available in.

themeModes

Type: HelixEmoteThemeMode[]

The theme modes that the emote is available in.

Methods

getAnimatedImageUrl(scale, themeMode)

Gets the URL of the emote image in animated format at the given scale and theme mode, or null if an animated emote image at that scale/theme mode doesn't exist.

Parameter	Type	Required	Default	Description
scale	HelixEmoteScale		'1.0'	The scale of the image.
themeMode	HelixEmoteThemeMode		'light'	The theme mode of the image, either `light` or `dark`.

Return type: string | null

getFormattedImageUrl(scale, format, themeMode)

Gets the URL of the emote image in the given scale, format, and theme mode.

Parameter	Type	Required	Default	Description
scale	HelixEmoteScale		'1.0'	The scale of the image, either `1.0` (small), `2.0` (medium), or `3.0` (large).
format	HelixEmoteFormat		'static'	The format of the image, either `static` or `animated`.
themeMode	HelixEmoteThemeMode		'light'	The theme mode of the image, either `light` or `dark`.

Return type: string

getImageUrl(scale)

Gets the URL of the emote image in the given scale.

Parameter	Type	Required	Default	Description
scale	HelixEmoteImageScale		none	The scale of the image.

Return type: string

getStaticImageUrl(scale, themeMode)

Gets the URL of the emote image in static format at the given scale and theme mode, or null if a static emote image at that scale/theme mode doesn't exist.

Parameter	Type	Required	Default	Description
scale	HelixEmoteScale		'1.0'	The scale of the image.
themeMode	HelixEmoteThemeMode		'light'	The theme mode of the image, either `light` or `dark`.

Return type: string | null