Dashboard

BetterTTV API

We use a RESTful API to send and receive data to and from clients. All endpoints are prefixed with the following

https://api.betterttv.net/3/

User

GET/cached/users/{provider}/{providerId}

Get an User by their provider and provider id.

Path Structure

FieldTypeDescription
providerProviderThe name of the platform.
providerIdstringPlatform user Id for specified provider.

Response Structure

FieldTypeDescription
idstringThe user ID.
botsstring[]List of usernames which BetterTTV renders with a bot badge.
avatarstringThe user avatar.
channelEmotesEmote[]A list of channel emotes.
sharedEmotesEmote[]A list of shared emotes.

Example Response

{
  "id": "57b1e81425cb03b67237f27e",
  "bots": [
    "nightbot"
  ],
  "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/9b66f06b-ea7c-42ed-afdd-a3dc854009d3-profile_image-300x300.png",
  "channelEmotes": [
    {
      "id": "63059a7f8d5463737706192a",
      "code": "anotherTest",
      "imageType": "png",
      "animated": false,
      "userId": "57b1e81425cb03b67237f27e"
    }
  ],
  "sharedEmotes": [
    {
      "id": "5980af4e3a1ac5330e89dc76",
      "code": "HYPERS",
      "imageType": "png",
      "animated": false,
      "user": {
        "id": "57ea01a4665bcff56f0b64da",
        "name": "to_ot",
        "displayName": "tO_Ot",
        "providerId": "133315887"
      }
    }
  ]
}

Global Emotes

GET/cached/emotes/global

Returns all BetterTTV's Global Emotes.

Response Structure

Emote[]

Response Structure

[
  {
    "id": "54fa8f1401e468494b85b537",
    "code": ":tf:",
    "imageType": "png",
    "animated": false,
    "userId": "5561169bd6b9d206222a8c19"
  },
  {
    "id": "54fa8fce01e468494b85b53c",
    "code": "CiGrip",
    "imageType": "png",
    "animated": false,
    "userId": "5561169bd6b9d206222a8c19"
  }
]

Badges

GET/cached/badges/{provider}

Returns list of users with badges.

Path Structure

FieldTypeDescription
providerProviderThe name of the platform.

Response Structure

Badge[]

Badge Structure

FieldTypeDescription
idstringID of user with badge.
namestringUsername of user with badge.
displayNamestringDisplay name of user with badge.
providerIdstringPlatform user Id of user with badge.
badge.descriptionstringDescription of badge.
badge.svgstringURL of badge.
badge.typeBadgeTypeType of badge

Badge Type Enum

FieldTypeValue
Developerinteger1
NightDev Support Volunteerinteger2
BetterTTV Emote Approverinteger3
BetterTTV Translatorinteger4

Example Response

[
  {
    "id": "5533513462b6bd2027aee68d",
    "name": "someguy",
    "displayName": "SomeGuy",
    "providerId": "123456789",
    "badge": {
      "description": "NightDev Support Volunteer",
      "svg": "https://cdn.betterttv.net/badges/support_volunteer.svg",
      "type": 2
    }
  }
]

Emote Structure

FieldTypeDescription
idstringID of the emote.
codestringName of the emote.
imageTypestringThe image type, e.g. "png", "webp" or "gif".
animatedbooleanWhether the emote is animated.
user?.idstringThe user ID of the emote owner.
user?.namestringThe username of the emote owner.
user?.displayNamestringThe display name of the emote owner.
user?.providerIdstringPlatform user ID of the emote owner.

Provider Enum

FieldTypeValue
Twitchstringtwitch
YouTubestringyoutube