ServerPulse API & Documentation

Real-time monitoring for Minecraft, CS2 & Rust — programmable access to 120,000+ servers.

Try Ctrl+K to open the search overlay.

API v3 The v3 endpoint is now stable. Migration guide →. v2 will sunset on 2025-09-01.

API Stats

2.4M

Requests / 24h

99.97%

Uptime (last 30 days)

14ms

Avg. response time

3,210

Active API keys

Documentation Categories

Everything you need to integrate ServerPulse into your dashboard, bot, or analytics pipeline. Start with Authentication, then explore endpoints by resource.

Core

API Reference

Complete endpoint listing for /v3/servers, /v3/query, /v3/history, and /v3/stats. Includes request/response schemas, error codes, and pagination.

REST JSON 42 endpoints

Required

Authentication

Bearer token auth via Authorization header. Generate keys in your dashboard under Settings → API Keys. Supports scoped keys per game type (Minecraft, CS2, Rust).

Bearer Token Scoped Keys

Real-time

Webhooks

Receive instant POST notifications when monitored servers go offline, change player count, or swap versions. Configurable retry policy (exponential backfill, max 5 retries). Payloads include full server snapshot.

POST Retry Logic HMAC-SHA256

Guides

Tutorials

Step-by-step walkthroughs: building a Discord status bot, embedding a live server widget on your website, or piping metrics into Grafana via our Prometheus endpoint.

Discord Bot Widget Embed Grafana

Limits

Rate Limits & Quotas

Free tier: 1,000 req/min, 50 monitored servers. Pro tier: 10,000 req/min, unlimited servers. Burst allowance of 200 req/s. Headers X-RateLimit-Remaining included in every response.

1K req/min (Free) 10K req/min (Pro)

Libraries

SDKs & Community Tools

Official SDKs for Python (pip install serverpulse), Node.js (npm i @serverpulse/sdk), and Go. Community packages: Rust crate, PHP wrapper, PowerShell module.

Python Node.js Go Rust

Quick Start Example

Query a Minecraft server's status with a single request. Replace YOUR_API_KEY with your token.

GET https://api.serverpulse.io/v3/query?address=play.hypixel.net&game=minecraft

Headers:
Authorization: Bearer YOUR_API_KEY
Accept: application/json

Response (200 OK):
{
  "server": {
    "address": "play.hypixel.net",
    "port": 25565,
    "game": "minecraft",
    "version": "1.20.4",
    "online": true,
    "players": {
      "current": 84721,
      "max": 200000
    },
    "motd": "§aHypixel Network §c[1.8-1.20]",
    "latency_ms": 12,
    "queried_at": "2025-01-15T09:42:18Z"
  }
}

Recent Updates

Latest changes to the API, SDKs, and documentation. We ship updates every Tuesday.

2025-01-14 Stable

CS2 Query Support in /v3/query

You can now query CS2 servers via game=cs2. Returns map name, player list, tick rate, and workshop map details. Tested against 4,200+ public servers.

2025-01-07 Stable

Webhook HMAC Signature Verification

All webhook payloads now include an X-ServerPulse-Signature header (HMAC-SHA256). Verify payload integrity server-side. Python and Node examples added to the webhook docs.

2024-12-31 Deprecated

/v2/servers Endpoint Sunset Notice

The v2 query endpoint will be deprecated on 2025-09-01. Migrate to /v3/query — it's a drop-in replacement with additional fields for Rust and Valheim. Migration guide updated with code samples in 6 languages.

2024-12-17 Stable

Go SDK v1.3.0 — Context Support

The official Go SDK now accepts context.Context on all client methods. Enables cancellation and timeout control. Also added a BatchQuery helper for parallel server lookups.

2024-12-10 Stable

New /v3/history Endpoint

Retrieve up to 90 days of historical data for any monitored server — player counts, uptime, version changes. Filter by date range and resolution (1h, 6h, 1d). Ideal for charting and anomaly detection.

2024-12-03 Stable

Python SDK v2.1 — Async Client

serverpulse.AsyncClient now available. Full async support with aiohttp under the hood. 3.2× faster for batch queries compared to the synchronous client.

Need Help?

Can't find what you're looking for? Our developer support team typically responds within 4 hours on weekdays.