This guide describes how to use Twitch Authentication to enable your application to take actions on behalf of a Twitch account or access certain data about users’ accounts. The preferred method of authentication is OAuth. We use parts of the OAuth 2.0 protocol.
In addition to OAuth, Twitch supports OIDC (OpenID Connect) for a more secure OAuth 2.0 flow. OIDC tokens are compatible with services built for OIDC compliance, such as Cognito by Amazon Web Services.
An amendment proposed by Rep. Alexandria Ocasio-Cortez (D-NY) that would ban the US military from recruiting on Twitch failed a House vote Thursday evening. Had it passed, it would have been an. TWITCH TV LIVE STREAM FAILS! Streamers on Twitch can lead to some funny fails. Leave a Like if you enjoyed! STREAMERS THAT GOT SWATTED LIVE https://www.you.
- Registering your app to obtain a client ID and client secret.
- Getting a token. This includes specifying scopes, the permissions your app requires.
- Sending the token in your API request, to authenticate API requests.
Code samples are available for Go and Node.js.
Warning: Treat your token like a password. For example, never use access tokens in any public URL, and never display tokens on any web page without requiring a click to de-obfuscate.
If you use Twitch authentication for login purposes only, access tokens should be validated on a recurring interval. Periodic validation of previously issued OAuth tokens ensures that users who authorized your application have not decided to disconnect the integration.
You must validate access tokens before making API requests which perform mutations on or access sensitive information of users, if it has been more than one hour since the last validation.
Twitch periodically conducts audits. If we discover an application that is not re-validating access tokens (that is, an application that validates only for login and not thereafter), we will reach out and work with developers to resolve the issue. If the issue is not resolved, we may take punitive action, such as revoking the developer’s API key or throttling the application’s performance.
Validation is important because of how OAuth access tokens work and the end user’s expectation of OAuth session control. For example, users who opt to disconnect your integration from their Twitch accounts can do so from their account settings on Twitch. When a user disconnects from an integration, all OAuth tokens between that user and that integration are invalidated. In this scenario, the expectation is that OAuth tokens are tied to sessions on third-party services; as such, any existing sessions between the disconnected user and those services also should be invalidated.
When validating each of your requests, submit a request to the validation endpoint (
https://id.twitch.tv/oauth2/validate) with your OAuth token in the header. If you are authenticated, the response includes the status of your token. A successful response indicates that your access token is valid.
Here is a sample request:
And here is a sample response:
To make an application that uses the Twitch API, you first need to register your application on the Twitch developer site. When creating this app, enter your redirect URI, which is where your users are redirected after being authorized. You can provide several redirect URIs, for example, if you wish to use the same client for different environments.
Once you create a developer application, you are assigned a client ID. Some authentication flows also require a client secret, which you can generate on the same page as the client ID.
- Client IDs are public and can be shared (for example, embedded in the source of a Web page).
- Client secrets are equivalent to a password for your application and must be kept confidential. Never expose it to users, even in an obscured form.
Because your client secret is confidential, we cannot show it to you once you leave the page, so make sure to record it somewhere safe. Also, generating a new client secret immediately invalidates the current one, which might make your API requests fail until your app is updated.
Warning:Client IDs should be unique for each application: do not re-use client IDs across multiple applications. Also, applications should request the appropriate scopes for the intended target APIs. Failure to adhere to these guidelines may result in the suspension of your application’s access to the Twitch API.
Types of tokens
Twitch supports several types of tokens:
|ID tokens (OIDC)||A set of claims about the end user, for a given authorization. Using OIDC ID tokens (JWT) enables you to get details about your user (such as email address) for a particular authorization. These details are represented by claims in the ID token’s payload.|
Our discovery endpoint is at https://id.twitch.tv/oauth2/.well-known/openid-configuration. It can be used with standard OIDC clients like AWS Cognito.
|User access tokens||Authenticate users and allow your app to make requests on their behalf. If your application uses Twitch for login or makes requests in the context of an authenticated user, you need to generate a user access token.|
|App access tokens||Authenticate your app and allow it to access resources that it owns. Since app access tokens are not associated with a user, they cannot be used with endpoints that require user authentication.|
Some Twitch API endpoints require application authentication (not user authentication). If your application uses these endpoints, you need to generate an app access token. App access tokens get client credentials (not user credentials). They enable you to make secure API requests that are not on behalf of a specific user. Client credentials also may be used in place of client ID headers to securely identify your application.
App access tokens expire after about 60 days, so you should check that your app access token is valid by submitting a request to the validation endpoint (see Validating Requests). If your token has expired, generate a new one.
App access tokens are meant only for server-to-server API requests and should never be included in client code.
User access tokens and app access tokens are both bearer tokens. “Bearer” comes from the authorization header; see Sending User Access and App Access Tokens.
The domain dedicated to Twitch authentication is https://id.twitch.tv.
Note: URLs have been updated to replace https://api.twitch.tv/kraken with https://id.twitch.tv. Code that uses the old kraken domain for Twitch authentication will continue to work until the removal of Twitch API v. 5 functionality. Twitch API v. 5 is currently deprecated.
We support several authentication flows:
|Authorization code flow||Your application uses a server, can securely store a client secret, and can make server-to-server requests.|
|Client credentials flow||You need an app access token.|
The procedure you should use to get tokens depends on the type(s) of tokens you want:
|Procedure||User Access Token||ID Token||App Access Token|
|OIDC Implicit Code Flow||✔||✔|
|OAuth Implicit Code Flow||✔|
|OIDC Authorization Code Flow||✔||✔|
|OAuth Authorization Code Flow||✔|
|OAuth Client Credentials Flow||✔|
For security purposes, examples in these sections use a fake access token,
Sending user access and app access tokens
When an API request requires authentication, send the access token as a header. The header differs, depending on which API you use:
In the Twitch API:
curl -H 'Authorization: Bearer <access token>' https://api.twitch.tv/helix/
In Twitch API v5 (deprecated ):
curl -H 'Authorization: OAuth <access token>' https://api.twitch.tv/kraken/
Revoking access tokens
To clean up previously obtained access tokens, use the Twitch OAuth token-revocation endpoint. The implementation follows the OAuth standard.
On your server, revoke an access token by making this request:
For example, using our previously authenticated user, the request is:
This request also works for app access tokens. To revoke the app access token we created previously, make this request:
Successful requests return
200 OK with no body. Requests with invalid tokens return
400 Bad Request with an “Invalid token” message in the body of the response.
Malformed requests return
400 Bad Request, along with information about how to fix the request, typically reminding the requester to include the
Refreshing access tokens
New OAuth2 access tokens have expirations. Token-expiration periods vary in length, based on how the token was acquired. Tokens return an
expires_in field indicating how long the token should last. However, you should build your applications in such a way that they are resilient to token authentication failures. In other words, an application capable of refreshing tokens should not need to know how long a token will live. Rather, it should be prepared to deal with the token becoming invalid at any time.
To allow for applications to remain authenticated for long periods in a world of expiring tokens, we allow for sessions to be refreshed, in accordance with the guidelines in “Refreshing an Access Token” in the OAuth2 RFC. Generally, refresh tokens are used to extend the lifetime of a given authorization.
Note: App access tokens and ID tokens cannot be refreshed.
How to refresh
To refresh a token, you need an access token/refresh token pair coming from a body. For example:
You also need the
client_secret used to generate the above access token/refresh token pair
To refresh, use this request:
There are several required parameters and one optional parameter:
|string||Your client ID.|
|string||Your client secret.|
|string||Must be |
|string||Refresh token issued to the client.|
Your refresh token may contain characters that are not URL safe, so be sure to URL encode the characters of your refresh token before inserting it into the body of the refresh request. Otherwise, you may get an error (“Invalid refresh token”) when you try to refresh.
|string||Space-separated list of scopes. This must be the entire set or any subset of the scopes assigned to the original token grant. It cannot include any scope not originally granted by the resource owner. Default: the entire set of scopes originally granted.|
Here is a sample response on success. It contains the new access token, refresh token, and scopes associated with the new grant. Your application should then update its record of the refresh token to be the value provided in this response, as the refresh token may change between requests.
Here is the body of an unsuccessful response:
When a user changes their password or disconnects an app, we delete all tokens for that user. Both refresh and access tokens for that user will return
Refresh in response to server rejection for bad authentication
We recommend that you refresh your tokens in response to being rejected by the server for bad authentication. It is good practice to assume that your access token can expire or be revoked at any time, and refreshing reactively ensures that your application is prepared to deal with such situations as gracefully as possible. For this reason, refreshing in response to server rejection is preferable to refreshing proactively, on a fixed schedule.
When you make a request with expired or incorrect authorization credentials, the API returns a
401 Unauthorized status:
On seeing a
401 error, an application should try to refresh the session if a refresh token is present. If the refresh fails, the application should re-prompt the end user with another authentication dialog via the standard OAuth 2 flow.
Handling token refreshes in an application
We recommend that you do access-token refreshes synchronously with respect to all consumers of a given access token. That is, do not send multiple, simultaneous refresh requests for the same token. Send one refresh request, then redistribute the new token that is returned from that request to all consumers, as appropriate.
The API limits the number of active access tokens associated with a given refresh token. The limit is 50 token per client/user (that is, a user can only have 50 tokens live at a time per client ID). If multiple threads sharing the same authorization were to simultaneously refresh, some of them might not have working credentials at the end of the refresh. Synchronizing on the refresh operation prevents the application from inadvertently overrunning its limit.
As mentioned above, when you request authorization from users, the URL
scope parameter allows you to specify which permissions your app requires. These scopes are tied to the access token you receive on successful authorization. Multiple scopes can be specified when requesting an OAuth or OIDC token. Without specifying scopes, your app can access only basic information about the authenticated user.
Scopes are specified as a space-separated list in the URL
scope parameter, when requesting authorization:
Twitch Fails Uncensored Wcw
Ask only for the permissions you need, as users can view each requested permission when authorizing your app.
No scopes are needed when requesting app access tokens.
The table below is a comprehensive list of the available scopes for the Twitch API. To see a comprehensive of all Twitch API endpoints, including those that do not require scopes, refer to the Twitch API reference.
|Scope Name||Type of Access and Associated Endpoints|
|View analytics data for the Twitch Extensions owned by the authenticated account.|
Get Extension Analytics
|View analytics data for the games owned by the authenticated account.|
Get Game Analytics
|View Bits information for a channel.|
Get Bits Leaderboard
|Run commercials on a channel.|
|Manage a channel’s broadcast configuration, including updating channel configuration and managing stream markers and stream tags.|
Modify Channel Information
Create Stream Marker
Replace Stream Tags
|Manage a channel’s Extension configuration, including activating Extensions.|
Get User Active Extensions
Update User Extensions
|Manage a channel’s polls.|
|Manage of channel’s Channel Points Predictions|
Create Channel Points Prediction
End Channel Points Prediction
|Manage Channel Points custom rewards and their redemptions on a channel.|
Create Custom Rewards
Delete Custom Reward
Update Custom Reward
Update Redemption Status
|Manage a channel’s videos, including deleting videos.|
|View a list of users with the editor role for a channel.|
Get Channel Editors
|View Hype Train information for a channel.|
Get Hype Train Events
|View a channel’s polls.|
|View a channel’s Channel Points Predictions.|
Get Channel Points Predictions
|View Channel Points custom rewards and their redemptions on a channel.|
Get Custom Reward
Get Custom Reward Redemption
|View an authorized user’s stream key.|
Get Stream Key
|View a list of all subscribers to a channel and check if a user is subscribed to a channel.|
Get Broadcaster Subscriptions
|Manage Clips for a channel.|
|View a channel’s moderation data including Moderators, Bans, Timeouts, and Automod settings.|
Check AutoMod Status
Get Banned Events
Get Banned Users
Get Moderator Events
|Manage a user object.|
|Edit a user’s follows.|
Create User Follows
Delete User Follows
|Manage the block list of a user.|
|View the block list of a user.|
Get User Block List
|View a user’s broadcasting configuration, including Extension configurations.|
Get Stream Markers
Get User Extensions
Get User Active Extensions
|View the list of channels a user follows. |
Get Followed Streams
|View if an authorized user is subscribed to specific channels.|
Check User Subscription
Twitch Fails Youtube
Legacy Twitch API v5
With the deprecation of Twitch API v5, the scopes below have been mapped to Twitch API scopes for an easier migration between versions. You can find this mapping and information about equivalent endpoints on the Twitch API Migration Guide.
|Scope Name||Type of Access|
|Read all subscribers to a channel.|
|Trigger commercials on a channel.|
|Write channel metadata (game, status, etc).|
|Manage a user’s followed channels.|
|View a channel’s email address and stream key.|
|View a user’s information.|
|Read a user’s block list.|
|Manage a user’s block list.|
Chat and PubSub
Twitch Fails Girl
Twitch Fails #60
|Scope Name||Type of Access|
|Perform moderation actions in a channel. The user requesting the scope must be a moderator in the channel.|
|Send live stream chat and rooms messages.|
|View live stream chat and rooms messages.|
|View your whisper messages.|
|Send whisper messages.|