# Minecraft Server Status Checker (`b2b_lead_generation/minecraft-server-status-checker`) Actor

Check Minecraft Java and Bedrock servers by host and get live online status, player counts, version, hostname, and IP. Add a list of addresses, pick an edition or mode, and export results as JSON, CSV, or Excel. Handles retries, duplicates, and error rows so your server list stays accurate.

- **URL**: https://apify.com/b2b_lead_generation/minecraft-server-status-checker.md
- **Developed by:** [B2B Lead Generation](https://apify.com/b2b_lead_generation) (community)
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $2.99 / 1,000 results

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.
Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## Minecraft Server Status Checker: server status and players by host

<p align="center">
  <img src="https://imgur.com/cDB4Bc8.png" alt="Minecraft Server Status Checker" style="max-width:100%; border-radius:14px; width:680px;" />
</p>

Minecraft Server Status Checker looks up public Java and Bedrock servers by host and saves online state, player counts, version, and hostname. Run it with no setup and no account, and export the dataset as JSON, CSV, or Excel from Apify.

Duplicate host-and-mode pairs are skipped, and a host that fails becomes an error row so the run still finishes.

### Use cases

- **Server lists**: refresh online state and player counts for a set of Minecraft hosts
- **Community directories**: keep a Java or Bedrock server page from showing dead addresses
- **Uptime notes**: schedule a small host list and compare `online` across runs
- **Launcher QA**: confirm a hostname and port still resolve before a release
- **Research exports**: download status rows as CSV without writing your own client

### Input

| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `servers` | array | hypixel.net | Host or host:port values, one per line. |
| `edition` | string | java | Java or Bedrock when `mode` is left blank. |
| `mode` | string | Use edition | java, bedrock, or simple. simple is a quick online check. When set, mode overrides edition. |
| `maxItems` | integer | 100 | Maximum rows saved in one run, from 1 to 1000. |
| `requestDelaySecs` | number | 1.0 | Pause between checks, in seconds. Values under 1 are raised to 1. |
| `timeoutSecs` | integer | 300 | Stop the run after this many seconds and keep rows already saved. |
| `requestTimeoutSecs` | integer | 30 | How long to wait for one check before timing out, in seconds. |
| `proxyConfiguration` | object | No proxy | Optional proxy. Default is `{ "useApifyProxy": false }`. |

#### Example input

```json
{
  "servers": ["hypixel.net", "play.cubecraft.net"],
  "edition": "java",
  "mode": "",
  "maxItems": 100,
  "requestDelaySecs": 1.0,
  "timeoutSecs": 300,
  "requestTimeoutSecs": 30,
  "proxyConfiguration": { "useApifyProxy": false }
}
```

Bedrock example: set `mode` to `bedrock` and include a Bedrock host such as `play.cubecraft.net`. For a quick online check, set `mode` to `simple`.

### What data does this actor extract?

Each successful row is one server. Offline is a valid result, shown as `online: false`.

```json
{
  "ip": "172.65.197.160",
  "port": 25565,
  "debug": { "srv": true },
  "hostname": "mc.hypixel.net",
  "online": false,
  "players": null,
  "motd": null,
  "version": null,
  "protocol": null,
  "mode": "java",
  "scraped_at": "2026-10-12T00:00:00+00:00"
}
```

When a server is online, `players` can include `online` and `max`, and `version` plus `protocol` are filled when available.

| Field | Type | Description |
|-------|------|-------------|
| `ip` | string | Resolved IP address of the server. |
| `port` | integer | Game port of the server. |
| `debug` | object | Extra technical details about the server when available. |
| `hostname` | string | Server hostname. |
| `online` | boolean | Whether the server is online. |
| `players` | object | Player counts when the server publishes them. |
| `motd` | object | Message of the day when present. |
| `version` | string | Version string when present. |
| `protocol` | integer | Protocol number when present. |
| `mode` | string | java, bedrock, or simple. |
| `scraped_at` | string | UTC time the row was saved. |
| `error` | string | Present on failed checks. |
| `input` | string | Original host for an error row. |
| `status` | integer | Status code for an error row, or 0 if there was no response. |

Error rows look like `{ "error": "HTTP 404", "input": "missing.server", "status": 404 }` plus `mode` and `scraped_at`.

### Limits and terms

Status values come from publicly available data and can be cached for about a minute, so back-to-back runs may repeat the same result. Please keep usage within fair use. One run saves up to 1000 rows, and you can adjust the pace or set a time limit from the input.

### FAQ

**Do I need any account or setup to run this?**
No. There is no account or setup, so you can run the actor right away.

**How fresh is the server status?**
Results can be cached for about a minute, so back-to-back runs can repeat the same online state.

**What happens if a host is unknown?**
The run stores an error row with the HTTP status and continues with the next host.

**How many servers can one run check?**
`maxItems` allows 1 to 1000 rows. The default is 100.

#### Trademark Notice

Minecraft Server Status and related names, logos, and trademarks belong to their respective owners. Their use in this documentation is solely to identify the source of the data and does not imply affiliation, sponsorship, endorsement, or partnership.

#### Disclaimer

Disclaimer: This Actor is an independent tool and is not affiliated with, endorsed by, sponsored by, or otherwise officially associated with Minecraft Server Status or its owners. All data is collected from publicly available sources. Users are responsible for complying with the source's terms of use, rate limits, and attribution or licensing requirements.

#### Is web scraping legal?

This Actor only collects publicly available data from Minecraft Server Status, without logging in or bypassing any access controls. Scraping public data is generally legal, but how you use it matters:

- **Personal data:** If the results include personal data (for example names, emails, or profile details), laws such as the GDPR in the EU and the CCPA in California may apply. Only collect and store personal data when you have a legitimate reason.
- **Copyright:** Some content (articles, images, descriptions) may be protected by copyright. Do not republish full copyrighted content without permission.
- **Terms of use:** Respect the source's terms, stated rate limits, and any attribution or non-commercial-use requirements listed in the Limits and terms section.
- **Legal advice:** This is general information, not legal advice. If you're unsure, consult a lawyer.

To learn more, read Apify's guide: [Is web scraping legal?](https://blog.apify.com/is-web-scraping-legal/)

# Actor input Schema

## `servers` (type: `array`):

Minecraft server addresses to check, one host or host:port per line. Example: hypixel.net or play.cubecraft.net:19132.

## `edition` (type: `string`):

Java or Bedrock when mode is left blank. java uses the Java status endpoint. bedrock uses the Bedrock status endpoint.

## `mode` (type: `string`):

Optional check mode. java is Java server status, bedrock is Bedrock server status, and simple is an online check through the Java status endpoint. When set, mode overrides edition.

## `maxItems` (type: `integer`):

Maximum number of dataset rows to save in one run, including error rows. Free cap is 1000.

## `requestDelaySecs` (type: `number`):

Seconds to wait between status requests. Minimum is 1.0 so checks stay within fair use of the public status API.

## `timeoutSecs` (type: `integer`):

Maximum seconds the whole run may spend checking servers before it stops and saves rows already collected.

## `requestTimeoutSecs` (type: `integer`):

Maximum seconds to wait for one status HTTP response before retrying or recording an error row.

## `proxyConfiguration` (type: `object`):

Optional proxy for status requests. Leave Apify Proxy off unless the status API blocks your IP. Datacenter proxies are fastest. Residential proxies are harder to detect.

## Actor input object example

```json
{
  "servers": [
    "hypixel.net"
  ],
  "edition": "java",
  "mode": "",
  "maxItems": 100,
  "requestDelaySecs": 1,
  "timeoutSecs": 300,
  "requestTimeoutSecs": 30,
  "proxyConfiguration": {
    "useApifyProxy": false
  }
}
```

# Actor output Schema

## `datasetUrl` (type: `string`):

Open the default dataset for this run.

## `datasetItemsUrl` (type: `string`):

JSON items from the default dataset.

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "servers": [
        "hypixel.net"
    ],
    "proxyConfiguration": {
        "useApifyProxy": false
    }
};

// Run the Actor and wait for it to finish
const run = await client.actor("b2b_lead_generation/minecraft-server-status-checker").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "servers": ["hypixel.net"],
    "proxyConfiguration": { "useApifyProxy": False },
}

# Run the Actor and wait for it to finish
run = client.actor("b2b_lead_generation/minecraft-server-status-checker").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "servers": [
    "hypixel.net"
  ],
  "proxyConfiguration": {
    "useApifyProxy": false
  }
}' |
apify call b2b_lead_generation/minecraft-server-status-checker --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,b2b_lead_generation/minecraft-server-status-checker"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/AhuXRh1NAVQMcyq6z/builds/v7JF3pg5cbLZAIPyS/openapi.json
