Twitch API Overview

The Twitch API enables you to develop your own applications using a rich feature set. You can get data about which streams are live, change information about specific channels, and use Twitch Identity to log into your application.

The newest version of the API is 5.0. Major changes in 5.0 are:

  • The new version of the API uses user IDs instead of user names to reference users.
  • The _links object was removed from all responses. Developers are now responsible for handling the paging offsets when polling the API.
  • Sub-second precision was added to time fields
  • The /games/featured endpoint was removed.
  • delay, background, and banner were removed from the channels response object.
  • For search endpoints, the q parameter is now called query, and the type parameter is always set to suggest.
  • The paywalled field was removed from the video response object.
  • The /kraken/chat endpoint was removed.

Note: The default version of the API is V3 until Feb. 14, 2018. However, V3 is scheduled to be deprecated (2017) and removed altogether (2018), so we strongly recommend you migrate to V5 now.

Getting Started

Please read the Using the Twitch API guide. Among other things, it includes information about getting client IDs, requests, responses, and error codes.

On this site:

  • Reference information provides details about and examples of each endpoint.
  • Guides provide background information necessary to understand the API, get set up to use it, and develop applications with it.
    • The Glossary defines Twitch API terms.
    • Authentication is the Twitch login system.
    • Chat enables viewers to send messages viewable by the broadcaster and other viewers. You can:
    • Embedding Video describes how to embed live streams, VODs, and Clips.
    • The Clips Discovery API enables you to discover user-generated, short-form video content about a game or channel or from a user’s followed games.
    • Drops is a tool set that supports developers in granting in-game rewards to your gaming communities natively within the Twitch viewing experience.
    • Mobile Deep Links describes how to launch the Twitch iOS and Android applications externally.
    • PubSub enables you to subscribe to a topic, for updates (e.g., when a user receives a whisper on Twitch).
    • The Video Upload API allows you to upload videos directly to Twitch.

Which API Version Can You Use?

Date V5 V3 V2 V1
Until Feb. 14, 2017
Feb. 14, 2017 - Feb. 13, 2018 deprecated    
Feb. 14, 2018 and later      

For Help Using the Developer Platform

For help or to let us know about API or documentation issues:

Terms of Use

By accessing or using Twitch API, you agree to comply with and be bound by the Twitch Developer Services Agreement. If you do not agree to be bound by the Twitch Developer Agreement, do not access or otherwise use the Twitch API.