Get Cash Balance Snapshot

View as Markdown
### Get a snapshot of an account's current cash balance. **Available to:** All authenticated users **Environments:** Demo, Live **[Rate Limit](/api/authentication#request-rate-limits-and-time-penalties):** 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** | `errorText` | Trigger | |-------------|---------| | Non-empty `errorText` | The request failed; the field describes the reason. |

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
accountIdlongRequired

Response

CashBalanceSnapshot
errorTextstringOptional<=8192 characters

Non-empty if the request failed

totalCashValuedoubleOptional
totalPnLdoubleOptional
initialMargindoubleOptional
maintenanceMargindoubleOptional
netLiqdoubleOptional
openPnLdoubleOptional
realizedPnLdoubleOptional
weekRealizedPnLdoubleOptional
withdrawalRejectReasonenumOptional
NoData, PendingContactInfoChange
currencyCashAvailWithdrawalUSDdoubleOptional
netLiqSODdoubleOptional
totalCashValueSODdoubleOptional
cashUSDdoubleOptional
cashSODUSDdoubleOptional
fullInitialMargindoubleOptional
fullInitialMarginSODdoubleOptional
autoLiqLeveldoubleOptional
fundsInTransitUSDdoubleOptional
fundsInTransitAppliedToCashUSDdoubleOptional