---
title: "Get account balance"
method: POST
path: "/orders/v1/get_account_balance"
tags: ["CLOB"]
---

# Get account balance

`POST /orders/v1/get_account_balance`

Returns a snapshot of an account balance and buying power on the CLOB matching the given filters.

## Headers

- `X-SCX-SIGNED` string, required
- `X-SCX-TIMESTAMP` string, required

## Request body

- union
  - object — Use this request body to retrieve the balance for a specific participant. Note: The participants' Fiat balances can be maintained by the platform's account
    - `name` string, required — The account associated with the order. This can be either the `participant_code` assigned by zerohash or the `account_label` defined by the platform. - Custom account label : `firms/{platform_code}/accounts/{account_label}`. - General account label : `firms/{platform_code}/accounts/{participant_code}`.
    - `user` 'firms/F-{platform_code}/users/{participant_code}' | 'firms/F-{platform_code}/users/{account_label}' | 'firms/{zerohash}/users/{platform_code}', required — Fully-qualified user. Format: `firms/F-{platform_code}/users/{participant_code}`. This value is case sensitive. ### Clearing House Designations * **USA:** 00SXCM (ZH Clearing House) * **EU:** ZHDSEU ### Prefunded Model * USD balances are ledgered directly to the participants on their CLOB account. * Participants will be credit checked against their available balance on the zerohash platform. * Accounts must be registed with the `prefunded` field as `true` on the `POST /accounts` endpoint. * Trade settlement is handled directly between participants and occurs instantly upon execution. ### Novated Model * Utilizes a central float account to manage the cumulative buying power of your customers. * USD balance is ledgeder to the platforms float account. * USD credit checks must be performed by the platform prior to order placement. * Accounts must be registed with the `prefunded` field as `false` on the `POST /accounts` endpoint. * Allows platforms to manage the buying power of their customers effectively, allowing for better operational efficiency.
    - `currency` string, required — Currency code to return the balance in (ISO 4217, three letters).
  - object — Use this request body to retrieve the balance for a platform float account. Note: The platform's Float balances are held in accounts under the ZEROHASH namespace.
    - `name` string, required — Fully-qualified Account. Format: `firms/{ZEROHASH}/accounts/{platform_code}`. This value is case sensitive.
    - `user` 'firms/F-{platform_code}/users/{participant_code}' | 'firms/F-{platform_code}/users/{account_label}' | 'firms/{zerohash}/users/{platform_code}', required — Fully-qualified user. Format: `firms/F-{platform_code}/users/{participant_code}`. This value is case sensitive. ### Clearing House Designations * **USA:** 00SXCM (ZH Clearing House) * **EU:** ZHDSEU ### Prefunded Model * USD balances are ledgered directly to the participants on their CLOB account. * Participants will be credit checked against their available balance on the zerohash platform. * Accounts must be registed with the `prefunded` field as `true` on the `POST /accounts` endpoint. * Trade settlement is handled directly between participants and occurs instantly upon execution. ### Novated Model * Utilizes a central float account to manage the cumulative buying power of your customers. * USD balance is ledgeder to the platforms float account. * USD credit checks must be performed by the platform prior to order placement. * Accounts must be registed with the `prefunded` field as `false` on the `POST /accounts` endpoint. * Allows platforms to manage the buying power of their customers effectively, allowing for better operational efficiency.
    - `currency` string, required — Currency code to return the balance in (ISO 4217, three letters).
  - object — Use this request body to retrieve the balance for a platform commission account.
    - `name` string, required — Fully-qualified Account. Format: `firms/{platform_code}/accounts/{platform_code}-commission`. This value is case sensitive.
    - `user` 'firms/F-{platform_code}/users/{participant_code}' | 'firms/F-{platform_code}/users/{account_label}' | 'firms/{zerohash}/users/{platform_code}', required — Fully-qualified user. Format: `firms/F-{platform_code}/users/{participant_code}`. This value is case sensitive. ### Clearing House Designations * **USA:** 00SXCM (ZH Clearing House) * **EU:** ZHDSEU ### Prefunded Model * USD balances are ledgered directly to the participants on their CLOB account. * Participants will be credit checked against their available balance on the zerohash platform. * Accounts must be registed with the `prefunded` field as `true` on the `POST /accounts` endpoint. * Trade settlement is handled directly between participants and occurs instantly upon execution. ### Novated Model * Utilizes a central float account to manage the cumulative buying power of your customers. * USD balance is ledgeder to the platforms float account. * USD credit checks must be performed by the platform prior to order placement. * Accounts must be registed with the `prefunded` field as `false` on the `POST /accounts` endpoint. * Allows platforms to manage the buying power of their customers effectively, allowing for better operational efficiency.
    - `currency` string, required — Currency code to return the balance in (ISO 4217, three letters).

## Response `200`

A successful response

- PostGetAccountBalanceResponse
  - `balance` string — Current account balance
  - `capital_requirement` string — Capital requirement for the account
  - `excess_capital` string — Excess capital available in the account
  - `buying_power` string — Buying power available in the account
  - `securities` object
  - `total_security_notional_value` string
  - `total_security_available_value` string
  - `open_orders` string
  - `alternate_capital_requirement_currency` string
  - `alternate_capital_requirement` string
  - `unsettled_funds` string
  - `margin_requirement` string
  - `update_time` string, date-time — The time at which the balance was last updated

## Other responses

- `default` — An error occurred

---

[API](https://skmtc.net/zerohash/apis/zerohash-api.md) · [All operations](https://skmtc.net/zerohash/apis/zerohash-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zerohash/zerohash-api/revisions/8b647d934363/schema)