Get user best scores

The getUserBestScores method on a LegacyClient instance makes a GET request to the get_user_best endpoint and returns an array of a user’s top scores.

Example

const scores = await legacyApi.getUserBestScores({
  u: 14544646
});

Parameters

Parameter	Type	Optional	Description
params	GetUserScoresParams		The request’s URL parameters
params.u	string \| number		Scores from a user with a specific user ID or username
params.m	GameMode	✓	Scores from a specific gamemode
params.limit	number	✓	Limit amount of scores to return (100 max.)
params.type	UserType	✓	Specify if `u` is a user ID (`id`) or a username (`string`)

Returns

Promise<LegacyUserBestScore[]>;

Types

LegacyUserBestScore

Possible Exceptions

See the error handling documentation for more information.

invalid_json_syntax
network_error
unexpected_response

Notice that something is missing? Found a typo? Think something's incomplete? Or think that something can be explained better? Feel free to open a pull request or submit an issue on the library's Github repository .