regions.list

Description

Returns a list of regions available to this namespace. Regions are sorted by most optimal to least optimal. The player's IP address is used to calculate the regions' optimality.

Code Examples

curl -X GET 'https://api.rivet.gg/matchmaker/regions'

Request Parameters

Response Body

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.