Skip to content
get a key

A community and its servers

GET/v1/communities/{slug}

A community with its description, links and servers.

Path parameters

Section titled “Path parameters”
slugstring · required
Its slug, often its website: cybershoke.net

Response

Section titled “Response”

200 The community. The answer is { "data": … }; data is CommunityDetail.

CommunityDetail

Section titled “CommunityDetail”
slugstring
namestring
domainstring | null
claimedboolean
platformboolean
A matchmaking platform (a server per match), not ranked
rankinteger | null
players_nowinteger
average_players_7dnumber | null
serversinteger
servers_onlineinteger
flagged_serversinteger
Fake servers using its name, not counted
gamesGameRef[]
countriesstring[]
linksobject
descriptionstring | null
discord_invitestring | null
website_urlstring | null
member_serversServer[]

Community

Section titled “Community”
slugstring
namestring
domainstring | null
claimedboolean
platformboolean
A matchmaking platform (a server per match), not ranked
rankinteger | null
players_nowinteger
average_players_7dnumber | null
serversinteger
servers_onlineinteger
flagged_serversinteger
Fake servers using its name, not counted
gamesGameRef[]
countriesstring[]
linksobject

GameRef

Section titled “GameRef”
app_idinteger
slugstring
namestring

Server

Section titled “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

Errors

Section titled “Errors”

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

Status When
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