Guides Overview

Use guides when you need implementation behavior, calculations, examples, or troubleshooting rather than endpoint-level schema details.

How to use guides

ACK/result/event flow, idempotency, reconnect behavior, snapshots, pagination, and rate limits.

Equity, PnL, margin, free margin, margin level, HMR, and conversion rules.

Effective REST limits, WebSocket limits, throttling values, and request constants.

Signed cURL, request-shape examples, Python pseudo-code, and WebSocket JSON.

HTTP status guide, Public API error codes, retry guidance, and signed request checklist.

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