BetterTTV

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/

GET/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.

Field	Type	Description
`id`	`string`	The user ID.
`bots`	`string[]`	List of usernames which BetterTTV renders with a bot badge.
`avatar`	`string`	The user avatar.
`channelEmotes`	Emote[]	A list of channel emotes.
`sharedEmotes`	Emote[]	A list of shared emotes.

GET/cached/emotes/global

Returns all BetterTTV's Global Emotes.

Emote[]

GET/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	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`