> ## 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. # WebSocket stream > Single `/ws` connection for subscribe and push messages (orderbooks, prices, account updates, and more). This page reflects the **`ws`** channel from **`specs/asyncapi.yaml`** in this repo (mirrors the file served at [`/docs/ws-asyncapi.yaml`](https://beta.rocket-cluster-1.com/docs/ws-asyncapi.yaml) on the cluster). For connection and subscribe flows, start with **[Public WebSocket streams](/guides/ws-public)** and **[Private WebSocket streams](/guides/ws-private)** — each **stream** under those sections has its own page with the same AsyncAPI playground. Pick **testnet**, **devnet**, or **beta** in the playground from the spec **servers**. ## AsyncAPI ````yaml specs/asyncapi.yaml ws id: ws title: Ws description: WebSocket stream endpoint for subscriptions and updates. servers: - id: testnet protocol: wss host: testnet.rocket-cluster-1.com bindings: [] variables: [] - id: devnet protocol: wss host: devnet.rocket-cluster-1.com bindings: [] variables: [] - id: beta protocol: wss host: beta.rocket-cluster-1.com bindings: [] variables: [] address: /ws parameters: [] bindings: [] operations: - &ref_14 id: handleClientMessage title: Receive client messages type: receive messages: - &ref_16 id: clientMessage contentType: application/json payload: - oneOf: &ref_4 - type: object required: - Subscribe additionalProperties: false properties: Subscribe: &ref_3 oneOf: - type: object required: - Orderbook additionalProperties: false properties: Orderbook: type: object required: - instrumentId additionalProperties: false properties: instrumentId: &ref_0 type: string description: >- 8-byte instrument identifier, serialized as `0x...` (16 hex chars). pattern: ^0x[0-9a-fA-F]{16}$ example: '0xeafc0b0a0de781b7' x-parser-schema-id: InstrumentId x-parser-schema-id: x-parser-schema-id: SubscriptionKind::Orderbook - type: object required: - PriceFeed additionalProperties: false properties: PriceFeed: type: object required: - instrumentId additionalProperties: false properties: instrumentId: *ref_0 x-parser-schema-id: x-parser-schema-id: SubscriptionKind::PriceFeed - type: object required: - AssetPriceFeed additionalProperties: false properties: AssetPriceFeed: type: object required: - assetId additionalProperties: false properties: assetId: &ref_1 type: integer minimum: 0 description: Asset identifier (serialized as a number). example: 0 x-parser-schema-id: AssetId x-parser-schema-id: x-parser-schema-id: SubscriptionKind::AssetPriceFeed - type: object required: - OrderEvents additionalProperties: false properties: OrderEvents: type: object additionalProperties: false description: >- Subscribe to order events filtered by account and/or instrument id. properties: account: &ref_2 type: string description: >- Ethereum-style 20-byte address, serialized as `0x...`. pattern: ^0x[0-9a-fA-F]{40}$ example: '0xf19e16fe3cf25c630f55f66d6c6cbf64f84fc86b' x-parser-schema-id: AccountAddress instrumentId: *ref_0 x-parser-schema-id: x-parser-schema-id: SubscriptionKind::OrderEvents - type: object required: - Collateral additionalProperties: false properties: Collateral: type: object required: - assetId - account additionalProperties: false properties: assetId: *ref_1 account: *ref_2 x-parser-schema-id: x-parser-schema-id: SubscriptionKind::Collateral - type: object required: - Position additionalProperties: false properties: Position: type: object required: - account additionalProperties: false properties: account: *ref_2 x-parser-schema-id: x-parser-schema-id: SubscriptionKind::Position - type: object required: - AccountRisk additionalProperties: false properties: AccountRisk: type: object required: - account additionalProperties: false properties: account: *ref_2 x-parser-schema-id: x-parser-schema-id: SubscriptionKind::AccountRisk - type: object required: - OpenOrders additionalProperties: false properties: OpenOrders: type: object required: - account additionalProperties: false properties: account: *ref_2 x-parser-schema-id: x-parser-schema-id: SubscriptionKind::OpenOrders - type: object required: - FundingRate additionalProperties: false properties: FundingRate: type: object required: - instrumentId additionalProperties: false properties: instrumentId: *ref_0 x-parser-schema-id: x-parser-schema-id: SubscriptionKind::FundingRate - type: object required: - InstrumentStats additionalProperties: false properties: InstrumentStats: type: object required: - instrumentId additionalProperties: false properties: instrumentId: *ref_0 x-parser-schema-id: x-parser-schema-id: SubscriptionKind::InstrumentStats - type: object required: - Candle additionalProperties: false properties: Candle: type: object required: - instrumentId - interval additionalProperties: false properties: instrumentId: *ref_0 interval: &ref_10 type: string description: Candle aggregation interval. enum: - 1m - 5m - 15m - 30m - 1h - 4h - 1d example: 1h x-parser-schema-id: CandleTimeframe x-parser-schema-id: x-parser-schema-id: SubscriptionKind::Candle - type: object required: - PositionFunding additionalProperties: false properties: PositionFunding: type: object required: - account additionalProperties: false properties: account: *ref_2 x-parser-schema-id: x-parser-schema-id: SubscriptionKind::PositionFunding - type: object required: - LastMatchPrice additionalProperties: false properties: LastMatchPrice: type: object required: - instrumentId additionalProperties: false properties: instrumentId: *ref_0 x-parser-schema-id: x-parser-schema-id: SubscriptionKind::LastMatchPrice - type: object required: - AuctionFills additionalProperties: false properties: AuctionFills: type: object required: - instrumentId additionalProperties: false properties: instrumentId: *ref_0 x-parser-schema-id: x-parser-schema-id: SubscriptionKind::AuctionFills x-parser-schema-id: SubscriptionKind x-parser-schema-id: ClientMessageSubscribe - type: object required: - Unsubscribe additionalProperties: false properties: Unsubscribe: *ref_3 x-parser-schema-id: ClientMessageUnsubscribe - type: string enum: - Ping description: Unit enum variant serialization for `ClientMessage::Ping`. x-parser-schema-id: ClientMessagePing x-parser-schema-id: ClientMessage name: ClientMessage description: JSON text frames sent by the client. headers: [] jsonPayloadSchema: oneOf: *ref_4 x-parser-schema-id: ClientMessage title: ClientMessage description: JSON text frames sent by the client. example: '{}' bindings: [] extensions: - id: x-parser-unique-object-id value: clientMessage bindings: [] extensions: &ref_13 - id: x-parser-unique-object-id value: ws - &ref_15 id: sendMessage title: Server messages type: send messages: - &ref_17 id: serverMessage contentType: application/json payload: - oneOf: &ref_12 - type: object required: - QuoteUpdate additionalProperties: false properties: QuoteUpdate: type: object required: - instrumentId - quote additionalProperties: false properties: instrumentId: *ref_0 quote: type: object required: - timestamp - bid_price - bid_size - ask_price - ask_size additionalProperties: false properties: timestamp: &ref_7 type: integer format: uint64 description: Timestamp in milliseconds since Unix epoch. example: 1774284085000 x-parser-schema-id: BlockTimestamp bid_price: &ref_5 type: string format: Human-readable decimal string example: '42.123' x-parser-schema-id: DecimalString bid_size: *ref_5 ask_price: *ref_5 ask_size: *ref_5 x-parser-schema-id: QuoteView x-parser-schema-id: x-parser-schema-id: ServerMessage::QuoteUpdate - type: object required: - OrderbookUpdate additionalProperties: false properties: OrderbookUpdate: type: object required: - instrumentId - orderbook additionalProperties: false properties: instrumentId: *ref_0 orderbook: type: object required: - bids - asks additionalProperties: false properties: bids: type: array items: &ref_6 type: object required: - price - quantity additionalProperties: false properties: price: *ref_5 quantity: *ref_5 x-parser-schema-id: LevelView x-parser-schema-id: asks: type: array items: *ref_6 x-parser-schema-id: x-parser-schema-id: OrderbookView x-parser-schema-id: x-parser-schema-id: ServerMessage::OrderbookUpdate - type: object required: - MarkPriceUpdate additionalProperties: false properties: MarkPriceUpdate: type: object required: - instrumentId - markPrice additionalProperties: false properties: instrumentId: *ref_0 markPrice: &ref_8 oneOf: - type: object required: - Price additionalProperties: false properties: Price: type: object required: - price - timestamp additionalProperties: false properties: price: *ref_5 timestamp: *ref_7 x-parser-schema-id: x-parser-schema-id: - type: object required: - PriceIV additionalProperties: false properties: PriceIV: type: object required: - price - iv - timestamp additionalProperties: false properties: price: *ref_5 iv: *ref_5 timestamp: *ref_7 x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: MarkPriceView x-parser-schema-id: x-parser-schema-id: ServerMessage::MarkPriceUpdate - type: object required: - AssetMarkPriceUpdate additionalProperties: false properties: AssetMarkPriceUpdate: type: object required: - assetId - markPrice additionalProperties: false properties: assetId: *ref_1 markPrice: *ref_8 x-parser-schema-id: x-parser-schema-id: ServerMessage::AssetMarkPriceUpdate - type: object required: - OrderEventUpdate additionalProperties: false properties: OrderEventUpdate: &ref_11 type: object required: - orderEvents additionalProperties: false properties: account: *ref_2 instrumentId: *ref_0 orderEvents: type: array items: type: object required: - orderId - account - instrument - eventData additionalProperties: false properties: orderId: &ref_9 type: integer format: uint64 description: Global order identifier. example: 105 x-parser-schema-id: GlobalOrderId account: *ref_2 instrument: *ref_0 eventData: oneOf: - type: object required: - Fill additionalProperties: false properties: Fill: type: object required: - price - size - remainingSize - originalSize - settlementAsset - timestamp - isPassive - isFilled - feeRate - feeAmount - isLiquidation - isAdl additionalProperties: false properties: price: *ref_5 size: *ref_5 remainingSize: *ref_5 originalSize: *ref_5 settlementAsset: *ref_1 pnl: *ref_5 timestamp: *ref_7 isPassive: type: boolean x-parser-schema-id: isFilled: type: boolean x-parser-schema-id: feeRate: *ref_5 feeAmount: *ref_5 isLiquidation: type: boolean x-parser-schema-id: isAdl: type: boolean x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: - type: object required: - Placed additionalProperties: false properties: Placed: type: object required: - price - size - remainingSize - originalSize - settlementAsset - timestamp - isPassive - isFilled additionalProperties: false properties: price: *ref_5 size: *ref_5 remainingSize: *ref_5 originalSize: *ref_5 settlementAsset: *ref_1 timestamp: *ref_7 isPassive: type: boolean x-parser-schema-id: isFilled: type: boolean x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: - type: string enum: - Canceled x-parser-schema-id: - type: object required: - Modified additionalProperties: false properties: Modified: type: object required: - price - size - timestamp additionalProperties: false properties: price: *ref_5 size: *ref_5 timestamp: *ref_7 x-parser-schema-id: x-parser-schema-id: - type: object required: - Rejected additionalProperties: false properties: Rejected: type: object required: - reason additionalProperties: false properties: reason: type: string description: >- Order rejection reason (camelCase serialization). enum: - marginViolated - notEnoughLiquidity - tooMuchSlippage - selfTradePrevention x-parser-schema-id: RejectionReason x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: OrderEventDataClientView x-parser-schema-id: OrderEventClientView x-parser-schema-id: x-parser-schema-id: OrderEventUpdate x-parser-schema-id: ServerMessage::OrderEventUpdate - type: object required: - CollateralUpdate additionalProperties: false properties: CollateralUpdate: type: object required: - assetId - account - collateral additionalProperties: false properties: assetId: *ref_1 account: *ref_2 collateral: *ref_5 x-parser-schema-id: x-parser-schema-id: ServerMessage::CollateralUpdate - type: object required: - PositionUpdate additionalProperties: false properties: PositionUpdate: type: object required: - account - positions additionalProperties: false properties: account: *ref_2 positions: type: object description: > Serialized form of `PositionSetView`, which is a map keyed by `InstrumentId`. additionalProperties: type: object required: - quantity - averagePrice - liquidationPrice - accruedFunding - unrealizedPnl - reservedMargin - leverageSetting - createdAt - updatedAt additionalProperties: false properties: quantity: *ref_5 averagePrice: *ref_5 liquidationPrice: *ref_5 accruedFunding: *ref_5 unrealizedPnl: *ref_5 reservedMargin: *ref_5 leverageSetting: type: integer format: int64 x-parser-schema-id: createdAt: *ref_7 updatedAt: *ref_7 x-parser-schema-id: PositionView x-parser-schema-id: PositionSetView x-parser-schema-id: x-parser-schema-id: ServerMessage::PositionUpdate - type: object required: - AccountRiskUpdate additionalProperties: false properties: AccountRiskUpdate: type: object required: - account - risk additionalProperties: false properties: account: *ref_2 risk: type: object required: - account - availableCollateral - marginRequirement - unreservedMargin - equity - reservedMargin - unrealizedPnl - notionalValue additionalProperties: false properties: account: *ref_2 availableCollateral: *ref_5 marginRequirement: *ref_5 unreservedMargin: *ref_5 equity: *ref_5 reservedMargin: *ref_5 unrealizedPnl: *ref_5 notionalValue: *ref_5 x-parser-schema-id: AccountView x-parser-schema-id: x-parser-schema-id: ServerMessage::AccountRiskUpdate - type: object required: - OpenOrdersUpdate additionalProperties: false properties: OpenOrdersUpdate: type: object required: - account - orders additionalProperties: false properties: account: *ref_2 orders: type: array items: type: object required: - orderId - trader - orderType - instrumentId - price - quantity - filledQuantity - side - timestamp additionalProperties: false properties: orderId: *ref_9 trader: *ref_2 orderType: type: string description: Order type. enum: - Limit - Market - Twap x-parser-schema-id: OrderType triggerType: type: string description: Trigger type for conditional orders. enum: - StopLoss - TakeProfit x-parser-schema-id: TriggerType instrumentId: *ref_0 price: *ref_5 quantity: *ref_5 filledQuantity: *ref_5 side: type: string description: Order side. enum: - Buy - Sell x-parser-schema-id: OrderSide timestamp: *ref_7 triggerPrice: *ref_5 twapInterval: type: integer format: uint64 x-parser-schema-id: twapOriginalQuantity: *ref_5 twapFilledQuantity: *ref_5 twapFrequency: type: integer format: uint64 x-parser-schema-id: twapRandomize: type: boolean x-parser-schema-id: x-parser-schema-id: OpenOrderView x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: ServerMessage::OpenOrdersUpdate - type: object required: - FundingRateUpdate additionalProperties: false properties: FundingRateUpdate: type: object required: - instrumentId - fundingRate - premiumIndex - timestamp - round additionalProperties: false properties: instrumentId: *ref_0 fundingRate: *ref_5 premiumIndex: *ref_5 timestamp: *ref_7 round: type: integer format: uint64 x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: ServerMessage::FundingRateUpdate - type: object required: - InstrumentStatsUpdate additionalProperties: false properties: InstrumentStatsUpdate: type: object required: - instrumentId - stats additionalProperties: false properties: instrumentId: *ref_0 stats: type: object required: - fundingRate1H - volume24H - openInterest additionalProperties: false properties: fundingRate1H: type: number format: double x-parser-schema-id: volume24H: type: number format: double x-parser-schema-id: openInterest: type: number format: double x-parser-schema-id: x-parser-schema-id: InstrumentStatsView x-parser-schema-id: x-parser-schema-id: ServerMessage::InstrumentStatsUpdate - type: object required: - CandleUpdate additionalProperties: false properties: CandleUpdate: type: object required: - candle additionalProperties: false properties: candle: type: object required: - instrumentId - interval - slot - timestamp - open - high - low - close - volume - isClosed additionalProperties: false properties: instrumentId: *ref_0 interval: *ref_10 slot: type: integer format: uint64 x-parser-schema-id: timestamp: *ref_7 open: type: number format: float x-parser-schema-id: high: type: number format: float x-parser-schema-id: low: type: number format: float x-parser-schema-id: close: type: number format: float x-parser-schema-id: volume: type: number format: float x-parser-schema-id: isClosed: type: boolean x-parser-schema-id: x-parser-schema-id: StreamCandle x-parser-schema-id: x-parser-schema-id: ServerMessage::CandleUpdate - type: object required: - PositionFundingUpdate additionalProperties: false properties: PositionFundingUpdate: type: object required: - account - fundingRate - timestamp - round - instrumentId - pnl additionalProperties: false properties: account: *ref_2 fundingRate: *ref_5 timestamp: *ref_7 round: type: integer format: uint64 x-parser-schema-id: instrumentId: *ref_0 pnl: *ref_5 x-parser-schema-id: x-parser-schema-id: ServerMessage::PositionFundingUpdate - type: object required: - LastMatchPriceUpdate additionalProperties: false properties: LastMatchPriceUpdate: type: object required: - instrumentId - lastMatchPrice additionalProperties: false properties: instrumentId: *ref_0 lastMatchPrice: *ref_5 x-parser-schema-id: x-parser-schema-id: ServerMessage::LastMatchPriceUpdate - type: object required: - AuctionFillUpdate additionalProperties: false properties: AuctionFillUpdate: type: object required: - instrumentId - price - fills additionalProperties: false properties: instrumentId: *ref_0 price: *ref_5 fills: type: array items: type: object required: - size - timestamp additionalProperties: false properties: size: *ref_5 timestamp: *ref_7 x-parser-schema-id: AuctionFillEntry x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: ServerMessage::AuctionFillUpdate - type: object required: - SubscribeConfirmation additionalProperties: false properties: SubscribeConfirmation: *ref_3 x-parser-schema-id: ServerMessage::SubscribeConfirmation - type: object required: - UnsubscribeConfirmation additionalProperties: false properties: UnsubscribeConfirmation: *ref_3 x-parser-schema-id: ServerMessage::UnsubscribeConfirmation - type: string enum: - Pong x-parser-schema-id: ServerMessage::Pong - type: object required: - Error additionalProperties: false properties: Error: type: string x-parser-schema-id: x-parser-schema-id: ServerMessage::Error - *ref_11 x-parser-schema-id: ServerMessage name: ServerMessage description: JSON text frames broadcast by the server. headers: [] jsonPayloadSchema: oneOf: *ref_12 x-parser-schema-id: ServerMessage title: ServerMessage description: JSON text frames broadcast by the server. example: '{}' bindings: [] extensions: - id: x-parser-unique-object-id value: serverMessage bindings: [] extensions: *ref_13 sendOperations: - *ref_14 receiveOperations: - *ref_15 sendMessages: - *ref_16 receiveMessages: - *ref_17 extensions: - id: x-parser-unique-object-id value: ws securitySchemes: [] ````