Checking status

Your server's data, anywhere you build.

What cormac already knows about the servers you own, as plain JSON: statistics, leaderboards, tickets and members. Keys with write scopes can change a member's XP and automod standing too.

Build your first integration Get an API key

Base URL https://api.cormac.gg/v1

Request

$ curl https://api.cormac.gg/v1/guilds \
    -H "Authorization: Bearer cormac_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.Read Your first integrationFrom nothing to a live leaderboard on your own website, step by step.Read Errors & 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.cormac.gg/v1. Breaking changes mean a new version prefix, never a change to this one. The writes are narrow: a member's XP (their reward roles follow), their automod strikes, and which automod rules exempt them by name. Each needs a scope of its own and shows up in your server's Recent changes. The API can't post messages, moderate anyone, or change anything else.

Access follows ownership. A key reaches the servers its creator owns where cormac+ 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.