Class LeaderboardResource

Read-only leaderboard queries.

Index

Methods

list rank categories

Methods

list

list(options?: LeaderboardOptions): Promise<Record<string, unknown>>
Fetch a leaderboard page with optional filters.
Parameters
- options: LeaderboardOptions = {}
Returns Promise<Record<string, unknown>>
- Defined in src/resources/leaderboard.ts:24

rank

rank(
playerId: string,
options?: PlayerRankOptions,
): Promise<Record<string, unknown>>
Fetch a specific player's rank plus nearby players.
Parameters
- playerId: string
- options: PlayerRankOptions = {}
Returns Promise<Record<string, unknown>>
- Defined in src/resources/leaderboard.ts:49

categories

categories(): Promise<Record<string, unknown>>
List available leaderboard categories, brackets, and scopes.

Returns Promise<Record<string, unknown>>
- Defined in src/resources/leaderboard.ts:70