Get beatmap

The beatmaps.getBeatmap method on a Client instance makes a GET request to the beatmaps/{beatmap} endpoint and returns a beatmap.

Example

const beatmap = await api.beatmaps.getBeatmap(1816113);

Parameters

ParameterTypeOptionalDescription
beatmapnumberID of the beatmap to get

Returns

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

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 .