Path parameters
slugrequiredstringResponse
200 OK, JSON. Full schema in openapi.json.
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 | nulljavaobject | null2 fieldshide
addressstringversionstring | nullbedrockobject | null2 fieldshide
addressstringversionstring | nulldescriptionstring | nulllanguagestring | nullTwo-letter code of its community's main language.linksobject3 fieldshide
websitestring | nulldiscordstring | nullstorestring | nullclaimedbooleanA verified owner manages the listing.countVerifiedbooleanThe player count was matched against the tab list.peakobject | null2 fieldshide
playersintegeratstring | nulllistedAtstringISO 8601 time, UTC.checkedAtstring | nullErrors
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.