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

HelixBitsApi

The Helix API methods that deal with bits.

Overview

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

Example

const api = new ApiClient(new StaticAuthProvider(clientId, accessToken));
const leaderboard = await api.helix.bits.getLeaderboard({ period: 'day' });

Methods

getCheermotes(broadcaster)

async

Retrieves all available cheermotes.

ParameterTypeDescription
broadcasterUserIdResolvable

The broadcaster to include custom cheermotes of.

If not given, only retrieves global cheermotes.

Return type: HelixCheermoteList

getLeaderboard(params)

async

Retrieves a bits leaderboard of your channel.

ParameterTypeDescription
paramsHelixBitsLeaderboardQuerysee below
params.contextUserIdstring

The user ID to show.

The leaderboard will be guaranteed to include this user and then have more users before and after that user.

params.countnumber

The number of leaderboard entries you want to retrieve.

params.period
HelixBitsLeaderboardPeriod

The possible time periods for a bits leaderboard.

Aliased type: "day" | "week" | "month" | "year" | "all"

The time period from which bits should count towards the leaderboard.

The leaderboards reset with the start of a new period, e.g. the week leaderboards reset every Monday midnight PST.

params.startDateDate

The time to retrieve the bits leaderboard for.