ERMDocs

API Overview

Access ERM data programmatically via the REST API.

The ERM REST API allows you to read data from your server programmatically — integrations, dashboards, bots, or any tool that speaks HTTP.

Base URL

https://api.ermdev.xyz

All endpoints are prefixed with this base URL.

Authentication

All API requests require a UniqueToken header with your server's API key. See Authentication for full details.

Rate Limits

The API is rate-limited per API key:

TierRequestsWindow
Default60 requests60 seconds
Premium300 requests60 seconds

When you exceed the rate limit, the API returns a 429 Too Many Requests response with a Retry-After header indicating how many seconds to wait.

Response Format

All responses are JSON. Successful responses follow this shape:

{
  "success": true,
  "data": { ... }
}

Error responses:

{
  "success": false,
  "error": "Human-readable error message"
}

HTTP Status Codes

CodeMeaning
200Success
400Bad request — check your parameters
401Unauthorised — missing or invalid API key
403Forbidden — your key doesn't have access to this resource
404Not found
429Rate limited
500Internal server error

Getting Started

  1. Generate an API key from Dashboard → Integrations → API Keys
  2. Read the Authentication docs
  3. Browse Endpoints to find what you need

On this page