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

ParameterTypeOptionalDescription
paramsGetUserScoresParamsThe request’s URL parameters
params.ustring | numberScores from a user with a specific user ID or username
params.mGameModeScores from a specific gamemode
params.limitnumberLimit amount of scores to return (100 max.)
params.typeUserTypeSpecify if u is a user ID (id) or a username (string)

Returns

Promise<LegacyUserBestScore[]>;

Types

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 .