> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ondoperps.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Subscribe: Spot Balances

> Requires login. Where enabled, balanceSpot delivers complete balance snapshots, not a transaction log. Replace the local balance map on every update. If unavailable, use GET /v1/spot/balances with conservative reconciliation. Send over the shared /ws connection. See the [Spot API guide](/api-reference/spot-api-guide).



## OpenAPI

````yaml /api-reference/ws-spec.json post /ws/balanceSpot
openapi: 3.0.3
info:
  title: Ondo Perps WebSocket API
  version: '1.0'
  description: >-
    WebSocket API for Ondo Perps: real-time market data, order updates,
    positions, balance, funding, and more.


    ## Connection


    Connect via `wss://api.ondoperps.xyz/ws`. The server enforces a 32 KB max
    message size and a rate limit of 25 requests/second (burst 50).


    ## Authentication


    Public channels (market data) require no authentication. Private channels
    (orders, fills, positions, balance, etc.) require a `login` message first.


    ### JWT Login

    ```json

    {"op": "login", "args": {"token": "<JWT>"}}

    ```


    ### API Key Login

    ```json

    {"op": "login", "args": {"key": "<api_key_id>", "time": "<unix_ms>", "sign":
    "<hex_hmac>"}}

    ```


    Signature: `HMAC-SHA256(api_secret, time + "ondo_perps_ws_login" )`


    ## Heartbeat


    Send `{"op": "ping"}` periodically. The server responds with `{"type":
    "pong"}`. Connections idle for 180 seconds are closed.


    ## Message Format


    ### Client → Server

    All client messages use the `op` field: `ping`, `login`, `subscribe`,
    `unsubscribe`, `sendMessage`.


    ### Server → Client

    All server messages use the `type` field: `pong`, `loggedIn`, `subscribed`,
    `unsubscribed`, `update`, `error`.

    Channel data updates arrive as `{"type": "update", "channel": "<name>",
    "data": <payload>}`.
servers:
  - url: wss://api.ondoperps.xyz
    description: Production
security: []
paths:
  /ws/balanceSpot:
    post:
      tags:
        - Spot private channels
      summary: 'Subscribe: Spot Balances'
      description: >-
        Requires login. Where enabled, balanceSpot delivers complete balance
        snapshots, not a transaction log. Replace the local balance map on every
        update. If unavailable, use GET /v1/spot/balances with conservative
        reconciliation. Send over the shared /ws connection. See the [Spot API
        guide](/api-reference/spot-api-guide).
      operationId: subscribe_balanceSpot
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - op
                - channel
              properties:
                op:
                  type: string
                  enum:
                    - subscribe
                    - unsubscribe
                  example: subscribe
                  description: Operation type.
                channel:
                  type: string
                  enum:
                    - balanceSpot
                  example: balanceSpot
                  description: Channel for this subscription.
            example:
              op: subscribe
              channel: balanceSpot
      responses:
        '200':
          description: Complete Spot balance snapshot.
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    enum:
                      - update
                  channel:
                    type: string
                    enum:
                      - balanceSpot
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/SpotBalance'
                    nullable: true
components:
  schemas:
    SpotBalance:
      type: object
      properties:
        coin:
          type: string
          description: ''
        total:
          type: string
          description: Decimal string.
        reserved:
          type: string
          description: Held in open Spot orders.
        free:
          type: string
          description: >-
            Available to fund additional orders; does not establish withdrawal
            eligibility.
        usdValue:
          type: string
          description: Optional estimated USD value.
      required:
        - coin
        - total
        - reserved
        - free

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.