Twitch API Docs i18n
GitHubGitHub (opens in a new tab)
  • Overview
    • Overview
    • Get Started
    • Starting a Raid
    • Getting Goal Progress
    • Running a Poll
    • Running a Prediction
    • Creating Clips
    • Creating Stream Markers
    • Getting Videos
    • Moderating a Broadcaster Chat
    • Scheduling Broadcasts
    • Twitch API Concepts
    • Reference
    • v5 Migration Guide
      • Add Blocked Term
      • Add Channel Moderator
      • Add Channel VIP
      • Ban User
      • Block User
      • Cancel a raid
      • Check AutoMod Status
      • Check User Subscription
      • Create Channel Stream Schedule Segment
      • Create Clip
      • Create Custom Rewards
      • Create EventSub Subscription
      • Create Extension Secret
      • Create Poll
      • Create Prediction
      • Create Stream Marker
      • Delete Channel Stream Schedule Segment
      • Delete Chat Messages
      • Delete Custom Rewards
      • Delete EventSub Subscriptions
      • Delete Videos
      • End Poll
      • End Prediction
      • Get All Stream Tags
      • Get AutoMod Settings
      • Get Banned Users
      • Get Bits Leaderboard
      • Get Blocked Terms
      • Get Broadcaster Subscriptions
      • Get Channel Chat Badges
      • Get Channel Editors
      • Get Channel Emotes
      • Get Channel Followers
      • Get Channel Information
      • Get Channel Stream schedule
      • Get Channel Teams
      • Get Channel iCalendar
      • Get Charity Campaign
      • Get Charity Campaign Donations
      • Get Chat Settings
      • Get Chatters
      • Get Cheermotes
      • Get Clips
      • Get Creator Goals
      • Get Custom Reward
      • Get Custom Reward Redemption
      • Get Drops Entitlements
      • Get Emote Sets
      • Get EventSub Subscriptions
      • Get Extension Analytics
      • Get Extension Bits Products
      • Get Extension Configuration Segment
      • Get Extension Live Channels
      • Get Extension Secrets
      • Get Extension Transactions
      • Get Extensions
      • Get Followed Channels
      • Get Followed Streams
      • Get Game Analytics
      • Get Games
      • Get Global Chat Badges
      • Get Global Emotes
      • Get Hype Train Events
      • Get Moderators
      • Get Polls
      • Get Predictions
      • Get Released Extensions
      • Get Shield Mode Status
      • Get Soundtrack Current Tracks
      • Get Soundtrack Playlist
      • Get Soundtrack Playlists
      • Get Stream Key
      • Get Stream Markers
      • Get Stream Tags
      • Get Streams
      • Get Teams
      • Get Top Games
      • Get User Active Extensions
      • Get User Block List
      • Get User Chat Color
      • Get User Extensions
      • Get Users
      • Get Users Follows
      • Get VIPs
      • Get Videos
      • Manage Held AutoMod Messages
      • Modify Channel Information
      • Remove Blocked Term
      • Remove Channel Moderator
      • Remove Channel VIP
      • Search Categories
      • Search Channels
      • Send Chat Announcement
      • Send Extension Chat Message
      • Send Extension PubSub Message
      • Send Whisper
      • Send a Shoutout
      • Set Extension Configuration Segment
      • Set Extension Required Configuration
      • Start Commercial
      • Start a raid
      • Unban User
      • Unblock User
      • Update AutoMod Settings
      • Update Channel Stream Schedule
      • Update Channel Stream Schedule Segment
      • Update Chat Settings
      • Update Custom Reward
      • Update Drops Entitlements
      • Update Extension Bits Product
      • Update Redemption Status
      • Update Shield Mode Status
      • Update User
      • Update User Chat Color
      • Update User Extensions
    • Overview
    • Handling Webhook Events
    • Handling WebSocket Events
    • Managing Subscriptions
    • Subscription Types
      • Fields
      • Bits Voting
      • Channel Points Voting
      • Choices
      • Conditions
      • Emotes
      • Events
      • Global Cooldown
      • Image
      • Last Contribution
      • Max Per Stream
      • Max Per User Per Stream
      • Message
      • Outcomes
      • Product
      • Reward
      • Shield Mode
      • Shoutout Create
      • Shoutout Received
      • Subscription
      • Top Contributions
      • Top Predictors
      • Transport
    • WebSocket Messages
    • Overview
    • Getting Started
    • Authenticating with the Server
    • Requesting Twitch Capabilities
    • Joining a Chat Room
    • Send and Receive Messages
    • Using Twitch Chat Commands
    • Getting Emotes
    • Twitch IRC Commands
    • Membership Commands
    • Twitch IRC Tags
    • Notice Message IDs
    • Example Chatbot
    • Example Message Parser
    • Overview
    • Register your app
    • Getting OAuth tokens
    • Get OAuth tokens using OIDC
    • Refreshing access tokens
    • Validating tokens
    • Revoking access tokens
    • Scopes
    • Guide
    • Guide
    • Introduction
    • Everything
    • Chat
    • Video & Clips
    • Get Started
    • Required Technical Background
    • Designing Extensions
    • Building Extensions
    • Using the Twitch API in an Extension Front End
    • Life Cycle Management
    • Monetization
    • A/B Testing
    • Using Google Analytics
    • Increase Feedback
    • Load Testing Extensions
    • Submission Best Practices
    • Guidelines and Policies
    • Reference
    • Guide
    • Guide
    • Guide
    • Guide
    • Reference
    • Overview
    • Configure the Twitch CLI
    • Get an Access Token
    • Call API Endpoints
    • Use the Mock Data Server
    • Test Webhook Events
    • Get CLI Version
    • Test Websocket Events
  • Overview
    • Overview
    • Get Started
    • Starting a Raid
    • Getting Goal Progress
    • Running a Poll
    • Running a Prediction
    • Creating Clips
    • Creating Stream Markers
    • Getting Videos
    • Moderating a Broadcaster Chat
    • Scheduling Broadcasts
    • Twitch API Concepts
    • Reference
    • v5 Migration Guide
      • Add Blocked Term
      • Add Channel Moderator
      • Add Channel VIP
      • Ban User
      • Block User
      • Cancel a raid
      • Check AutoMod Status
      • Check User Subscription
      • Create Channel Stream Schedule Segment
      • Create Clip
      • Create Custom Rewards
      • Create EventSub Subscription
      • Create Extension Secret
      • Create Poll
      • Create Prediction
      • Create Stream Marker
      • Delete Channel Stream Schedule Segment
      • Delete Chat Messages
      • Delete Custom Rewards
      • Delete EventSub Subscriptions
      • Delete Videos
      • End Poll
      • End Prediction
      • Get All Stream Tags
      • Get AutoMod Settings
      • Get Banned Users
      • Get Bits Leaderboard
      • Get Blocked Terms
      • Get Broadcaster Subscriptions
      • Get Channel Chat Badges
      • Get Channel Editors
      • Get Channel Emotes
      • Get Channel Followers
      • Get Channel Information
      • Get Channel Stream schedule
      • Get Channel Teams
      • Get Channel iCalendar
      • Get Charity Campaign
      • Get Charity Campaign Donations
      • Get Chat Settings
      • Get Chatters
      • Get Cheermotes
      • Get Clips
      • Get Creator Goals
      • Get Custom Reward
      • Get Custom Reward Redemption
      • Get Drops Entitlements
      • Get Emote Sets
      • Get EventSub Subscriptions
      • Get Extension Analytics
      • Get Extension Bits Products
      • Get Extension Configuration Segment
      • Get Extension Live Channels
      • Get Extension Secrets
      • Get Extension Transactions
      • Get Extensions
      • Get Followed Channels
      • Get Followed Streams
      • Get Game Analytics
      • Get Games
      • Get Global Chat Badges
      • Get Global Emotes
      • Get Hype Train Events
      • Get Moderators
      • Get Polls
      • Get Predictions
      • Get Released Extensions
      • Get Shield Mode Status
      • Get Soundtrack Current Tracks
      • Get Soundtrack Playlist
      • Get Soundtrack Playlists
      • Get Stream Key
      • Get Stream Markers
      • Get Stream Tags
      • Get Streams
      • Get Teams
      • Get Top Games
      • Get User Active Extensions
      • Get User Block List
      • Get User Chat Color
      • Get User Extensions
      • Get Users
      • Get Users Follows
      • Get VIPs
      • Get Videos
      • Manage Held AutoMod Messages
      • Modify Channel Information
      • Remove Blocked Term
      • Remove Channel Moderator
      • Remove Channel VIP
      • Search Categories
      • Search Channels
      • Send Chat Announcement
      • Send Extension Chat Message
      • Send Extension PubSub Message
      • Send Whisper
      • Send a Shoutout
      • Set Extension Configuration Segment
      • Set Extension Required Configuration
      • Start Commercial
      • Start a raid
      • Unban User
      • Unblock User
      • Update AutoMod Settings
      • Update Channel Stream Schedule
      • Update Channel Stream Schedule Segment
      • Update Chat Settings
      • Update Custom Reward
      • Update Drops Entitlements
      • Update Extension Bits Product
      • Update Redemption Status
      • Update Shield Mode Status
      • Update User
      • Update User Chat Color
      • Update User Extensions
    • Overview
    • Handling Webhook Events
    • Handling WebSocket Events
    • Managing Subscriptions
    • Subscription Types
      • Fields
      • Bits Voting
      • Channel Points Voting
      • Choices
      • Conditions
      • Emotes
      • Events
      • Global Cooldown
      • Image
      • Last Contribution
      • Max Per Stream
      • Max Per User Per Stream
      • Message
      • Outcomes
      • Product
      • Reward
      • Shield Mode
      • Shoutout Create
      • Shoutout Received
      • Subscription
      • Top Contributions
      • Top Predictors
      • Transport
    • WebSocket Messages
    • Overview
    • Getting Started
    • Authenticating with the Server
    • Requesting Twitch Capabilities
    • Joining a Chat Room
    • Send and Receive Messages
    • Using Twitch Chat Commands
    • Getting Emotes
    • Twitch IRC Commands
    • Membership Commands
    • Twitch IRC Tags
    • Notice Message IDs
    • Example Chatbot
    • Example Message Parser
    • Overview
    • Register your app
    • Getting OAuth tokens
    • Get OAuth tokens using OIDC
    • Refreshing access tokens
    • Validating tokens
    • Revoking access tokens
    • Scopes
    • Guide
    • Guide
    • Introduction
    • Everything
    • Chat
    • Video & Clips
    • Get Started
    • Required Technical Background
    • Designing Extensions
    • Building Extensions
    • Using the Twitch API in an Extension Front End
    • Life Cycle Management
    • Monetization
    • A/B Testing
    • Using Google Analytics
    • Increase Feedback
    • Load Testing Extensions
    • Submission Best Practices
    • Guidelines and Policies
    • Reference
    • Guide
    • Guide
    • Guide
    • Guide
    • Reference
    • Overview
    • Configure the Twitch CLI
    • Get an Access Token
    • Call API Endpoints
    • Use the Mock Data Server
    • Test Webhook Events
    • Get CLI Version
    • Test Websocket Events
Question? Give us feedback → (opens in a new tab)Edit this page
API
Getting Goal Progress
Starting a RaidRunning a Poll
Copyright © 2023 Twitch Docs i18n, Hyeon Woo Jo. Built with Nextra