API surfaces
REST API
Place and cancel orders, search your order history, and read wallets,
balances, deposits, products, assets and the order book.
Streaming API
Real-time order book, order and deposit updates over a single authenticated
WebSocket. See WebSockets.
What the API supports
- Orders — place and cancel limit orders, list and search your own orders.
- Market data — products, assets, OHLCV candles and the live order book.
- Wallets & deposits — read balances, generate deposit addresses and read deposit history.
- Realtime — subscribe to order book, order and deposit channels.
- HMAC authentication — every request is signed; nothing relies on a long-lived bearer token.
Base URL
Your base URL is provided together with your API key and secret during onboarding. All REST endpoints live under that single prefix, and the WebSocket endpoint shares the same host. TLS is terminated at the edge — usehttps:// (and wss:// for sockets) in any
deployed environment. Liveness checks live at the gateway root, /api/v1/health,
outside the trading base path.
How a request works
- You receive an API key id and a secret during onboarding.
- For each request you build a canonical string (timestamp, nonce, method, path, content-type, body hash) and sign it with your secret using HMAC-SHA256.
- You send the signature plus the
X-API-*headers. The gateway re-computes the signature, checks the timestamp and nonce, verifies your key’s permissions, and forwards the call.
Conventions
- Requests and responses are JSON.
- Decimal amounts (quantities, prices, balances) are sent as strings to avoid floating-point precision loss.
- Timestamps are ISO-8601 strings unless noted otherwise.
- Errors use standard HTTP status codes.
