twitcheasy-twitch-bottwitch-authtwitch-auth-tmitwitch-chat-clienttwitch-eventsubtwitch-pubsub-clienttwitch-webhooks
Welcome

BadgesApi

The API methods that deal with badges.

Overview

Can be accessed using client.badges on an ApiClient instance.

Example

const api = new ApiClient(new StaticAuthProvider(clientId, accessToken));
const cheermotes = await api.badges.getGlobalBadges();

Methods

getChannelBadges(channel, includeGlobal, language)

async

Retrieves all applicable chat badges for a given channel.

ParameterTypeDescription
channelUserIdResolvable

The channel to retrieve the chat badges for.

includeGlobalboolean

Whether to include global badges in the result list.

languagestring

The language of the retrieved badge descriptions.

Return type: ChatBadgeList

getGlobalBadges(language)

async

Retrieves all globally applicable chat badges.

ParameterTypeDescription
languagestring

The language of the retrieved badge descriptions.

Return type: ChatBadgeList