Get playlist scores

The multiplayer.getPlaylistScores method on a Client instance makes a GET request to the rooms/{room}/playlist/{playlist}/scores endpoint and returns an object containing playlist scores and metadata.

Example

const scores = await api.multiplayer.getPlaylistScores(274844, 1852978, {
  query: {
    limit: 5
  }
});

Parameters

Parameter	Type	Optional	Description
room	number		ID of the room corresponding to the playlist
playlist	number		ID of the playlist to get scores from
options	GetPlaylistScoresOptions	✓

options.query

Parameter	Type	Optional	Description
limit	number	✓	Limit number of results
sort	MultiplayerScoresSort	✓	Scores sorting
cursor_string	string	✓	Pagination cursor

Returns

Promise<MultiplayerScores>;

Types

MultiplayerScores

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 .