holdings

List cash balances

Changed on

Retrieve an account's cash balances (one for each supported currency).

get/accounts/{account_id}/cash-balances

Request

  • Base URL
    https://api.engine.usesophic.com
  • Auth
    HTTP bearer

Path parameters

account_idstring required

Response

OK

available_for_tradingstring required

Cash available for placing buy orders.

available_for_withdrawalstring required

Cash available for withdrawal.

currency'EUR' | 'USD' | 'GBP' required
reservedstring required

Cash reserved for pending orders or withdrawals.

totalstring required

Total cash balance across all settlement states.

Example response

[
  {
    "available_for_trading": "10000.00",
    "available_for_withdrawal": "9750.00",
    "reserved": "250.00",
    "total": "12500.00"
  }
]

Changes

    • breaking

      the / response's property type changed from no type to string for status

    • warning

      added the new EUR enum value to the / response property for the response status

    • warning

      added the new GBP enum value to the / response property for the response status

    • warning

      added the new USD enum value to the / response property for the response status

    • info

      removed from the / response property allOf list for the response status

    • breaking

      response property context/additionalProperties/ list-of-types was widened by adding types array to media type application/json of response 400