TwurpleAuthenticationGetting dataExamplesFAQMigration
Reference
apiapi-callauthauth-tmichatcommoneasy-botebs-helpereventsub-baseeventsub-httpeventsub-wspubsub

Main classes

ApiClient

Helix APIs

BitsChannelsChannel pointsCharity CampaignsChatClipsContent classification labelsEntitlements (Drops)EventSubExtensionsGamesHype TrainsModerationPollsPredictionsRaidsScheduleSearchStreamsSubscriptionsTeamsUsersVideosWhispers

Classes

ApiReportedRequestConfigErrorHelixBanHelixBanUserHelixBitsLeaderboardHelixBitsLeaderboardEntryHelixBlockedTermHelixChannelHelixChannelEditorHelixChannelEmoteHelixChannelFollowerHelixChannelReferenceHelixChannelSearchResultHelixCharityCampaignHelixCharityCampaignAmountHelixCharityCampaignDonationHelixChatBadgeSetHelixChatBadgeVersionHelixChatChatterHelixChatSettingsHelixCheermoteListHelixClipHelixContentClassificationLabelHelixCustomRewardHelixCustomRewardRedemptionHelixDropsEntitlementHelixEmoteHelixEmoteFromSetHelixEventSubConduitHelixEventSubConduitShardHelixEventSubSubscriptionHelixExtensionBitsProductHelixExtensionTransactionHelixFollowHelixFollowedChannelHelixGameHelixGoalHelixGoalApiHelixHypeTrainContributionHelixHypeTrainEventHelixInstalledExtensionHelixInstalledExtensionListHelixModeratedChannelHelixModeratorHelixPaginatedEventSubSubscriptionsRequestHelixPaginatedRequestHelixPaginatedRequestWithTotalHelixPaginatedScheduleSegmentRequestHelixPaginatedSubscriptionsRequestHelixPollHelixPollChoiceHelixPredictionHelixPredictionOutcomeHelixPredictorHelixPrivilegedChatSettingsHelixPrivilegedUserHelixRaidHelixScheduleHelixScheduleSegmentHelixSentChatMessageHelixShieldModeStatusHelixStreamHelixStreamMarkerHelixStreamMarkerWithVideoHelixSubscriptionHelixTeamHelixTeamWithUsersHelixUserHelixUserBlockHelixUserExtensionHelixUserRelationHelixUserSubscriptionHelixVideoStreamNotLiveError

Interfaces

ApiConfigHelixBanFilterHelixBanUserRequestHelixBitsLeaderboardQueryHelixChannelSearchFilterHelixChannelUpdateHelixClipCreateParamsHelixClipFilterHelixCreateCustomRewardDataHelixCreatePollDataHelixCreatePredictionDataHelixCreateScheduleSegmentDataHelixCustomRewardRedemptionFilterHelixDropsEntitlementFilterHelixDropsEntitlementPaginatedFilterHelixEventSubConduitShardsOptionsHelixEventSubConduitTransportOptionsHelixEventSubDropEntitlementGrantFilterHelixEventSubWebHookTransportOptionsHelixEventSubWebSocketTransportOptionsHelixExtensionBitsProductUpdatePayloadHelixExtensionTransactionsFilterHelixExtensionTransactionsPaginatedFilterHelixForwardPaginationHelixModeratorFilterHelixPaginatedChannelSearchFilterHelixPaginatedClipFilterHelixPaginatedCustomRewardRedemptionFilterHelixPaginatedEventSubSubscriptionsResultHelixPaginatedResultHelixPaginatedResultWithTotalHelixPaginatedScheduleFilterHelixPaginatedStreamFilterHelixPaginatedSubscriptionsResultHelixPaginatedVideoFilterHelixPaginationHelixScheduleFilterHelixScheduleSettingsUpdateHelixSendChatAnnouncementParamsHelixSendChatMessageParamsHelixStreamFilterHelixUpdateChatSettingsParamsHelixUpdateCustomRewardDataHelixUpdateScheduleSegmentDataHelixUserBlockAdditionalInfoHelixUserExtensionUpdatePayloadHelixUserExtensionUpdatePayloadActiveSlotHelixUserExtensionUpdatePayloadInactiveSlotHelixUserUpdateHelixVideoFilter

Type aliases

HelixBitsLeaderboardPeriodHelixBroadcasterTypeHelixChannelEmoteSubscriptionTierHelixChatAnnouncementColorHelixChatBadgeScaleHelixChatUserColorHelixCustomRewardRedemptionStatusHelixCustomRewardRedemptionTargetStatusHelixDropsEntitlementFulfillmentStatusHelixDropsEntitlementUpdateStatusHelixEventSubConduitShardsTransportOptionsHelixEventSubSubscriptionStatusHelixEventSubTransportOptionsHelixExtensionSlotTypeHelixGoalTypeHelixHypeTrainContributionTypeHelixHypeTrainEventTypeHelixPollStatusHelixPredictionOutcomeColorHelixPredictionStatusHelixStreamTypeHelixUserExtensionUpdatePayloadSlotHelixVideoType

HelixBanUserRequest

Information about a user to be banned/timed out from a channel.

{
The duration (in seconds) that the user should be timed out. If this value is null, the user will be banned.
duration?: number
The reason why the user is being timed out/banned.
reason: string
The user who is to be banned/timed out.
user:
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

}

Properties

duration

Type: ?number

The duration (in seconds) that the user should be timed out. If this value is null, the user will be banned.

reason

Type: string

The reason why the user is being timed out/banned.

user

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

The user who is to be banned/timed out.