Skip to main content
Private REST operations are account-scoped (addresses and parameters in the path/body per OpenAPI) or state-changing (signed transactions in the request body). Use API management for your API key and configure it in the Rust or Python SDK to sign submits—keys are not passed as REST auth headers. See Authentication and SDKs and examples. In the generated OpenAPI document, these routes are tagged Account, Trading, Vault and bridge, and Faucet (testnet):
TagTypical use
AccountNonces, fees, collateral, positions, open orders, delegations — data tied to your account context.
TradingSubmitting or inspecting trading-related transactions and order activity.
Vault and bridgeVault balances, history, stats, and bridge-related chain events.
Faucet (testnet)Testnet-only utilities such as claims.
Market-wide reads (instruments, candles, public fees, and so on) live under Public REST-API. Trading flows are often asynchronous; confirm outcomes with WebSocket subscriptions and follow-up reads where appropriate. Use Swagger UI for interactive calls. Generated pages on this site use specs/openapi.json in the repo (with examples and markdown tables); the cluster also serves openapi.json for codegen — keep them aligned when you change the API.