Getting Started - ServerPulse Docs

Real-time multiplayer server discovery

Introduction

Welcome to ServerPulse, the telemetry backbone for competitive multiplayer titles like Nebula Vanguard and Apex Circuit. This guide walks you through initializing your developer workspace, navigating the real-time dashboard, and executing your first latency-optimized API request.

Our platform aggregates over 12,400 active game servers across 14 regional edge nodes, providing sub-50ms heartbeat tracking and dynamic player slot allocation. Whether you are building a custom matchmaking overlay or integrating server status widgets into your studio’s launcher, ServerPulse provides the raw data pipelines and WebSocket streams you need to keep communities connected. All endpoints are authenticated via HMAC-SHA256 signatures and rate-limited to 1,200 requests per minute per API key to ensure grid stability during peak tournament hours.

Quick Links

Documentation

REST API Reference

Complete endpoint schemas for server registration, player sync, and regional failover routing.

View Endpoints

Downloads

Official SDKs

Pre-compiled libraries for Unity 2022.3+, Unreal Engine 5.3, and Go 1.21+ with built-in retry logic.

Download SDKs

Integration

WebSocket Stream Guide

Subscribe to live slot availability, ping spikes, and version mismatch alerts in real time.

Start Streaming

Account Setup

Configure your developer workspace in three steps and authenticate your first server heartbeat within minutes.

Step 1

Create Your Studio Profile

Visit the developer portal and register with your studio’s primary domain. Verify ownership via DNS TXT record or OAuth2 SSO. Upon activation, you will receive a default `sp_live_` API key and a read-only `sp_test_` key for sandbox environments.

Step 2

Navigate the Telemetry Dashboard

Log in to access the real-time overview panel. The left sidebar contains your registered server clusters, while the main viewport displays active connections, average RTT (ms), and packet loss percentages. Use the filter bar to isolate nodes by region (e.g., `US-East`, `EU-Central`, `APAC-Southeast`) or game version.

Step 3

Execute Your First API Call

Initialize a POST request to `https://api.serverpulse.io/v1/heartbeat` with your `sp_test_` key in the `X-SP-Signature` header. Include a JSON payload containing `server_id`, `game_port`, `max_slots`, and `current_version`. A `200 OK` response confirms successful registration and immediate visibility on the public browser.

Run Quickstart Script