Get beatmap top scores

The beatmaps.getBeatmapTopScores method on a Client instance makes a GET request to the beatmaps/{beatmap}/scores endpoint and returns an array of user scores on a beatmap.

Example

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

Parameters

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

options.query

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

Returns

Promise<
  (Score & {
    user: UserCompact & {
      country: Country;
      cover: Cover;
    };
  })[]
>;

Types

• Score
• UserCompact
• Country
• Cover

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 .