API Reference

Every endpoint in the Twitch API, grouped by resource.

View as markdown
Provide feedback for this page

Ads

Start, stop, and get information about ads on Twitch.

Get Ad Schedule
Returns ad schedule related information.
Snooze Next Ad
Pushes back the timestamp of the upcoming automatic mid-roll ad by 5 minutes.
Start Commercial
Starts a commercial on the specified channel.

Analytics

Get access to analytics on your Extension and games on Twitch.

Get Extension Analytics
Gets an analytics report for one or more extensions.
Get Game Analytics
Gets an analytics report for one or more games.

Bits

Get access to information involving Bits products and transactions.

Get Cheermotes
Gets a list of Cheermotes that users can use to cheer Bits.
Get Custom Power-up
Gets a list of custom Power-ups that the specified broadcaster created.
Get Bits Leaderboard
Gets the Bits leaderboard for the authenticated broadcaster.
Get Extension Transactions
Gets an extension's list of transactions.

CCLs

Get the Content Classification Labels a broadcaster can apply to their channel.

Get Content Classification Labels
Gets information about Twitch content classification labels.

Channel Points

Get, remove, and manage Channel Points rewards and Redemptions.

Get Custom Reward
Gets a list of custom rewards that the specified broadcaster created.
Create Custom Rewards
Creates a Custom Reward in the broadcaster's channel.
Update Custom Reward
Updates a custom reward.
Delete Custom Reward
Deletes a custom reward that the broadcaster created.
Get Custom Reward Redemption
Gets a list of redemptions for a custom reward.
Update Redemption Status
Updates a redemption's status.

Channels

Get information and manage settings related to a user's Twitch channel.

Get Channel Information
Gets information about one or more channels.
Modify Channel Information
Updates a channel's properties.
Get Channel Editors
Gets the broadcaster's list editors.
Get Followed Channels
Gets a list of broadcasters that the specified user follows, or checks if a user follows a specific broadcaster.
Get Channel Followers
Gets a list of users that follow the specified broadcaster, or checks if a specific user follows the broadcaster.

Charity

Manage charity campaign and donations made through Twitch's Charity Tool.

Get Charity Campaign
Gets information about the broadcaster's active charity campaign.
Get Charity Campaign Donations
Gets the list of donations that users have made to the broadcaster's active charity campaign.

Chat

Manage and interact with Twitch Chat.

Send Chat Announcement
Sends an announcement to the broadcaster's chat room.
Get Channel Chat Badges
Gets the broadcaster's list of custom chat badges.
Get Global Chat Badges
Gets Twitch's list of chat badges.
Get Chatters
Gets the list of users that are connected to the broadcaster's chat session.
Get User Chat Color
Gets the color used for the user's name in chat.
Update User Chat Color
Updates the color used for the user's name in chat.
Get Channel Emotes
Gets the broadcaster's list of custom emotes.
Get Global Emotes
Gets all global emotes.
Get Emote Sets
Gets emotes for one or more specified emote sets.
Get User Emotes
Retrieves emotes available to the user across all channels.
Send Chat Message
Sends a message to the broadcaster's chat room.
Get Pinned Chat Message
Gets the currently pinned message for the broadcaster's chat room.
Pin Chat Message
Pins a chat message to the specified broadcaster's chat room.
Update Pinned Chat Message
Updates the duration of a pinned chat message.
Unpin Chat Message
Unpins a pinned chat message from the broadcaster's chat room.
Get Chat Settings
Gets the broadcaster's chat settings.
Update Chat Settings
Updates the broadcaster's chat settings.
Send a Shoutout
Sends a Shoutout to the specified broadcaster.
Get Shared Chat Session
Retrieves the active shared chat session for a channel.

Clips

Create and manage clips on Twitch

Get Clips
Gets one or more video clips.
Create Clip
Creates a clip from the broadcaster's stream.
Get Clips Download
Provides URLs to download the video file(s) for the specified clips.
Create Clip From VOD
Creates a clip from the broadcaster's VOD.

Conduits

Create and manage conduits and their shards for sending EventSub notifications.

Get Conduits
Gets the conduits for a client ID.
Create Conduits
Creates a new conduit.
Update Conduits
Updates a conduit's shard count.
Delete Conduit
Deletes a specified conduit.
Get Conduit Shards
Gets a list of shards for a conduit.
Update Conduit Shards
Updates shard(s) for a conduit.

