Namespace: Leaderboard

Allows interaction with the ScoreSaber Leaderboard API endpoints

Source: Scoresaber/leaderboard.js, line 3

Methods

(static) difficultiesByHash(mapHash) → {Promise.<Array>}

Gets a maps difficulties based on hash

Parameters:

Name	Type	Description
`mapHash`	string	Map hash

Source: Scoresaber/leaderboard.js, line 127

Returns:

Difficulties offered on by a map

Type:: Promise.<Array>

(static) get(query, page, options) → {Promise.<Array>}

Gets a list of leaderboards based on filters

Parameters:

Name Type Description

query

string

Query for specific terms

page

number

Page of result

options

object

More Filters

Property	Type	Description	Valid Values
verified	boolean	Filter by verified (️deprecation notice)
ranked	boolean	Indicates if only ranked songs should be included.
qualified	boolean	Indicates if only qualified songs should be included.
loved	boolean	Indicates if only loved songs should be included.
minStar	number	The minimum star rating of songs to include.
maxStar	number	The maximum star rating of songs to include.
category	number	Which category to sort by (0 = trending, date ranked = 1,	`0`, `1`, `2`, `3`, `4`
		scores set = 2, star difficulty = 3, author = 4)
sort	number	The sorting order: 0 (Descending) or 1 (Ascending).	`0`, `1`
unique	boolean	Only return one leaderboard of each id.

Source: Scoresaber/leaderboard.js, line 9

Returns:

Type:: Promise.<Array>

(static) infoByHash(mapHash, difficulty, gameMode) → {Promise}

Gets leaderboard info based on map hash

Parameters:

Name	Type	Description
`mapHash`	string	Map hash
`difficulty`	number	(`1` = Easy, `3` = Normal, `5` = Hard, `7` = Expert, `9` = Expert+)
`gameMode`	number	`SoloStandard` by default

Source: Scoresaber/leaderboard.js, line 63

Returns:

Information on queried leaderboard

Type:: Promise

(static) infoById(leaderboardId) → {Promise}

Gets leaderboard information based on leaderboard id

Parameters:

Name	Type	Description
`leaderboardId`	number	Leaderboard ID

Source: Scoresaber/leaderboard.js, line 47

Returns:

Information on queried leaderboard

Type:: Promise

(static) scoresByHash(mapHash, difficulty, countries, search, page, gameMode, withMetadata) → {Promise.<Array>}

Gets a list of scores for a given hash

Parameters:

Name	Type	Description
`mapHash`	string	Map hash
`difficulty`	number	(`1` = Easy, `3` = Normal, `5` = Hard, `7` = Expert, `9` = Expert+)
`countries`	Array	Filter by ISO 3166-1 alpha-2 code
`search`	string	Query for specific terms
`page`	number	Page of result
`gameMode`	number	SoloStandard by default.
`withMetadata`	boolean	True by default. Returns total number of results, page number, and items per page

Source: Scoresaber/leaderboard.js, line 103

Returns:

Scores on queried leaderboard

Type:: Promise.<Array>

(static) scoresById(leaderboardId, countries, search, page, withMetadata) → {Promise.<Array>}

Gets a list of scores for a given map

Parameters:

Name	Type	Description
`leaderboardId`	number	Leaderboard ID
`countries`	Array	Filter by ISO 3166-1 alpha-2 code
`search`	string	Query for specific terms
`page`	number	Page of result
`withMetadata`	boolean	True by default. Returns total number of results, page number, and items per page

Source: Scoresaber/leaderboard.js, line 81

Returns:

Scores on queried leaderboard

Type:: Promise.<Array>