Library referenceClasses
PublicLeaderboardsApi
GET /leaderboards/*: player, clan, raid and KrunkCup boards
Constructors
Constructor
new PublicLeaderboardsApi(gapi): PublicLeaderboardsApi;Parameters
| Parameter | Type |
|---|---|
gapi | KrunkerClient |
Returns
PublicLeaderboardsApi
Methods
clans()
clans(sort?): Promise<ClanLeaderboardRow[]>;GET /leaderboards/player_clan, 100 rows
Parameters
| Parameter | Type | Default value |
|---|---|---|
sort? | ClanLeaderboardSort | "score" |
Returns
Promise<ClanLeaderboardRow[]>
krunkCupContributors()
krunkCupContributors(teamId): Promise<KrunkCupPlayerRow[]>;GET /leaderboards/krunkcup/teams/:id/contributors
Parameters
| Parameter | Type |
|---|---|
teamId | number |
Returns
Promise<KrunkCupPlayerRow[]>
krunkCupPlayers()
krunkCupPlayers(limit?): Promise<KrunkCupPlayerRow[]>;GET /leaderboards/krunkcup/players
Parameters
| Parameter | Type |
|---|---|
limit? | number |
Returns
Promise<KrunkCupPlayerRow[]>
krunkCupTeams()
krunkCupTeams(): Promise<KrunkCupTeam[]>;GET /leaderboards/krunkcup/teams
Returns
Promise<KrunkCupTeam[]>
players()
players(type, query?): Promise<PlayerLeaderboardRow[]>;GET /leaderboards/:type, 100 rows
Parameters
| Parameter | Type |
|---|---|
type | PlayerLeaderboardType |
query? | PlayerLeaderboardQuery |
Returns
Promise<PlayerLeaderboardRow[]>
raids()
raids(mapId, sort?): Promise<RaidLeaderboardRow[]>;GET /leaderboards/raids/:mapId, 100 rows, 400 "invalid raid map ID" for a map without raids
Parameters
| Parameter | Type |
|---|---|
mapId | number |
sort? | RaidSort |
Returns
Promise<RaidLeaderboardRow[]>
raidsMonthly()
raidsMonthly(
mapId,
month,
sort?
): Promise<RaidLeaderboardRow[]>;GET /leaderboards/raids/:mapId/monthly, month as "YYYY-MM" (a bare number answers a different board), null for a month without runs
Parameters
| Parameter | Type |
|---|---|
mapId | number |
month | string |
sort? | RaidSort |
Returns
Promise<RaidLeaderboardRow[]>