Guides Overview
Use guides when you need implementation behavior, calculations, examples, or troubleshooting rather than endpoint-level schema details.
How to use guides
Runtime
Runtime Semantics
ACK/result/event flow, idempotency, reconnect behavior, snapshots, pagination, and rate limits.
RiskFormulas & Calculations
Equity, PnL, margin, free margin, margin level, HMR, and conversion rules.
ExamplesCode Examples
Signed cURL, request-shape examples, Python pseudo-code, and WebSocket JSON.
RecoveryTroubleshooting
HTTP status guide, Public API error codes, retry guidance, and signed request checklist.
Guide vs API Reference
| Use | Go to |
|---|---|
| Need exact path, parameters, schemas, or enum values | Generated API Reference tab |
| Need an implementation sequence | Recommended Integration Flow and Send Your First Request |
| Need to debug a failure | Troubleshooting |
| Need formulas or runtime behavior | Runtime Semantics and Formulas & Calculations |