Skip to main content

​
Before you begin

  1. Use a RocketFi account on the environment you are targeting (for example beta at beta.rocketfi.io).
  2. Open API management and create an API key for use with the SDK (signing transactions). Store it like a password—it is not sent as an HTTP auth header.
  3. Point your client at the correct REST base URL and WebSocket host for that network — see Environments.

​
Where to explore the API

ToolUse for
This documentation siteNarrated guides, grouped REST reference, AsyncAPI WebSocket reference, Mintlify playground
Swagger UITrying REST operations with Try it out against the live beta cluster
Live OpenAPI / AsyncAPIMachine-readable contracts for codegen and CI

​
Typical integration path

  1. Read-only: call public REST routes (instruments, candles, fees, and so on) to learn payloads—no API key in headers.
  2. Account data: use routes that take an account (and pagination) per OpenAPI; see Authentication.
  3. Real-time: open WebSocket /ws, subscribe with the JSON kinds in AsyncAPI, handle Pong and Error — Public WebSocket streams and Private WebSocket streams.
  4. Trading / writes: build signed requests with the Rust or Python SDK and your API key configuration; submit per the REST API and confirm on the socket where applicable.

​
Security

Never commit API keys to git, log them in plain text, or expose them in front-end bundles. Prefer a secret store or environment variables on your server.