Two copy/paste calls to verify your key and see real data. Both are read-only.
1. Set your key
2. Call the authenticated index
GET /api/v1 is the recommended first call — it verifies your key and describes the whole surface:
Expected response (200, abridged):
Without a valid key you get exactly a 401 with this body:
3. Make a read-only request
This lists the leagues in your key’s scope — leagues in your source namespace plus any granted to your key (see Authentication). A brand-new key sees an empty array until you create your first league.
Expected response (200):
The response envelope
Every response uses one of two shapes:
- Success:
{"data": …} — status 200 (reads, updates, deletes) or 201 (creates, including idempotent upserts that updated an existing row).
- Error:
{"error": "<code>"} — a single snake_case code, statuses 400, 401, 404, or 409 only. See Errors & agent safety.
Next steps
Last modified on July 10, 2026
