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

BitsApi

The API methods that deal with Bits/Cheermotes.

Overview

Can be accessed using client.kraken.bits on an ApiClient instance.

Example

const api = new ApiClient(new StaticAuthProvider(clientId, accessToken));
const cheermotes = await api.kraken.bits.getCheermotes();

Methods

getCheermotes(channel, includeSponsored)

async

Retrieves global and channel cheermotes.

ParameterTypeDescription
channelUserIdResolvable

The channel you want to retrieve the available cheermotes for. If not given, this method retrieves a list of globally available cheermotes.

includeSponsoredboolean

Whether to include sponsored cheermotes in the list.

Return type: CheermoteList