# Minecraft Server Status API

> Live status of any Minecraft Java or Bedrock server: online, players, version, MOTD, icon

- Vendor: `minecraftserverstatusapi` · version 1.0 · category Gaming · tags minecraft server status api, minecraft api, server ping api, game server api, minecraft players api, mcsrvstat api
- Datasource: custom HTTP routes
- Marketplace page: https://apiclay.com/api/minecraftserverstatusapi
- This document: https://apiclay.com/docs/minecraftserverstatusapi.md
- OpenAPI 3.1: https://apiclay.com/api/minecraftserverstatusapi/openapi.json
- MCP: connect https://api.apiclay.com/v1/mcp (see https://apiclay.com/llms.txt), then `apiclay_describe_api` with vendor `minecraftserverstatusapi`
- Updated: 2026-11-18

## About

## Minecraft Server Status API

Ping any Minecraft server by address and get whether it is online, the current and maximum player counts (and sample names), version and protocol, MOTD text and HTML, software, plugins and mods where exposed, and its icon. Java and Bedrock editions.

Data comes from **mcsrvstat.us** (https://mcsrvstat.us). Every route calls the source's own public API and returns it unchanged.

Typical flow: `/java?address=hypixel.net`, `/bedrock?address=play.example.net`.

### Routes

#### GET `/java` - Java server
| Param | In | Type | Required | Description |
|---|---|---|---|---|
| address | path | string | yes | Host or `host:port`, e.g. `hypixel.net`. |

Returns: `online`, `ip`, `port`, `players` (`online`, `max`, `list`), `version`, `protocol`, `motd`, `icon`, `software`.

#### GET `/bedrock` - Bedrock server
| Param | In | Type | Required | Description |
|---|---|---|---|---|
| address | path | string | yes | Host or `host:port`. |

Returns: same shape.

### Caveats

- Results are cached for a few minutes.
- Upstream responses can change over time. Verify fields before relying on them.
- Not affiliated with or endorsed by mcsrvstat.us.

## Pricing

- Pay as you go: 0.0012 credits/request
- Trial: 1 free requests per buyer
- Billing order: trial requests -> subscribed plan requests -> pay as you go. 1 credit's USD value is shown on the marketplace page.

## HTTP routes

Only the public, buyer-facing parts of each route are listed; vendor-side credentials stay on the gateway.

### GET /java — Java server
- Gateway: `GET https://api.apiclay.com/v1/api/minecraftserverstatusapi/java`
- Public query params: `address` (string, required)
- Upstream proxy: ApiClay proxy paid by the vendor (data cap 2 MB per call). Fetched through an ApiClay proxy paid by the vendor; a response larger than the route's data cap fails with 502 and is refunded in full.

### GET /bedrock — Bedrock server
- Gateway: `GET https://api.apiclay.com/v1/api/minecraftserverstatusapi/bedrock`
- Public query params: `address` (string, required)
- Upstream proxy: ApiClay proxy paid by the vendor (data cap 2 MB per call). Fetched through an ApiClay proxy paid by the vendor; a response larger than the route's data cap fails with 502 and is refunded in full.

## Call example

```bash
curl -X GET "https://api.apiclay.com/v1/api/minecraftserverstatusapi/java?address=<address>" \
  -H "token: <YOUR_APICLAY_TOKEN>"
```

Index of every published API: https://apiclay.com/llms.txt
