Get beatmap user score

The beatmaps.getBeatmapUserScore method on a Client instance makes a GET request to the beatmaps/{beatmap}/scores/users/{user} endpoint and returns a user’s score on a beatmap.

Example

const score = await api.beatmaps.getBeatmapUserScore(1816113, 12408961, {
  query: {
    mode: 'osu'
  }
});

Parameters

ParameterTypeOptionalDescription
beatmapnumberID of the beatmap to get the score from
usernumberID of the user to get the score from
optionsGetBeatmapScoresOptions

options.query

ParameterTypeOptionalDescription
modeGameModeGamemode of the score to return

Returns

Promise<BeatmapUserScore>;

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 .