Locations

Get every region, country, state, and city that SteamSets knows, and use them to filter leaderboards by location.

SteamSets takes the location of an account from its Steam profile. A location has up to four levels: a region, a country, a state, and a city. You use these names to get a leaderboard for one location, for example the top accounts by XP in Germany.

Download all locations

These files contain every location that the leaderboard endpoints accept. We generate them again each time the docs are deployed.

curl -O https://docs.steamsets.com/locations/locations.json

locations.json has this shape:

{
  "regions": ["Africa", "Americas", "Antarctic", "Asia", "Europe", "Oceania"],
  "countries": [{ "name": "Germany", "code": "DE", "region": "Europe" }],
  "states": [{ "name": "Baden-Wurttemberg", "country": "Germany", "region": "Europe" }]
}

Each entry in cities.json has the form { "name", "state", "country", "region" }. For a city in a country without states, state is an empty string.

Filter a leaderboard by location

Send one location in the location array of leaderboard.getAccountLeaderboard. Each level needs all the levels above it:

curl https://api.steamsets.com/v1/leaderboard.getAccountLeaderboard \
  -H "Authorization: Bearer $STEAMSETS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "leaderboard": "xp",
    "start": 1,
    "end": 10,
    "location": [{ "region": "Europe", "country": "Germany", "state": "Baden-Wurttemberg" }]
  }'

The response has a location field with the location that SteamSets matched, including the country code:

"location": [
  { "region": "Europe", "countryName": "Germany", "countryCode": "DE", "stateName": "Baden-Wurttemberg", "cityName": null }
]

Names are not case-sensitive, so germany and Germany give the same result. Use the English names from the files above. Country codes such as DE do not work as a filter value.

Read the location of an account

Endpoints that return accounts, for example account.getInfo and the leaderboard endpoints, include the region, country, and state of each account. Each field is an object, or null when the Steam profile has no location:

{
  "region": { "name": "Europe" },
  "country": { "name": "Germany", "code": "DE" },
  "state": { "name": "Baden-Wurttemberg" }
}

The name values are the same names as in the files above, so you can send them back as a leaderboard filter.

Countries