lobbies.list
Description
Lists all open lobbies.
When tokenless authentication is enabled in your game namespace, this endpoint does not require a token to authenticate. Otherwise, a development namespace token can be used for mock responses and a public namespace token can be used for general authentication.
Code Examples
Request
curl -X GET 'https://api.rivet.gg/matchmaker/lobbies/list'
Request Parameters
include_state
Query parameter, optional
Response Body
game_modes
array<object> (required)
game_modes[*].game_mode_id
string (required)
A human readable short identifier used to references resources. Different than a uuid because this is intended to be human readable. Different than DisplayName because this should not include special characters and be short.
lobbies
array<object> (required)
lobbies[*].game_mode_id
string (required)
lobbies[*].lobby_id
string (required)
lobbies[*].max_players_direct
integer (required)
lobbies[*].max_players_normal
integer (required)
lobbies[*].max_players_party
integer (required)
lobbies[*].region_id
string (required)
lobbies[*].state
object
lobbies[*].total_player_count
integer (required)
regions
array<object> (required)
regions[*].datacenter_coord
object (required)
Geographical coordinates for a location on Planet Earth.
regions[*].datacenter_coord.latitude
number (required)
regions[*].datacenter_coord.longitude
number (required)
regions[*].datacenter_distance_from_client
object (required)
Distance available in multiple units.
regions[*].datacenter_distance_from_client.kilometers
number (required)
regions[*].datacenter_distance_from_client.miles
number (required)
regions[*].provider_display_name
string (required)
regions[*].region_display_name
string (required)
regions[*].region_id
string (required)
A human readable short identifier used to references resources. Different than a uuid because this is intended to be human readable. Different than DisplayName because this should not include special characters and be short.