Reference

Reference

Every method, every event type, every scope and every error of the library.

The library has 155 methods in 30 groups, which cover every endpoint of the Helix API, and types the 83 EventSub event types. The group pages and the list of events are generated from the source code, so they always match the published version.

API groups

Each group is a property of the client: twitch.chat, twitch.moderation… Its page gives, for each method, the signature, the token it needs, the parameters, what comes back and an example.

Group	Covers	Methods
`twitch.ads`	Ads: run commercials, read the ad schedule, snooze the next ad.	3
`twitch.analytics`	Analytics: downloadable reports for your extensions and games.	2
`twitch.bits`	Bits: leaderboard, Cheermotes, custom Power-ups and extension transactions.	4
`twitch.channelPoints`	Channel Points: custom rewards and their redemptions.	6
`twitch.channels`	Channels: title, category and tags, editors, follows and followers.	5
`twitch.charity`	Charity: the active campaign and its donations.	2
`twitch.chat`	Chat: send messages and announcements, chatters, emotes, badges, settings, colors, pins and shoutouts.	19
`twitch.clips`	Clips: create, look up and download clips.	4
`twitch.conduits`	Conduits: the EventSub transport that spreads events over several shards.	6
`twitch.contentLabels`	Content classification labels and their localized names.	1
`twitch.entitlements`	Drops entitlements: list them and mark them fulfilled.	2
`twitch.eventsub`	EventSub: subscriptions, and the WebSocket, webhook and conduit listeners.	6
`twitch.extensions`	Extensions: configuration, secrets, PubSub and chat messages, Bits products.	12
`twitch.games`	Games and categories: look them up, list the most watched.	2
`twitch.goals`	Creator goals of a channel.	1
`twitch.guestStar`	Guest Star (beta): sessions, invites and slots.	12
`twitch.hypeTrain`	Hype Train: the current train and the channel records.	1
`twitch.moderation`	Moderation: bans, timeouts, warnings, AutoMod, blocked terms, moderators, VIPs and Shield Mode.	25
`twitch.polls`	Polls: create, read and end them.	3
`twitch.predictions`	Predictions: create, read, lock and resolve them.	3
`twitch.raids`	Raids: start one, cancel a pending one.	2
`twitch.schedule`	Stream schedule: segments, vacation and the iCalendar feed.	6
`twitch.search`	Search for categories and channels.	2
`twitch.streams`	Streams: who is live, stream keys and markers.	5
`twitch.subscriptions`	Subscriptions: the subscribers of a channel, and whether a user is one.	2
`twitch.tags`	Stream tags (deprecated by Twitch, kept for completeness).	2
`twitch.teams`	Teams: look one up, list the teams of a channel.	2
`twitch.users`	Users: profiles, block list and installed extensions.	12
`twitch.videos`	Videos: VODs, highlights and uploads.	2
`twitch.whispers`	Whispers: send a private message to a user.	1

The rest of the reference

Event types: every EventSub subscription type, its version, its condition and its scope.
Scopes: every OAuth scope and the methods it unlocks.
Errors: every error class, its fields and when it is thrown.
Client options: the options of new Twitch(), the methods of the client and the request options.