Get beatmaps

The beatmaps.getBeatmaps method on a Client instance makes a GET request to the beatmaps endpoint and returns an array of beatmaps.

Example

const beatmaps = await api.beatmaps.getBeatmaps({
  query: {
    ids: [1816113, 131891]
  }
});

Parameters

Parameter	Type	Optional	Description
options	GetBeatmapsOptions	✓

options.query

Parameter	Type	Optional	Description
ids	number[]	✓	An array of beatmap IDs (can only take up to 50 IDs)

Returns

Promise<
  (Beatmap & {
    failtimes: Fails;
    max_combo: number;
    checksum: string | null;
    beatmapset: Beatmapset & {
      ratings: number[];
    };
  })[]
>;

Types

• Beatmap
• Fails
• Beatmapset

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 .