Get multiplayer lobby

The getMultiplayerLobby method on a LegacyClient instance makes a GET request to the get_match endpoint and returns an object containing the match’s information, games and each games’ scores if the multiplayer lobby exists, otherwise null.

Example

const multiLobby = await legacyApi.getMultiplayerLobby({
  u: 14544646
});

Parameters

ParameterTypeOptionalDescription
paramsGetMultiplayerLobbyParamsThe request’s URL parameters
params.mpnumberMatch with a specific match ID

Returns

Promise<LegacyMultiplayerLobby | null>;

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 .