Skip to content

DevelopersMinecraft

Get a Minecraft server

One listing: live status, addresses per edition, versions, links, peak and rank.

GET/api/v1/minecraft/servers/{slug}
Bucket item180/min with a key · 20 withoutCached 30 sKey optional

Path parameters

slugrequiredstring

Response

200 OK, JSON. Full schema in openapi.json.

slugstring
namestring
urlstringThe listing's Lobbydex page. Link to it where you show the data.
iconstring | null
addressstring | nullThe address players type (primary hostname).
editionsenum[]
onlineboolean
playersobject2 fields
onlineinteger
maxinteger | null
versionstring | null
rankinteger | nullLobbydex rank position; null when unranked.
modesstring[]Game mode slugs it advertises (see /api/v1/minecraft/modes).
tagsstring[]Tags its owner picked.
motdstring | null
javaobject | null2 fields
addressstring
versionstring | null
bedrockobject | null2 fields
addressstring
versionstring | null
descriptionstring | null
languagestring | nullTwo-letter code of its community's main language.
linksobject3 fields
websitestring | null
discordstring | null
storestring | null
claimedbooleanA verified owner manages the listing.
countVerifiedbooleanThe player count was matched against the tab list.
peakobject | null2 fields
playersinteger
atstring | null
listedAtstringISO 8601 time, UTC.
checkedAtstring | null

Errors

not_found404

No public item with that slug.

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.