> ## 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.

# Overview

> How the RocketFi API fits together for traders and integrators.

## 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](/guides/ws-public)** and **[Private WebSocket streams](/guides/ws-private)**. Subscription kinds and payloads are defined in **[AsyncAPI](https://beta.rocket-cluster-1.com/docs/ws-asyncapi.yaml)**.

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](/guides/getting-started)**     |
| Hosts, Swagger, OpenAPI, AsyncAPI URLs     | **[Environments](/guides/environments)**           |
| Market data REST                           | **[Public REST-API](/guides/public-rest-api)**     |
| Account and trading REST                   | **[Private REST-API](/guides/private-rest-api)**   |
| Generated REST operations                  | Sidebar **Public REST-API** / **Private REST-API** |
| Stream schemas and playground              | **[WebSocket API](/websocket-stream)**             |

Live contracts for automation and codegen:

| Contract            | Where                                                                                                                                      |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| OpenAPI (hosted)    | […/docs/openapi.json](https://beta.rocket-cluster-1.com/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](https://beta.rocket-cluster-1.com/docs/ws-asyncapi.yaml)                                                         |
| Swagger UI          | […/docs/](https://beta.rocket-cluster-1.com/docs/)                                                                                         |

When the API changes, update the repo spec, re-run the enrichment script if needed, and redeploy Mintlify so published pages stay accurate.