Server List Filters

From King Arthur's Gold Wiki
Jump to: navigation, search


Implementation Status: Under Development
(WIP)

full (bool)
empty (bool)
IPAddress (string)
IPv4Address (string)
IPv6Address (string)
port (int)
gameMode (string)
currentPlayers (int)
maxPlayers (int)
mostCurrentPlayers (int)
leastCurrentPlayers (int)
mostMaxPlayers (int)
leastMaxPlayers (int)
build (int)
current (bool)
lastUpdated (ISO date)
firstSeen (ISO date)
connectable (bool)
password (bool)
preferAF (bool)
gold (bool)
nameContains (string, partial match)
name (string)
description (string - this is a bit silly, this probably won't be implemented)
descriptionContains (string, partial match)

All booleans are represented as 0/1
All data types can be negated with ! preceeding the value - e.g. /servers/currentPlayers/!0 (same as /servers/empty/0)


The filters are concatenated together in the request URI to form an AND filter. There is no mechanism for an OR filter, you need to make multiple queries and join the resulting sets yourself.

https://api.kag2d.com/servers/full/0/empty/0