Onboarding & API Keys
Create, scope, and manage the keys you will use to authenticate.
API keys are created only through the web UI — programmatic key creation via API is not supported. Issuing a new key requires a wallet-signed session, which is by design.
Step by step
- Visit
https://app.zetariumdex.com, connect your wallet, sign in with SIWE. - Open the API Keys screen and click Create New Key.
- Fill in the form:
- Label — a meaningful name (max 50 chars).
- Permissions — see the table below.
- IP Whitelist — optional but strongly recommended; set your client's static IP.
- Expires At — optional ISO 8601 timestamp for automatic revocation.
- The backend returns a fresh
apiKey+secretKey.
The secretKey is shown only once. Store it in a secure secret manager
before navigating away. There is no recovery flow.
API key format
| Field | Format | Example |
|---|---|---|
apiKey | zd_ + 40 hex chars | zd_84444a6e5d3c2b1a0f9e8d7c6b5a4f3e2d1c0b9a |
secretKey | 64 hex chars (32 bytes hex-encoded) | 073CuVWk... |
Permission tiers
| Permission | Capabilities |
|---|---|
READ_ONLY | Read balances, positions, orders, history. |
TRADE | Everything in READ_ONLY, plus place / cancel orders, close positions, change leverage and margin mode. |
WITHDRAW | Reserved. /v2/withdraw and /v2/transfers/internal cannot be called with an API key today — they are UI-only. |
WITHDRAW does not currently grant API-key withdraw access — the
endpoints reject every API-key call with 403. The permission flag exists
for a future EIP-712 typed-data flow.
Limits
- Maximum 5 active keys per account.
- An empty IP whitelist allows any IP (not recommended).
- Once
expiresAtis reached, every request returns401.