Accounting

Get Cash Balance Snapshot

Get a snapshot of an account's current cash balance.

Available to: All authenticated users

Environments: Demo, Live

Rate Limit: No endpoint-specific limit

Returns a point-in-time snapshot of an account's cash balance. Identify the account with accountId (the integer entity ID). The response is a CashBalanceSnapshot for that account.

<Tip> Don't poll this endpoint for live balances — calling it repeatedly is an anti-pattern. For real-time cash balance, open a WebSocket and start a [`user/syncRequest`](/api/websockets#user-synchronization) subscription, which pushes balance changes as they happen. </Tip>

Common Failure Scenarios

  • The accountId doesn't exist or isn't owned by the calling user (returns HTTP 404).
  • The access token is missing or invalid (returns HTTP 401).

Error Messages

errorTextTrigger
Non-empty errorTextThe request failed; the field describes the reason.
post/cashBalance/getcashbalancesnapshot

Request

  • Base URL: https://demo.tradovateapi.com/v1
  • URL: https://demo.tradovateapi.com/v1/cashBalance/getcashbalancesnapshot
  • Auth: HTTP bearer

Request body

accountIdinteger required

Response

CashBalanceSnapshot

errorTextstring

Non-empty if the request failed

totalCashValuenumber double
totalPnLnumber double
initialMarginnumber double
maintenanceMarginnumber double
netLiqnumber double
openPnLnumber double
realizedPnLnumber double
weekRealizedPnLnumber double
withdrawalRejectReason'NoData' | 'PendingContactInfoChange'

NoData, PendingContactInfoChange

currencyCashAvailWithdrawalUSDnumber double
netLiqSODnumber double
totalCashValueSODnumber double
cashUSDnumber double
cashSODUSDnumber double
fullInitialMarginnumber double
fullInitialMarginSODnumber double
autoLiqLevelnumber double
fundsInTransitUSDnumber double
fundsInTransitAppliedToCashUSDnumber double

Changes

No recorded changes to this operation across all 1 revision of this API.