DOCSEARCHbyAlgolia
Submit Docs

Twitch Developer Documentation

website·Indexed 19 days ago

https://dev.twitch.tv/

Technical documentation for integrating with Twitch, featuring guides on the Twitch API, EventSub, and OAuth authentication. Includes detailed resources for building Twitch Extensions, implementing Twitch Drops campaigns, managing chat bots, and using the Twitch CLI for testing and API requests.

Tokens
314.9K
Snippets
936
Records
2.3K
Agent score
96%

What's inside Twitch API

  1. Overview of the Twitch Extension Configuration Service

    The Configuration Service acts as a key-value store for basic data, allowing developers to store persistent per-channel and per-Extension information without requiring a custom backend. It is primarily used to enable broadcasters to customize their Extension experience and to store user IDs for third-party API calls.

  2. Overview of Twitch IRC Server Commands

    The Twitch IRC server sends specific commands to bots only if the commands capability is requested. It is recommended to also request the tags capability to receive detailed metadata with these commands.

  3. Overview of Twitch Game Engine Plugins

    Twitch provides game engine plugins for Unity, Unreal, and Game Maker to simplify the integration of Twitch functionality into games. These plugins utilize Device Code Flow (DCF) Authentication, EventSub, and Helix endpoints. Supported features include Polls, Predictions, Channel Point Rewards, Followers, and Subscribers.

  4. Overview of Twitch Chat integration methods

    Twitch provides multiple ways to interact with chat rooms and messages. The preferred modern methods are EventSub and the Twitch API. For large-scale integrations (e.g., bots reading many large chats), a specific wrapper for loadbalancing conduit events is available. Historically, Twitch also provides an IRC interface based on a modified RFC1459 and IRCv3 Message Tag specification, though it has limited features and often requires accompanying API calls for full functionality (such as chat commands).

  5. Overview of Twitch Extension types

    Twitch Extensions allow developers to integrate applications directly into a Twitch channel. There are several types of extensions depending on the desired user interaction:

    • Overlay and Component Extensions: Interactive elements placed within the video player (e.g., live stats, real-time loadouts, heatmaps).
    • Panel Extensions: Experiences located below the video player (e.g., leaderboards, viewer requests, large audience game participation).
    • Extensions in Chat: Interactive elements that allow participants to engage directly within the channel chat.

  6. Overview of Twitch EventSub

    EventSub allows applications to listen for specific events on Twitch (e.g., broadcaster going online, new followers, new subscribers, cheers, or Channel Point redemptions). When a subscribed event occurs, Twitch sends a notification to the application. EventSub subscriptions are generally transport-agnostic, meaning most event types are available across all supported transport methods.

  7. Overview of Twitch Drops for Game Developers

    Twitch Drops allow game developers to distribute in-game rewards to the Twitch community when viewers watch participating channels streaming their game. Twitch tracks viewer behavior and activity; once a user meets the campaign rules, they can claim the reward, and Twitch notifies the developer's system to grant the item.

  9. Overview of Twitch Developer Products and Resources

    Twitch provides a suite of tools for developing third-party experiences. Key product offerings include:

    • Twitch API: General purpose API for interacting with Twitch data.
    • EventSub: Real-time notifications for Twitch events.
    • Extensions: Tools to add interactive overlays and features to channels.
    • Chat & Chatbots: Integration with Twitch chat via IRC.
    • PubSub: Publish-Subscribe messaging system.
    • Embedding Twitch: Integrating Twitch players and content into external sites.
    • Drops: Managing in-game rewards for viewers.
    • Game Engine Plugins: Integration tools for game development.

    Core concepts for developers include Authentication, Organizations, Insights & Analytics, Mobile Deep Links, and Video Broadcast.

  10. Introduction to Twitch Drops for Developers

    Twitch Drops allow game developers to grant in-game rewards to the Twitch community when streamers play their game. Twitch tracks viewer actions and watch activity for users watching participating channels in the game's category. Once a campaign's rules are satisfied, viewers can claim the reward, and the developer's systems are notified to grant the predetermined in-game item.

  11. Overview of Twitch Developer Products and Resources

    Twitch provides a suite of tools for developing third-party experiences. Key products include the Twitch API, EventSub (event notifications), Extensions, Chat & Chatbots (IRC), PubSub, Embedding Twitch, Drops, and Game Engine Plugins. Core concepts for developers include Authentication, Organizations, Insights & Analytics, Mobile Deep Links, and Video Broadcast.

  12. Overview of Twitch Drops for Game Developers

    Twitch Drops allow game developers to distribute in-game rewards to the Twitch community when viewers watch streamers playing their game. Twitch tracks specific viewer behaviors and activities; once a viewer meets the campaign rules, they are eligible to receive a predefined in-game item. This system helps developers increase awareness of key game moments, strengthen community bonds, and convert viewers into active players.