Contents

Bits Reference

While you can migrate from v3 to v5, know that v5 is deprecated and will be shutdown in the future. We prefer that you migrated directly to the new Twitch API.

Endpoint Description
Get Cheermotes

Retrieves the list of available cheermotes, animated emotes to which viewers can assign Bits, to cheer in chat. The cheermotes returned are available throughout Twitch, in all Bits-enabled channels.

Get Cheermotes

Retrieves the list of available cheermotes, animated emotes to which viewers can assign Bits, to cheer in chat. The cheermotes returned are available throughout Twitch, in all Bits-enabled channels.

Authentication

None

URL

GET https://api.twitch.tv/v5/bits/actions

Optional Query String Parameters

Name Type Description
channel_id string If this is specified, the cheermote for this channel is included in the response (if the channel owner has uploaded a channel-specific cheermote).

Example Request

This gets a list of all Twitch cheermotes.

curl -H 'Accept: application/vnd.twitchtv.v5+json' \
-H 'Client-ID: uo6dggojyb8d6soh92zknwmi5ej1q2' \
-X GET 'https://api.twitch.tv/kraken/bits/actions'

Example Response

{
   "actions": [
      {
         "backgrounds": [
               "light",
               "dark"
         ],
         "prefix": "Cheer",
         "scales": [
               "1",
               "1.5",
               "2",
               "3",
               "4"
         ],
         "states": [
               "static",
               "animated"
         ],
         "tiers": [
               {
                  "color": "#979797",
                  "id": "1",
                  "images": {
                     "dark": {
                           "animated": {
                              "1": "https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/dark/animated/1/1.gif",
                              "1.5": "https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/dark/animated/1/1.5.gif",
                              "2": "https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/dark/animated/1/2.gif",
                              "3": "https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/dark/animated/1/3.gif",
                              "4": "https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/dark/animated/1/4.gif"
                           },
                           "static": {
                              "1": "https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/dark/static/1/1.png",
                              "1.5": "https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/dark/static/1/1.5.png",
                              "2": "https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/dark/static/1/2.png",
                              "3": "https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/dark/static/1/3.png",
                              "4": "https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/dark/static/1/4.png"
                           }
                     },
                     "light": {
                           "animated": {
                              "1": "https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/light/animated/1/1.gif",
                              "1.5": "https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/light/animated/1/1.5.gif",
                              "2": "https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/light/animated/1/2.gif",
                              "3": "https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/light/animated/1/3.gif",
                              "4": "https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/light/animated/1/4.gif"
                           },
                           "static": {
                              "1": "https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/light/static/1/1.png",
                              "1.5": "https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/light/static/1/1.5.png",
                              "2": "https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/light/static/1/2.png",
                              "3": "https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/light/static/1/3.png",
                              "4": "https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/light/static/1/4.png"
                           }
                     }
                  },
                  "min_bits": 1
               },
               ...
         ]
      },
      ...
   ]
}
+