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

# Balance

> Authenticated channel for streaming real-time account balance updates.

<Note>Authenticated channel. Connect to: `wss://wss.prime.kraken.com/ws/v1`</Note>

Request for stream of Balance updates. Provides real-time account balance information.

## Subscribe Request

<Tabs>
  <Tab title="Subscribe Schema">
    <ParamField path="reqid" type="number" required>
      Request ID - will be echoed back in the response structure.
    </ParamField>

    <ParamField path="type" type="string" required>
      Request type. Value: `subscribe`
    </ParamField>

    <ParamField path="streams" type="array" required>
      Array containing the Balance stream configuration.

      <Expandable title="properties">
        <ParamField path="name" type="string" required>
          Subscription name. Value: `Balance`
        </ParamField>

        <ParamField path="Currencies" type="array">
          Optional list of currencies to filter these balance updates by, default is all available currencies.
        </ParamField>

        <ParamField path="EquivalentCurrency" type="string">
          If provided, will provide converted equivalent amounts of each currency in the provided Equivalent Currency.
        </ParamField>
      </Expandable>
    </ParamField>
  </Tab>

  <Tab title="Example">
    ```json theme={null}
    {
      "reqid": 11,
      "type": "subscribe",
      "streams": [
        {
          "name": "Balance",
          "EquivalentCurrency": "USD"
        }
      ]
    }
    ```
  </Tab>
</Tabs>

## Response

<Tabs>
  <Tab title="Response Schema">
    <ParamField path="reqid" type="number" required>
      A number that relates this response to a request.
    </ParamField>

    <ParamField path="type" type="string" required>
      The type of message sent.
    </ParamField>

    <ParamField path="ts" type="string" required>
      An ISO-8601 UTC string of the form `2019-02-13T05:17:32.000000Z`.
    </ParamField>

    <ParamField path="initial" type="boolean">
      If this is initial data for a request, the initial flag will be set.
    </ParamField>

    <ParamField path="seqNum" type="number" required>
      The sequence number for this response per request.
    </ParamField>

    <ParamField path="action" type="string">
      "Update" or "Remove" - tells the client if the given entity should be removed or added/updated.
    </ParamField>

    <ParamField path="data" type="array" required>
      Array of Balance data.

      <Expandable title="properties">
        <ParamField path="Currency" type="string" required>
          Currency of this balance update.
        </ParamField>

        <ParamField path="Amount" type="string" required>
          Current balance amount in the specified currency.
        </ParamField>

        <ParamField path="AvailableAmount" type="string" required>
          Amount available for trading right now.
        </ParamField>

        <ParamField path="Equivalent" type="object">
          If requested equivalent balance amount, will provide a Balance update in the specified equivalent currency.

          <Expandable title="properties">
            <ParamField path="Currency" type="string">
              Requested Equivalent Currency.
            </ParamField>

            <ParamField path="Amount" type="string">
              Amount of this balance in the equivalent currency.
            </ParamField>

            <ParamField path="AvailableAmount" type="string">
              Equivalent amount of amount available for trading right now.
            </ParamField>
          </Expandable>
        </ParamField>
      </Expandable>
    </ParamField>
  </Tab>

  <Tab title="Example">
    ```json theme={null}
    {
      "reqid": 11,
      "type": "Balance",
      "ts": "2021-09-16T16:17:06.892914Z",
      "initial": true,
      "seqNum": 1,
      "data": [
        {
          "Currency": "USD",
          "Amount": "-1928479.77953598",
          "AvailableAmount": "-1928479.77953598",
          "Equivalent": {
            "Currency": "USD",
            "Amount": "-1928479.78",
            "AvailableAmount": "-1928479.78"
          }
        },
        {
          "Currency": "BTC",
          "Amount": "40.15480673",
          "AvailableAmount": "40.15480673",
          "Equivalent": {
            "Currency": "USD",
            "Amount": "1930241.56",
            "AvailableAmount": "1930241.56"
          }
        }
      ]
    }
    ```
  </Tab>
</Tabs>