Lookup beatmap

The beatmaps.lookupBeatmap method on a Client instance makes a GET request to the beatmaps/lookup endpoint and returns a beatmap if it exists, otherwise undefined.

Example

const beatmap = await api.lookupBeatmap({
  query: {
    id: 1031991
  }
});

Parameters

Parameter	Type	Optional	Description
options	LookupBeatmapOptions	✓

options.query

Parameter	Type	Optional	Description
checksum	string	✓	A beatmap checksum
filename	string	✓	A beatmap file name
id	number	✓	ID of a beatmap

Returns

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

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 .