Get beatmap user scores

The beatmaps.getBeatmapUserScores method on a Client instance makes a GET request to the beatmaps/{beatmap}/scores/users/{user}/all endpoint and returns a user’s scores on a beatmap. beatmaps.getBeatmapUserScoresV2 makes a request to the same endpoint, but has the X-API-Version header set to 20220705.

Example

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

Parameters

Parameter	Type	Optional	Description
beatmap	number		ID of the beatmap to get scores from
user	number		ID of the user to get scores from
options	GetBeatmapScoresOptions	✓

options.query

Parameter	Type	Optional	Description
mode	GameMode	✓	Gamemode of the scores to return

Returns

If using beatmaps.getBeatmapUserScores:

Promise<Score[]>;

If using beatmaps.getBeatmapUserScoresV2:

Promise<ScoreV2[]>;

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 .