Family summary
| Property | Value |
|---|---|
| Visibility | Public |
| Protocol | REST / OpenAPI |
| Canonical route | api-reference/rest/* |
| Base-path rule | Generated endpoint paths are deployment-relative; the current Mintlify bundle does not publish a canonical OpenAPI servers[] array |
Use this family when
| If you need to… | Use REST because… | Do not start here when… |
|---|---|---|
| fetch public market, product, status, or stats data over HTTP | the public REST family is the request-response contract for those lookups | you need live subscriptions or ordered feed updates |
| bootstrap current account or strategy state before listening for updates | REST owns initial snapshot and request-response reads | you are already in the streaming-update phase; move to Realtime |
| understand the public write-path posture | this family routes you to the public signing, encryption, limit, and error guidance that applies to request submission | you are looking for a fully public operator-only catalog rather than the shared public write-path concepts |
What this family owns
| Need | Route |
|---|---|
| first public REST path | Quickstart |
| signing and write-path posture | Authentication |
| numeric request tiers and retry planning | Rate Limits |
| HTTP and safety-failure recovery | Errors |
| current no-SDK / examples posture | Examples and SDKs |
| source-of-truth lineage | Source Artifacts |
| generated endpoint rendering status | Generated Reference Status |
| endpoint-by-endpoint lookup | Generated REST Endpoints |
Authoritative source artifacts
packages/exchange-api/public/swagger.jsonpackages/stats/public/swagger.jsonpackages/api-docs/merged/unified-swagger.json
Base URL and path rule
The generated REST bundle publishes endpoint paths and schema detail, but the current Mintlify render input does not declare one canonicalservers[] array. Treat generated REST paths as deployment-relative under the target REST base URL you are integrating against. The adjacent private write-path endpoints discussed on the support pages are also deployment-relative where used, but they are documented manually rather than through the generated public Swagger bundle.
Support shape
The public REST family is organized around:- Quickstart
- Authentication
- Rate Limits
- Errors
- Examples and SDKs
- Source Artifacts
- Generated Reference Status
Public contract boundaries
| Boundary | Public contract |
|---|---|
| Generated REST pages | Published for the active public REST family only |
| Shared write-path concepts | Public readers can use this family to understand signing, encryption, limits, and failures for request submission |
| Restricted or product-specific APIs | Operator/KYC and copy-trading remain separate boundary-summary families; do not treat them as part of the public REST generated surface |
| Realtime relationship | Use REST for initial state and request-response semantics, then switch to Realtime when the job is feed consumption or update streaming |