The SWGoH API

Every endpoint below is generated from the service's own OpenAPI description, so this reference cannot drift from what the API actually serves. The snapshot it is built from is published alongside these pages at /openapi.json.

Base URL

http://localhost:8190

How this reference is organised

Endpoints are grouped by their OpenAPI tag. Endpoints holds the product surface; Platform and admin holds the operational machinery — health checks, audit trails, background workers — which is documented for completeness rather than for everyday use.

What is not listed

Tags that describe how an operation is implemented rather than what it is about are skipped, because a page for one would duplicate every other page. This exclusion is declared in .vitepress/openapi.mjs; nothing is hidden silently.

Refreshing the snapshot

npm run fetch:openapi   # writes docs/public/openapi.json

Run it deliberately, review the diff, and commit it. Builds never fetch the spec themselves — that keeps them reproducible and offline-capable, and turns an endpoint disappearing into a reviewable change rather than a surprise.