Entitlements

Manage your game's Twitch Drops system using the Twitch API.

Get Drops Entitlements
Gets an organization's list of entitlements that have been granted to a game, a user, or both.
Update Drops Entitlements
Updates the Drop entitlement's fulfillment status.

EventSub

Create, list, and delete EventSub subscriptions.

Get EventSub Subscriptions
Gets a list of EventSub subscriptions that the client in the access token created.
Create EventSub Subscription
Creates an EventSub subscription.
Delete EventSub Subscription
Deletes an EventSub subscription.

Extensions

Manage and interact on behalf of your Twitch Extensions.

Get Extension Bits Products
Gets the list of Bits products that belongs to the extension.
Update Extension Bits Product
Adds or updates a Bits product that the extension created.
Get Extensions
Gets information about an extension.
Send Extension Chat Message
Sends a message to the specified broadcaster's chat room.
Get Extension Configuration Segment
Gets the specified configuration segment from the specified extension.
Set Extension Configuration Segment
Updates a configuration segment.
Get Extension Secrets
Gets an extension's list of shared secrets.
Create Extension Secret
Creates a shared secret used to sign and verify JWT tokens.
Get Extension Live Channels
Gets a list of broadcasters that are streaming live and have installed or activated the extension.
Send Extension PubSub Message
Sends a message to one or more viewers.
Get Released Extensions
Gets information about a released extension.
Set Extension Required Configuration
Updates the extension's required_configuration string.

Games

Get information about categories on Twitch.

Get Games
Gets information about specified categories or games.
Get Top Games
Gets information about the categories and games that have the most viewers on Twitch.

Goals

View information related to a creator's goals.

Get Creator Goals
Gets the broadcaster's list of active goals.

Guest Star

Manage and view information related to a broadcaster's Stream Together session.

Get Channel Guest Star Settings
BetaGets the channel settings for configuration of the Guest Star feature for a particular host.
Update Channel Guest Star Settings
BetaMutates the channel settings for configuration of the Guest Star feature for a particular host.
Get Guest Star Invites
BetaProvides the caller with a list of pending invites to a Guest Star session.
Send Guest Star Invite
BetaSends an invite to a specified guest on behalf of the broadcaster for a Guest Star session in progress.
Delete Guest Star Invite
BetaRevokes a previously sent invite for a Guest Star session.
Get Guest Star Session
BetaGets information about an ongoing Guest Star session for a particular channel.
Create Guest Star Session
BetaProgrammatically creates a Guest Star session on behalf of the broadcaster.
End Guest Star Session
BetaProgrammatically ends a Guest Star session on behalf of the broadcaster.
Assign Guest Star Slot
BetaAllows a previously invited user to be assigned a slot within the active Guest Star session.
Update Guest Star Slot
BetaAllows a user to update the assigned slot for a particular user within the active Guest Star session.
Delete Guest Star Slot
BetaAllows a caller to remove a slot assignment from a user participating in an active Guest Star session.
Update Guest Star Slot Settings
BetaAllows a user to update slot settings for a particular guest within a Guest Star session.

Hype Train

View information related a channel's ongoing Hype Train.

Get Hype Train Status
Gets the status of a Hype Train for the specified broadcaster.

Moderation

Manage a Twitch channel's moderation settings, including banning and warning users.

