Skip to main content

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.

By using the RocketFi API, you agree to the RocketFi terms and privacy policy that apply to your use of the product. If you do not agree, do not use the API. This documentation is maintained alongside the live beta API and will change as we ship new functionality. If something is unclear or missing, share feedback through your usual RocketFi channel so we can improve it.

​
Welcome

Welcome to the RocketFi API documentation. It is written for traders and developers who want to integrate automated strategies, dashboards, custody workflows, and other systems with RocketFi. RocketFi offers a REST API for request and response workflows (instruments, market data, account state, vaults, and transaction submission where supported) and a WebSocket API on a single /ws endpoint where you subscribe to logical streams for live prices, books, funding, and account-scoped updates. The exact subscription kinds and payloads are defined in the generated AsyncAPI reference. Trading integrations are often asynchronous: a successful REST response can arrive before matching, vault, or downstream processing has finished. Combine REST with WebSocket subscriptions when you need authoritative live state, fills, or order lifecycle events.

​
How to navigate these docs

Start with Overview for how the pieces fit together, then Getting started for API keys, SDK signing, and first requests.
TopicPage
Base URLs, Swagger, and schema linksEnvironments
Verbs and conventionsHTTP methods
API keys & SDK signingAuthentication
Throttling and retriesRate limits
List endpoints and cursorsPagination
HTTP status codes and socket Error framesError responses
Clients and codegenSDKs and examples
REST is split the way many exchange docs are: Public REST-API for market-wide reads, and Private REST-API for authenticated account, trading, vault, and testnet utilities. WebSockets follow the same idea: Public WebSocket streams for broadcast-style data, and Private WebSocket streams for account-scoped feeds (with Subscription reference from AsyncAPI). You can exercise REST interactively in Swagger UI on the beta cluster. Machine-readable contracts live at OpenAPI and AsyncAPI.

​
Integrators and operators

If you maintain CI or documentation pipelines: this site loads the published OpenAPI and AsyncAPI URLs above. When those files change on the cluster, redeploy this Mintlify project so docs.rocketfi.io stays aligned with production behavior.