Find servers

GET/v1/servers

Servers online now, busiest first, or nearest first with near. Only listed servers, whose player counts were checked against their player lists, unless status=flagged.

Query parameters

qstring

Words in the server's name or map

mapstring

Part of the map name

min_playersinteger

At least this many real players

has_playersboolean

Only servers with real players

not_fullboolean

Only servers with a free slot

passwordboolean

false for servers without a password

vacboolean

Only VAC-secured servers

plugin[]string[]

Plugins it runs: SourceMod, AMX Mod X, War3FT…

statusstring

listed (the default) or flagged, the fakes with their reasons

sortstring

players (the default), name, or nearby with near

gamestring

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

tag[]string[]

What it offers, read from its name; all must match

free_vipvippublicclassicdeathmatchrespawn+12

langstring

The language its name says it's in ([RU], [PL]…)

bgcsdeenesfr+8

nearstring

The player's location, latitude,longitude, for nearest first

pageinteger

The page, from 1 Default 1.

per_pageinteger

How many on a page Default 25.

Response

200 A page of servers. The answer is { "data": … }, with meta and links for the pages; data is Server[].

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

GameRef

app_idinteger

slugstring

namestring

Errors

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
429	Over a rate limit (60 a minute, 10000 a day per key); see Retry-After