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//cached/users/{provider}/{providerId}Get an User by their provider and provider id.
| Field | Type | Description |
|---|---|---|
provider | Provider | The name of the platform. |
providerId | string | Platform user Id for specified provider. |
{
"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"
}
}
]
}/cached/emotes/globalReturns all BetterTTV's Global Emotes.
Emote[][
{
"id": "54fa8f1401e468494b85b537",
"code": ":tf:",
"imageType": "png",
"animated": false,
"userId": "5561169bd6b9d206222a8c19"
},
{
"id": "54fa8fce01e468494b85b53c",
"code": "CiGrip",
"imageType": "png",
"animated": false,
"userId": "5561169bd6b9d206222a8c19"
}
]/cached/badges/{provider}Returns list of users with badges.
| Field | Type | Description |
|---|---|---|
provider | Provider | The name of the platform. |
Badge[]| Field | Type | Description |
|---|---|---|
id | string | ID of user with badge. |
name | string | Username of user with badge. |
displayName | string | Display name of user with badge. |
providerId | string | Platform user Id of user with badge. |
badge.description | string | Description of badge. |
badge.svg | string | URL of badge. |
badge.type | BadgeType | Type of badge |
| Field | Type | Value |
|---|---|---|
| Developer | integer | 1 |
| NightDev Support Volunteer | integer | 2 |
| BetterTTV Emote Approver | integer | 3 |
| BetterTTV Translator | integer | 4 |
[
{
"id": "5533513462b6bd2027aee68d",
"name": "someguy",
"displayName": "SomeGuy",
"providerId": "123456789",
"badge": {
"description": "NightDev Support Volunteer",
"svg": "https://cdn.betterttv.net/badges/support_volunteer.svg",
"type": 2
}
}
]| Field | Type | Description |
|---|---|---|
id | string | ID of the emote. |
code | string | Name of the emote. |
imageType | string | The image type, e.g. "png", "webp" or "gif". |
animated | boolean | Whether the emote is animated. |
userId? | string | The user ID of the emote owner. ("userId" OR "user" provided) |
user?.id | string | The user ID of the emote owner. ("userId" OR "user" provided) |
user?.name | string | The username of the emote owner. |
user?.displayName | string | The display name of the emote owner. |
user?.providerId | string | Platform user ID of the emote owner. |
| Field | Type | Value |
|---|---|---|
| Twitch | string | twitch |
| YouTube | string | youtube |