Documentation Index
Fetch the complete documentation index at: https://api.docs.rocketfi.io/llms.txt
Use this file to discover all available pages before exploring further.
What you can build
RocketFi exposes a REST API for instruments, market statistics, account state, vaults, bridge activity, and submitting transactions where the OpenAPI allows. A WebSocket API on/ws streams live updates: public feeds for books, marks, funding, and candles, and private feeds for orders, trades, and balances — see Public WebSocket streams and Private WebSocket streams. Subscription kinds and payloads are defined in AsyncAPI.
Integrations are usually asynchronous: treat REST success as acceptance into a pipeline, then confirm outcomes on the socket or with follow-up REST reads.
Where to go next
| Goal | Start here |
|---|---|
| Keys, first REST call, WebSocket handshake | Getting started |
| Hosts, Swagger, OpenAPI, AsyncAPI URLs | Environments |
| Market data REST | Public REST-API |
| Account and trading REST | Private REST-API |
| Generated REST operations | Sidebar Public REST-API / Private REST-API |
| Stream schemas and playground | WebSocket API |
| Contract | Where |
|---|---|
| OpenAPI (hosted) | …/docs/openapi.json |
| OpenAPI (docs site) | specs/openapi.json in this repo — enriched for Mintlify (examples + tables); run node scripts/enrich-openapi-rest-docs.mjs after edits |
| AsyncAPI | …/docs/ws-asyncapi.yaml |
| Swagger UI | …/docs/ |