# Mcsrvstat — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Check whether Minecraft servers are online and retrieve live server details including player counts, server icons, MOTD, and version metadata for both Java and Bedrock Edition servers.

**Category:** Developer Tools | **Website:** [mcsrvstat.us/](https://mcsrvstat.us/) | **Docs:** [parse.bot/marketplace/20a8fb49-db90-4724-9ce7-764d608cc862/mcsrvstat-us-api](https://parse.bot/marketplace/20a8fb49-db90-4724-9ce7-764d608cc862/mcsrvstat-us-api)

Pay-per-use API proxy. Each call is automatically billed to your wallet in USDC.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/parse-mcsrvstat-us-api-20a8fb49/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_bedrock_server_status

Retrieve real-time status of a Minecraft Bedrock Edition server. Returns server data including online status, player count, gamemode, server ID, and MOTD. The response always includes the 'online' boolean; when offline, most other fields are absent.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `address` | string | Yes | Server hostname or IP address (e.g., 'play.histeria.fr'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-mcsrvstat-us-api-20a8fb49/get_bedrock_server_status \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"address":"<string>"}'
```

### get_java_server_status

Retrieve real-time status of a Minecraft Java Edition server (1.7+). Returns comprehensive server data including online status, player count, MOTD, version, icon, protocol, and debug/DNS information. The response always includes the 'online' boolean; when offline, most other fields are absent.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `address` | string | Yes | Server hostname or IP address (e.g., 'hypixel.net', 'mc.mineplex.com'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-mcsrvstat-us-api-20a8fb49/get_java_server_status \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"address":"<string>"}'
```

### get_server_icon

Retrieve a Minecraft server's favicon/icon as a base64-encoded data URI string. Works for both Java and Bedrock editions, though Bedrock servers rarely have icons. Returns null for the icon field when the server has no custom icon set.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `address` | string | Yes | Server hostname or IP address. |
| `is_bedrock` | boolean | No | Set to true to query a Bedrock Edition server instead of Java Edition. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-mcsrvstat-us-api-20a8fb49/get_server_icon \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"address":"<string>","is_bedrock":"<boolean>"}'
```

### is_server_online

Quick check if a Minecraft server is online with player counts. Works for both Java and Bedrock editions. Returns only online status and player counts, not full server details.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `address` | string | Yes | Server hostname or IP address. |
| `is_bedrock` | boolean | No | Set to true to query a Bedrock Edition server instead of Java Edition. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-mcsrvstat-us-api-20a8fb49/is_server_online \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"address":"<string>","is_bedrock":"<boolean>"}'
```