Query parameters
qstringWords to match in the name, address, description or tags.
editionenumOnly servers with this edition.
javabedrockmodesstringGame mode slugs, comma-separated; a server matches any.
versionstringA Java version the server must accept, e.g. "1.21.4".
softwarestringServer software, comma-separated: modded, forge, neoforge, fabric, plugins, proxy.
languagesstringTwo-letter language codes, comma-separated.
onlineenumLeave out servers that are offline now (default true).
01truefalseDefault "true"claimedenumOnly listings a verified owner manages.
01truefalseDefault "false"crossplayenumOnly servers with both a Java and a Bedrock address.
01truefalseDefault "false"players_mininteger 0–10000000At least this many players online.
players_maxinteger 0–10000000At most this many players online.
sortenumrank, players (now), rising (this week), name, oldest (first seen), busy (usually busy at this hour).
rankplayersrisingnameoldestbusyDefault "rank"limitinteger 1–100Results per page, 1–100.Default 25
pageinteger 1–200Page number, from 1.Default 1
Response
200 OK, JSON. Full schema in openapi.json.
totalintegerpageintegerlimitintegerserversobject[]13 fieldshide
slugstringnamestringurlstringThe listing's Lobbydex page. Link to it where you show the data.iconstring | nulladdressstring | nullThe address players type (primary hostname).editionsenum[]onlinebooleanplayersobject2 fieldshide
onlineintegermaxinteger | nullversionstring | nullrankinteger | nullLobbydex rank position; null when unranked.modesstring[]Game mode slugs it advertises (see /api/v1/minecraft/modes).tagsstring[]Tags its owner picked.motdstring | nullErrors
invalid_request400
A query or path parameter is missing or out of range.
invalid_key401
The key is malformed, revoked or unknown. Leave it out to use the anonymous allowance.
rate_limited429
Over a bucket or the global limit. Wait retry_after seconds.
internal_error500
Something broke on our side. Retry with backoff.