Get VIPs
Gets a list of the broadcaster's VIPs.
Add Channel VIP
Adds the specified user as a VIP in the broadcaster's channel.
Remove Channel VIP
Removes the specified user as a VIP in the broadcaster's channel.
Manage Held AutoMod Messages
Allow or deny the message that AutoMod flagged for review.
Get AutoMod Settings
Gets the broadcaster's AutoMod settings.
Update AutoMod Settings
Updates the broadcaster's AutoMod settings.
Get Banned Users
Gets all users that the broadcaster banned or put in a timeout.
Ban User
Bans a user from participating in a broadcaster's chat room or puts them in a timeout.
Unban User
Removes the ban or timeout that was placed on the specified user.
Get Blocked Terms
Gets the broadcaster's list of blocked words or phrases.
Add Blocked Term
Adds a word or phrase to the broadcaster's list of blocked terms.
Remove Blocked Term
Removes the word or phrase from the broadcaster's list of blocked terms.
Get Moderated Channels
Gets a list of channels that the specified user has moderator privileges in.
Delete Chat Messages
Removes a single chat message or all chat messages from the broadcaster's chat room.
Check AutoMod Status
Checks whether AutoMod would flag the specified message for review.
Get Moderators
Gets all users allowed to moderate the broadcaster's chat room.
Add Channel Moderator
Adds a moderator to the broadcaster's chat room.
Remove Channel Moderator
Removes a moderator from the broadcaster's chat room.
Get Shield Mode Status
Gets the broadcaster's Shield Mode activation status.
Update Shield Mode Status
Activates or deactivates the broadcaster's Shield Mode.
Add Suspicious Status to Chat User
Adds a suspicious user status to a chatter on the broadcaster's channel.
Remove Suspicious Status From Chat User
Remove a suspicious user status from a chatter on broadcaster's channel.
Get Unban Requests
Gets a list of unban requests for a broadcaster's channel.
Resolve Unban Requests
Resolves an unban request by approving or denying it.
Warn Chat User
Warns a user in the specified broadcaster's chat room, preventing them from chat interaction until the warning is acknowledged.

Polls

Start, stop, and get information relating to polls on a Twitch channel.

Get Polls
Gets a list of polls that the broadcaster created.
Create Poll
Creates a poll that viewers in the broadcaster's channel can vote on.
End Poll
End an active poll.

Predictions

Start, stop, and get information relating to predictions on a Twitch channel.

Get Predictions
Gets a list of Channel Points Predictions that the broadcaster created.
Create Prediction
Create a Channel Points Prediction.
End Prediction
Locks, resolves, or cancels a Channel Points Prediction.

Raids

Start and stop raids on a Twitch channel.

Start a raid
Raid another channel by sending the broadcaster's viewers to the targeted channel.
Cancel a raid
Cancel a pending raid.

Schedule

Manage and get information related to a broadcaster's stream schedule.

Get Channel Stream Schedule
Gets the broadcaster's streaming schedule.
Get Channel iCalendar
Gets the broadcaster's streaming schedule as an iCalendar.
Create Channel Stream Schedule Segment
Adds a single or recurring broadcast to the broadcaster's streaming schedule.
Update Channel Stream Schedule Segment
Updates a scheduled broadcast segment.
Delete Channel Stream Schedule Segment
Deletes a broadcast from the broadcaster's streaming schedule.
Update Channel Stream Schedule
Updates the broadcaster's schedule settings, such as scheduling a vacation.

Search for categories and channels on Twitch.

Search Categories
Gets the games or categories that match the specified query.
Search Channels
Gets the channels that match the specified query.

Streams

Get and manage information relating to a stream, or the ability to stream.

Get Streams
Gets a list of all streams.
Get Followed Streams
Gets the list of broadcasters that the user follows and that are streaming live.
Get Stream Key
Gets the channel's stream key.
Get Stream Markers
Gets a list of markers from the user's most recent stream or from the specified VOD/video.
Create Stream Marker
Adds a marker to a live stream.

Subscriptions

Get information related to subscriptions on a Twitch channel.

Get Broadcaster Subscriptions
Gets a list of users that subscribe to the specified broadcaster.
Check User Subscription
Checks whether the user subscribes to the broadcaster's channel.

Teams

Get information related to Twitch Teams.

Get Teams
Gets information about the specified Twitch team.
Get Channel Teams
Gets the list of Twitch teams that the broadcaster is a member of.

Users

Get information related to users, and act on behalf of a Twitch user's account.

Get Authorization By User
Gets the authorization scopes that the specified user has granted the application.
Get Users
Gets information about one or more users.
Update User
Updates the user's information.
Get User Block List
Gets the list of users that the broadcaster has blocked.
Block User
Blocks the specified user from interacting with or having contact with the broadcaster.
Unblock User
Removes the user from the broadcaster's list of blocked users.
Get User Active Extensions
Gets the active extensions that the broadcaster has installed for each configuration.
Update User Extensions
Updates an installed extension's information.
Get User Extensions
Gets a list of all extensions (both active and inactive) that the broadcaster has installed.

Videos

Get and manage and a broadcaster's Twitch VODs.

Get Videos
Gets information about one or more published videos.
Delete Videos
Deletes one or more videos.

Whispers

Send whispers on behalf of a Twitch user.

Send Whisper
Sends a whisper message to the specified user.