Sign in

v1

latestOpenAPI 3.1.02026-07-241653251.3 MB
CLOB

List account balances

Returns a snapshotted list balances and buying for an account power on the CLOB matching the given filter.

post/orders/v1/list_account_balances

Headers

X-SCX-SIGNEDstring required

HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.

X-SCX-TIMESTAMPstring required
Example:1678901234

Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.

Request body

namestring 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}'

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.

Example request

{
  "name": "firms/F-PLAT01/accounts/CUST01-customlabel",
  "user": "firms/F-PLAT01/user/CUST01"
}

Response

A successful response

balancesobject

Example response

{
  "balances": {
    "ETH": {
      "balance": "0.018",
      "capital_requirement": "0",
      "excess_capital": "0.018",
      "buying_power": "0.018",
      "securities": {},
      "total_security_notional_value": "0",
      "total_security_available_value": "0",
      "open_orders": "0",
      "alternate_capital_requirement_currency": "",
      "alternate_capital_requirement": "",
      "unsettled_funds": "0",
      "margin_requirement": "0",
      "update_time": "2026-05-25T13:08:04.873152350Z"
    },
    "USD": {
      "balance": "924.1967811856",
      "capital_requirement": "0",
      "excess_capital": "924.1967811856",
      "buying_power": "924.1967811856",
      "securities": {},
      "total_security_notional_value": "0",
      "total_security_available_value": "0",
      "open_orders": "0",
      "alternate_capital_requirement_currency": "",
      "alternate_capital_requirement": "",
      "unsettled_funds": "0",
      "margin_requirement": "0",
      "update_time": "2026-05-25T13:08:04.873152350Z"
    }
  }
}