Overview
Methods
Can be accessed using client.bits on an ApiClient instance.
Example
const api = new ApiClient({ authProvider });
const leaderboard = await api.bits.getLeaderboard({ period: 'day' });
Methods
getCheermotes(broadcaster)
asyncGets all available cheermotes.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| broadcaster | UserIdResolvable A user ID or a user or channel object. This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name. Aliased type: string | number | UserIdResolvableType | none | The broadcaster to include custom cheermotes of. If not given, only get global cheermotes. |
getLeaderboard(broadcaster, params)
asyncGets a bits leaderboard of your channel.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| broadcaster | UserIdResolvable A user ID or a user or channel object. This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name. Aliased type: string | number | UserIdResolvableType | none | The user to get the leaderboard of. | |
| params | HelixBitsLeaderboardQuery | <complex> | 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 get. | |
| 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 get the bits leaderboard for. |