Family summary
| Property | Value |
|---|---|
| Visibility | Public |
| Protocol | WebSocket / AsyncAPI |
| Endpoint | wss://exchange.derivadex.com/realtime-api |
| Connection authentication | None currently required for the published feed family |
| Canonical route | api-reference/realtime/* |
Use this family when
| If you need to… | Use Realtime because… | Do not start here when… |
|---|---|---|
| consume market or account-style updates as they happen | realtime owns the public WebSocket subscription contract | you need an initial snapshot or request-response read before subscribing |
| understand the public WebSocket connection model | this family owns bootstrap, reconnect, and channel/message guidance | you are actually choosing between product surfaces first; use the top API Reference family map |
| inspect generated channel and message schemas | the public realtime family publishes AsyncAPI-backed generated pages | you are looking for a restricted or product-specific WebSocket family |
What this family owns
| Need | Route |
|---|---|
| first subscription path | Quickstart |
| filtered user-data identity posture | Authentication |
| bootstrap and reconnect semantics | Connection Model |
| published realtime rate posture | Rate Limits |
| recovery and failure lookup | Errors |
| source-of-truth lineage | Source Artifacts |
| generated channel rendering status | Generated Reference Status |
| channel-by-channel schema lookup | Generated Realtime Channels |
Authoritative source artifacts
packages/generated-realtime-api/server/asyncapi.yamlpackages/generated-realtime-api/client/asyncapi.yaml
Support shape
The realtime family is organized around:- Quickstart
- Authentication
- Connection Model
- Rate Limits
- Errors
- Source Artifacts
- Generated Reference Status
Public contract boundaries
| Boundary | Public contract |
|---|---|
| Initial state | Public readers should use REST for initial snapshots or current account state before relying on update streams |
| Generated realtime pages | Published for the active public realtime family only |
| Restricted or product-specific WebSocket surfaces | Operator/compliance and copy-trading contracts remain separate boundary-summary families |
| Authentication posture | The published public realtime family currently documents no connection-level authentication requirement for the feed family itself; use the surrounding authentication and connection-model pages for filtered user-data nuances |