Skip to main content
The Nomos API is a REST API over HTTPS that returns JSON. This section is the source of truth for every endpoint, request shape, and response we ship.

How to use this section

  • API Reference — the auto-generated reference for every endpoint, grouped by resource. Each page lists path and query parameters, request bodies, response schemas, and copy-pasteable examples.
  • Versioning — how API versions are pinned per Auth Client and overridden per request via the X-API-Version header.
  • Pagination — cursor-based pagination on all list endpoints.
  • Filtering — bracket-notation query filters supported on list endpoints.
  • Errors — the standard error envelope and a reference for every error code we return.
  • Changelog — what changed between versions.

Conventions

  • All requests must be made over HTTPS. Authenticate with a Bearer token. See Authentication to obtain one.
  • Timestamps are ISO 8601 with timezone (2025-01-01T00:00:00Z).
  • IDs are opaque strings — don’t parse them.
  • Monetary values are returned as scaled integers; the schema documents the scale per field.

Need help?

If something is unclear or broken, email support@nomos.energy and include the requestId from the error response.