Namespace: Leaderboards

Interact with the BeatLeader Leaderboard API endpoints

Source: BeatLeader/Leaderboard.js, line 4

Methods

(static) get(leaderboardSearchOptions) → {Promise}

Retrieves a list of leaderboards

Parameters:

Name Type Description

leaderboardSearchOptions

Object

Filters to narrow search. See options in table below

Parameter	Type	Description	Valid Values
page	number	(Optional) Page number	N/A
count	number	(Optional) Number of items per page	N/A
sortBy	LeaderboardSortBy	(Optional) Sorting criteria	`0`, `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `"date"`, `"pp"`, `"acc"`, `"pauses"`, `"rank"`, `"maxStreak"`, `"mistakes"`, `"weight"`, `"weightedPp"`
order	Order	(Optional)Sorting order	`"asc"`, `"desc"`
search	string	(Optional) Search query	N/A
type	Type	(Optional) Type of item	N/A
mode	string	(Optional) Mode of item	N/A
difficulty	Difficulties	(Optional) Difficulty level	`"Standard"`, `"OneSaber"`, `"90Degree"`, `"360Degree"`
mapType	MapsType	(Optional) Map type	`0`, `1`, `2`, `"ranked"`, `"unranked"`, `"all"`
allTypes	Operation	(Optional) Operation for all types	`0`, `1`, `2`, `"any"`, `"all"`, `"not"`
mapRequirements	RequirementsString	(Optional) Map requirements	`"none"`, `"chroma"`, `"noodles"`, `"mappingExtensions"`, `"cinema"`, `"v3"`, `"optionalProperties"`, `"ignore"`
allRequirements	Operation	(Optional) Operation for all requirements	`0`, `1`, `2`, `"any"`, `"all"`, `"not"`
songStatus	SongStatus	(Optional) Status of the song	`0`, `2`, `4`, `8`, `16`, `32`, `"none"`, `"curated"`, `"mapOfTheWeek"`, `"noodleMonday"`, `"featuredOnCC"`, `"beastSaberAwarded"`
leaderboardContext	LeaderboardContexts	(Optional) Context of the leaderboard	`0`, `2`, `4`, `8`, `16`, `32`, `64`, `128`, `"none"`, `"general"`, `"noMods"`, `"noPause"`, `"golf"`, `"sCPM"`, `"speedrun"`, `"speedrunBackup"`
mytype	MyType	(Optional) Custom type	`0`, `1`, `2`, `3`, `4`, `5`, `6`, `"none"`, `"played"`, `"unplayed"`, `"myNominated"`, `"othersNominated"`, `"myMaps"`
stars_from	number	(Optional) Minimum stars	N/A
stars_to	number	(Optional) Maximum stars	N/A
accrating_from	number	(Optional) Minimum accuracy rating	N/A
accrating_to	number	(Optional) Maximum accuracy rating	N/A
passrating_from	number	(Optional) Minimum pass rating	N/A
passrating_to	number	(Optional) Maximum pass rating	N/A
techrating_from	number	(Optional) Minimum tech rating	N/A
techrating_to	number	(Optional) Maximum tech rating	N/A
date_from	number	(Optional) Start date	N/A
mapper	number	(Optional) Mapper ID	N/A
overrideCurrentId	string	(Optional) Override current ID	N/A

Source: BeatLeader/Leaderboard.js, line 10

Returns:

A promise with a list of leaderboards

Type:: Promise

(static) getById(id, leaderboardSearchOptions) → {Promise}

Retrieves a list of leaderboards

Parameters:

Name Type Description

id

string

ID of the leaderboard to retrieve details for

leaderboardSearchOptions

Object

Filters to narrow search. See options in table below

Parameter	Type	Description	Valid Values
page	number	(Optional) Page number	N/A
count	number	(Optional) Number of items per page	N/A
sortBy	LeaderboardSortBy	(Optional) Sorting criteria	`0`, `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `"date"`, `"pp"`, `"acc"`, `"pauses"`, `"rank"`, `"maxStreak"`, `"mistakes"`, `"weight"`, `"weightedPp"`
order	Order	(Optional) Sorting order	`"asc"`, `"desc"`
scoreStatus	ScoreFilterStatus	(Optional) Score status filter	`0`, `1`, `"none"`, `"suspicious"`
leaderboardContext	LeaderboardContexts	(Optional) Context of the leaderboard	`0`, `2`, `4`, `8`, `16`, `32`, `64`, `128`, `"none"`, `"general"`, `"noMods"`, `"noPause"`, `"golf"`, `"sCPM"`, `"speedrun"`, `"speedrunBackup"`
countries	Array	(Optional) List of country codes	N/A
search	string	(Optional) Search query	N/A
modifiers	string	(Optional) Modifiers	N/A
friends	boolean	(Optional) Filter by friends	N/A
voters	boolean	(Optional) Filter by voters	N/A
prediction	boolean	(Optional) Prediction filter	N/A

Source: BeatLeader/Leaderboard.js, line 62

Returns:

A promise with leaderboard details

Type:: Promise

(static) getClanRankingsById(id, page, count) → {Promise}

Retrieves clan rankings for a leaderboard

Parameters:

Name	Type	Description
`id`	string	ID of the leaderboard to retrieve clan rankings for
`page`	number	Page number for pagination, default is 1
`count`	number	Number of rankings per page, default is 10

Source: BeatLeader/Leaderboard.js, line 102

Returns:

A promise with clan rankings

Type:: Promise

(static) getScoregraphById(id) → {Promise}

Retrieves the score graph for a leaderboard

Parameters:

Name	Type	Description
`id`	string	ID of the leaderboard to retrieve the score graph for

Source: BeatLeader/Leaderboard.js, line 129

Returns:

A promise with score graph data

Type:: Promise