ZEzerohash
CLOB

Get account balance

Changed on

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

post/orders/v1/get_account_balance

Request

  • Base URL
    https://api.cert.zerohash.com
  • URL
    https://api.cert.zerohash.com/orders/v1/get_account_balance
  • Auth
    API key in header X-SCX-API-KEY and API key in header X-SCX-PASSPHRASE

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

OR
OR

Example request

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

Response

A successful response

balancestring

Current account balance

capital_requirementstring

Capital requirement for the account

excess_capitalstring

Excess capital available in the account

buying_powerstring

Buying power available in the account

securitiesobject
total_security_notional_valuestring
total_security_available_valuestring
open_ordersstring
alternate_capital_requirement_currencystring
alternate_capital_requirementstring
unsettled_fundsstring
margin_requirementstring
update_timestring date-time

The time at which the balance was last updated

Example response

{
  "balance": "547280.56",
  "capital_requirement": "0",
  "excess_capital": "547280.56",
  "buying_power": "547280.56",
  "securities": {},
  "total_security_notional_value": "0",
  "total_security_available_value": "0",
  "open_orders": "0",
  "unsettled_funds": "0",
  "margin_requirement": "0",
  "update_time": "2024-04-19T22:48:56.383Z"
}

Changes

  • 47cf70ae701cRevision changes
    • breaking

      removed subschema #1: Request Participants Balance subschema #2: Request Platform Float Account Balance subschema #3: Request Platform Commission Account Balance from the request body oneOf list

    • info

      added subschema #1: Request Participants Balance subschema #2: Request Platform Float Account Balance subschema #3: Request Platform Commission Account Balance to the request body anyOf list