NYXAPI
API key
Checking status

Your server's data, anywhere you build.

Read-only access to what nyx already knows about the servers you own: statistics, leaderboards, ticket analytics and more, as plain JSON.

Build your first integrationGet an API key

Base URL https://api.nyx.cool/v1

Request
$ curl https://api.nyx.cool/v1/guilds \
    -H "Authorization: Bearer nyx_live_..."
Response200
{
  "guilds": [
    {
      "id": "1467281625954914369",
      "name": "Zeta Studio",
      "memberCount": 1284,
      "premiumActive": true
    }
  ]
}

Start here

AuthenticationOne key per owner, sent on every request. What it can read, and how to keep it safe.ReadYour first integrationFrom nothing to a live leaderboard on your own website, step by step.ReadErrors & limitsThe one error shape every endpoint shares, and how many requests you get.Read

How it fits together

Every endpoint answers JSON over HTTPS from https://api.nyx.cool/v1. Breaking changes mean a new version prefix, never a change to this one. The API is read-only by design: it can show what nyx knows, and it can never touch your server.

Access follows ownership. A key reaches the servers its creator owns where nyx+ is active, and endpoints backed by a plugin answer only while that plugin is on. The details are in Authentication.

There's a machine-readable description at /openapi.json, written to OpenAPI 3.1 and generated from the same source these pages show, so the two can't disagree. Point a client generator at it instead of writing request code by hand.

Endpoints

What each one needs

Servers

2 endpoints

Statistics

4 endpoints

Progression

2 endpoints

Tickets

2 endpoints

Honeypot

1 endpoint

Diagnostics

1 endpoint