Skip to main content

​
What you can build

RocketFi exposes a REST API for request/response flows (instruments, positions, submitting transactions) and a WebSocket API for low-latency streams (orderbooks, marks, funding, account and order events). Asynchronous workflows are common in trading systems: a REST call may return immediately while final settlement or matching continues in the background. For live status, prefer the WebSocket stream described under WebSocket API.

​
Documentation map

  1. Introduction — environments, auth, limits, errors, WebSocket concepts.
  2. REST API — grouped endpoints (service, market data, account, trading, vault, faucet).
  3. WebSocket API — the /ws channel and message schemas.

​
Specifications

Source files in this repo:
  • specs/openapi.json — REST (also available from your backend at /docs/openapi.json when deployed).
  • specs/asyncapi.yaml — WebSockets (backend: /docs/ws-asyncapi.yaml).
Regenerate or copy those files when the backend changes, then redeploy this docs site.