What this page answers
Use this page when you need to decide which DerivaDEX API family owns your integration path before you start reading endpoint or channel detail.API family map
| Family | Protocol | Visibility | Use when |
|---|---|---|---|
| REST | OpenAPI / REST | Public | You need public request-response integrations. |
| Realtime | AsyncAPI / WebSocket | Public | You need streaming market or account updates. |
| Operator & Restricted | OpenAPI / REST | Restricted | You need operator-oriented or compliance-oriented surfaces. |
| Copy Trading | REST and realtime | Product-specific | You need copy-trading-specific surface boundaries. |
| Legacy | Historical | Historical | You need lineage from the older API-doc surface. |
Authoritative artifacts by family
| Family | Authoritative artifact posture |
|---|---|
| REST | Public Swagger artifacts and the derived Mintlify bundle documented on REST Source Artifacts |
| Realtime | Public AsyncAPI artifacts and the docs-local mirror documented on Realtime Source Artifacts |
| Restricted and product-specific families | Use the family boundary page to confirm visibility and source ownership; this top-level map does not make every repo-carried artifact a public contract surface |
Choose the correct family first
| If you need to… | Start here | Why |
|---|---|---|
| query public market data, status, products, or public trading-facing HTTP responses | REST | This is the canonical public request-response family |
| consume ordered market or account-style streaming updates | Realtime | This is the canonical public WebSocket family |
| understand whether an operator or compliance-oriented surface is intentionally public | Operator & Restricted | This page tells you the visibility boundary before you assume a public contract |
| understand whether copy-trading has a public contract equivalent to the core exchange API | Copy Trading | This page keeps product-specific contracts from being mistaken for core exchange surfaces |
| trace old docs links into the new structure | Legacy | This preserves historical continuity without making old docs authoritative |
Entry points
| Need | Route |
|---|---|
| Public request-response integration | REST Quickstart |
| Public WebSocket integration | Realtime Quickstart |
| End-to-end automated trading flow | Building Your First Trading Bot |
Common wrong turns this page prevents
| Wrong assumption | Correct route |
|---|---|
| any HTTP surface in the repo belongs to the public REST family | Operator & Restricted if the surface is operator- or compliance-oriented |
| copy-trading is just another section of the core exchange public API | Copy Trading boundary summary |
| old API-doc links remain authoritative | Legacy for lineage only, then the current canonical family |
| generated pages are enough for all integration questions | family support pages for auth, limits, errors, source ownership, and quickstarts |
Public contract rules
| Rule | Public contract |
|---|---|
| Public generated references | Published only for the active public REST and realtime families |
| Restricted and product-specific families | Exposed as boundary summaries unless and until a deeper public contract is intentionally published |
| Source-of-truth posture | Generated docs render from authoritative source artifacts plus authored support pages; family indexes are not the only contract surface |
| Current-state interpretation | Treat these docs as the public contract for the currently published repo-backed artifacts, not as a promise that every adjacent or future API surface is already public |
/api-specs/operator-client-request.json, /api-specs/operator-kyc.yaml, /api-specs/copy-trading-rest.yml, and /api-specs/copy-trading-realtime.yml are continuity routes back to the relevant boundary summaries rather than public generated-contract publication.
If you need an operator, compliance, or copy-trading surface, use the linked boundary page to confirm visibility and source ownership first rather than assuming a public generated contract exists.