minecraft.server_bedrock

stable Standard

Status of a Minecraft Bedrock server (online, players, version).

GET /v1/minecraft/server_bedrock

What you get#

One Minecraft record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.

What it costs#

Standard · 1 credit for a fresh fetch, charged only when it succeeds.
Free when served from cache (0.2 credit for a cached response over 100 KB).
Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

Name	Type	Required	Default	What it is	Constraints
`host`	string	yes	(required)	Server hostname, e.g. mc.hypixel.net	max 255 chars; must match `[a-z0-9]([a-z0-9.-]{0,247}[a-z0-9])?(:[0-9]{2,5})?`; trimmed, lowercased

Request#

curl "https://api.onekey.dev/v1/minecraft/server_bedrock?host=mco.lbsg.net" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Minecraft response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json

{
  "success": true,
  "data": {
    "ext": {
      "online": true,
      "host": "mco.lbsg.net",
      "ip": "135.148.33.116",
      "port": 19132,
      "playersOnline": 6891,
      "playersMax": 16891
    },
    "content": {
      "title": "【  🛏️ ⚔ 𝗕𝗘𝗗𝗪𝗔𝗥𝗦 ⚔ 🛏️  】"
    },
    "package": {
      "version": "1.26.50"
    }
  },
  "metadata": {
    "platform": "minecraft",
    "endpoint": "server_bedrock",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source path	Onekey field	Transform
`online`	`ext.online`	`toBoolean`
`host`	`ext.host`	-
`ip_address`	`ext.ip`	-
`port`	`ext.port`	`toNumber`
`motd.clean`	`content.title`	-
`players.online`	`ext.playersOnline`	`toNumber`
`players.max`	`ext.playersMax`	`toNumber`
`version.name`	`package.version`	-

Caching and freshness#

Fresh for about 30 seconds. Repeat calls in that window are served from cache and are free.
Between 30 seconds and 5 minutes the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
If the source is down when a refresh is needed, the last copy can be served for up to 10 minutes more (marked stale).
A "not found" is remembered for 1 minute and is free.
The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

Status	Code	What to do
401	`unauthorized`	Check the `x-api-key` header.
402	`insufficient_credits`	Add credits; your balance must cover the price.
404	`not_found`	That record does not exist. Free; do not retry.
422	`invalid_params`	Fix the parameters using the table above. Free.
429	`rate_limited`	Wait `Retry-After` seconds, then retry.
502	`upstream_error`	The source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).