Exchange REST
Base URL: https://exchange.nexus.xyz/api/exchange
All routes except /health, /openapi.json, and /auth/login require HMAC authentication (see Quickstart → Sign requests). The complete machine-readable schema, including request/response bodies and CCXT method mappings, is at /openapi.json.
Conventions:
All monetary values are decimal strings.
On single-order routes,
market_idis required as a query parameter — the engine routes directly to the owning market.Authenticated requests carry
X-API-Key,X-Timestamp,X-Signature. The timestamp must be within ±30s of server time.
Authentication & keys
POST
/auth/login
—
EIP-191 wallet signature → 24h session Bearer token
POST
/keys
Session
Create an HMAC API key (key_id + secret; secret shown once)
GET
/keys
Session
List your API keys
DELETE
/keys/{id}
Session
Revoke an API key
POST
/ws-tokens
HMAC
Mint a 60s single-use token for a WebSocket subscription
Account
GET
/account
HMAC
Balance, equity, margin used, margin ratio
GET
/positions
HMAC
Open positions with unrealized PnL
POST
/account/credit
HMAC
Faucet synthetic USDX (testnet; up to 500/day per key)
GET
/account/{address}/adl-history?limit=
HMAC
Auto-deleveraging events where the account was target or counterparty
Orders
POST
/orders
HMAC
Place a limit or market order
POST
/orders/batch
HMAC
Place multiple orders (sequential; results preserve request order)
GET
/orders
HMAC
List open orders
GET
/orders/{id}?market_id=
HMAC
Get a single order
PATCH
/orders/{id}?market_id=
HMAC
Amend an order
DELETE
/orders/{id}?market_id=
HMAC
Cancel a single order
DELETE
/orders?market_id=
HMAC
Cancel all open orders in a market
Order body fields: market_id, side (Buy/Sell), order_type (Limit/Market), quantity, price (limit only), time_in_force (GTC/IOC/FOK), and optional reduce_only.
Market data
GET
/markets
List all live markets and their status
GET
/markets/summary
Mark price, 24h volume, trade count, status per market
GET
/markets/{id}/ticker
Last / bid / ask / volume / change
GET
/markets/{id}/orderbook
L2 order book depth
GET
/markets/{id}/trades
Recent trades
GET
/markets/{id}/candles
OHLCV candles (1m / 5m / 1h)
GET
/markets/{id}/funding
Funding rate history
GET
/markets/{id}/mark-price
Current mark price
GET
/markets/{id}/status
Active/halted, reason, timestamp, ADL count
GET
/markets/{id}/adl-events?limit=
Per-market auto-deleveraging history
GET
/tickers
All tickers in one call
GET
/stats, /stats/history
Exchange-wide stats
Streaming
Real-time order book, trade, and account updates are delivered over WebSocket, not REST. See the WebSocket API Reference.
Status: testnet preview. Endpoint set tracks the versioned OpenAPI spec at
nexus-xyz/nexus-exchange-api; consult/openapi.jsonfor the authoritative, current schema.
Last updated

