Overview
Methods
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)
asyncRetrieves all available cheermotes.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| broadcaster | UserIdResolvable | none |
The broadcaster to include custom cheermotes of. If not given, only retrieves global cheermotes. |
getLeaderboard(params)
asyncRetrieves a bits leaderboard of your channel.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| params | HelixBitsLeaderboardQuery | {} | see below | |
| params.contextUserId | string | none |
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.count | number | none |
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" |
none |
The time period from which bits should count towards the leaderboard.
The leaderboards reset with the start of a new period,
e.g. the |
|
| params.startDate | Date | none |
The time to retrieve the bits leaderboard for. |