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. |
/cached/emotes/global
Returns all BetterTTV's Global Emotes.
Emote[]
/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 |
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 |