Namespace: Scores

Interact with the BeatLeader Player Scores API endpoints. Get player score related info.

Source: BeatLeader/PlayerScores.js, line 4

Methods

(static) getAccGraph(id, accGraphOptions) → {Promise}

Retrieves accuracy graph data

Parameters:

Name Type Description

id

string

ID of user to get data for

accGraphOptions

Object

Filters to narrow search Certainly! Here's the table:

Parameter	Type	Description	Valid Values
type	string	(Optional) Type of sorting	`"acc"`, `"rank"`, `"weight"`, `"pp"`
leaderboardContext	LeaderboardContexts	(Optional) Context of the leaderboard	As defined in the LeaderboardContexts type
no_unranked_stars	boolean	(Optional) Whether to include unranked stars	`true` (include unranked stars), `false` (exclude unranked stars)

Source: BeatLeader/PlayerScores.js, line 130

Returns:

Returns a promise with acc graph data

Type:: Promise

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

Fetches a list of scores for a specific user based on filters

Parameters:

Name Type Description

id

string

ID of user to get data for

scoresSearchOptions

Object

Filters to narrow search results. See table below.

Parameter	Type	Description	Valid Values
sortBy	ScoresSortBy	(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"`
page	number	(Optional) Page number	N/A
count	number	(Optional) Number of items per page	N/A
search	string	(Optional) Search query	N/A
diff	string	(Optional) Difficulty level	`"Easy"`, `"Normal"`, `"Hard"`, `"Expert"`, `"ExpertPlus"`
mode	string	(Optional) Mode of item	`"Standard"`, `"OneSaber"`, `"90Degree"`, `"360Degree"`
requirements	Requirements	(Optional) Requirements	N/A
scoreStatus	ScoreFilterStatus	(Optional) Score status	N/A
leaderboardContext	LeaderboardContests	(Optional) Context of the leaderboard	N/A
type	DifficultyStatus	(Optional) Type of difficulty	N/A
modifiers	string	(Optional) Modifiers	N/A
stars_from	number	(Optional) Minimum stars	N/A
stars_to	number	(Optional) Maximum stars	N/A
time_from	number	(Optional) Start time	N/A
time_to	number	(Optional) End time	N/A
eventId	number	(Optional) Event ID	N/A

Source: BeatLeader/PlayerScores.js, line 10

Returns:

Returns a promise with scores

Type:: Promise

(static) getCompactById(id, scoresSearchOptions)

Retrieves a paginated list of scores for a specific user

Parameters:

Name Type Description

id

string

ID of user to get data for

scoresSearchOptions

Object

Filters to narrow search results

Parameter	Type	Description	Valid Values
sortBy	ScoresSortBy	(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"`
page	number	(Optional) Page number	N/A
count	number	(Optional) Number of items per page	N/A
search	string	(Optional) Search query	N/A
diff	string	(Optional) Difficulty level	`"Easy"`, `"Normal"`, `"Hard"`, `"Expert"`, `"ExpertPlus"`
mode	string	(Optional) Mode of item	`"Standard"`, `"OneSaber"`, `"90Degree"`, `"360Degree"`
requirements	Requirements	(Optional) Requirements	N/A
scoreStatus	ScoreFilterStatus	(Optional) Score status	N/A
leaderboardContext	LeaderboardContests	(Optional) Context of the leaderboard	N/A
type	DifficultyStatus	(Optional) Type of difficulty	N/A
modifiers	string	(Optional) Modifiers	N/A
stars_from	number	(Optional) Minimum stars	N/A
stars_to	number	(Optional) Maximum stars	N/A
time_from	number	(Optional) Start time	N/A
time_to	number	(Optional) End time	N/A
eventId	number	(Optional) Event ID	N/A

Source: BeatLeader/PlayerScores.js, line 56

Returns:

Returns a promise with compacted score data

(static) getCompactHistory(id, leaderboardContext, count) → {Promise}

Parameters:

Name	Type	Description
`id`	string	ID of user to get data for
`leaderboardContext`	string	Filter scores by leaderboard context, default is 'General'. Available values : `"none"`, `"general"`, `"noMods"`, `"noPause"`, `"golf"`, `"sCPM"`, `"speedrun"`, `"speedrunBackup"`
`count`	number	Amount of days to include. Default is 50

Source: BeatLeader/PlayerScores.js, line 192

Returns:

Returns a promise with compacted history

Type:: Promise

(static) getHistory(id, leaderboardContext, count) → {Promise}

Retrieves a lkist of players performance metrics and statistics

Parameters:

Name	Type	Description
`id`	string	ID of user to get data for
`leaderboardContext`	string	Filter scores by leaderboard context, default is 'General'. Available values : `"none"`, `"general"`, `"noMods"`, `"noPause"`, `"golf"`, `"sCPM"`, `"speedrun"`, `"speedrunBackup"`
`count`	number	Amount of days to include. Default is 50

Source: BeatLeader/PlayerScores.js, line 164

Returns:

Returns a promise with metrics and statistics

Type:: Promise

(static) getPinnedScores(id, leaderboardContext) → {Promise}

Retrieves a paginated list of pinned scores for a specific user

Parameters:

Name	Type	Description
`id`	string	ID of user to get data for
`leaderboardContext`	string	Filter scores by leaderboard context, default is 'General'. Available values : `"none"`, `"general"`, `"noMods"`, `"noPause"`, `"golf"`, `"sCPM"`, `"speedrun"`, `"speedrunBackup"`

Source: BeatLeader/PlayerScores.js, line 220

Returns:

Returns a promise with a list of pinned score data

Type:: Promise

(static) getScore(id, hash, difficulty, mode) → {Promise.<number>}

Gets a score made my a player on a specific map of a specific difficulty

Parameters:

Name	Type	Description
`id`	string	ID of user to get data for
`hash`	string	Map hash
`difficulty`	string	Difficuly to get score from
`mode`	string	Maps characterists. `"Standard"`, `"OneSaber"`, `"90Degree"`, `"360Degree"`

Source: BeatLeader/PlayerScores.js, line 102

Returns:

Returns a promise with the score

Type:: Promise.<number>