Skip to main content
Every request (except GET /api/v1) requires an API key sent as a bearer token in the Authorization header.

Creating and managing keys

Create and manage keys in the OceanX app under Settings → Developer API (also reachable from the account menu → Developer API).
A key is shown once at creation — store it securely. OceanX only keeps a hash and cannot show it again.
  • Up to 10 active keys per account.
  • Keys are prefixed ox_live_ so secret-scanners can detect leaks.
  • Revoke a key any time; revocation takes effect immediately.

Using your key

Store keys in environment variables or a secret manager. Never commit them to source control or expose them in a browser bundle.

Auth errors

See Errors for the full list of error codes.