Skip to content
get a key

The server to join now

GET/v1/quickplay

The one server to join now, as the site’s Play now buttons pick it: a free slot and no password, real players before empty servers, nearest first with near, then the busiest. Join with its connect_url.

gamestring · required
A game's slug from /v1/games, or its Steam app id
modestring
The game mode, read from the map name (or the plugin, for Warcraft 3)
bomb-defusalhostage-rescuearenasurfclimbzombies+18
countrystring
The server's country, ISO 3166-1 alpha-2
nearstring
The player's location, latitude,longitude, for nearest first

200 The server. The answer is { "data": … }; data is Server.

addressstring
ip:port
namestring | null
gameGameRef
mapstring | null
modestring | null
Its game mode
bomb-defusalhostage-rescuearenasurfclimbzombies+18
playersinteger
Real players now; bots are counted apart
botsinteger
max_playersinteger
onlineboolean
statusstring
listed: checked and real. flagged: its numbers look fake, see flagged_reasons
listedpendingflagged
countrystring | null
tagsstring[]
What it offers, read from its name
free_vipvippublicclassicdeathmatchrespawn+12
languagestring | null
The language its name says it's in
passwordboolean
vacboolean
connect_urlstring
steam://connect/ip:port, to join
last_checked_atstring | null
linksobject
app_idinteger
slugstring
namestring

Errors are problem details with a detail written to be shown to people.

Status When
400 A parameter isn’t valid
401 No API key, or one that isn’t valid or was revoked
404 Nothing there
429 Over a rate limit (60 a minute, 10000 a day per key); see Retry-After