Get Cash Balance Snapshot

POST

https://demo.tradovateapi.com/v1/cashBalance/getcashbalancesnapshot

POST

/v1/cashBalance/getcashbalancesnapshot

1 const url = 'https://demo.tradovateapi.com/v1/cashBalance/getcashbalancesnapshot';
2 const options = {
3   method: 'POST',
4   headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5   body: '{"accountId":123456}'
6 };
7 
8 try {
9   const response = await fetch(url, options);
10   const data = await response.json();
11   console.log(data);
12 } catch (error) {
13   console.error(error);
14 }

200Successful

1 {
2   "errorText": "",
3   "totalCashValue": 25400.75,
4   "totalPnL": 1250.5,
5   "initialMargin": 5000,
6   "maintenanceMargin": 3500,
7   "netLiq": 26900.25,
8   "openPnL": 750.25,
9   "realizedPnL": 500.25,
10   "weekRealizedPnL": 300,
11   "withdrawalRejectReason": "NoData",
12   "currencyCashAvailWithdrawalUSD": 20000,
13   "netLiqSOD": 26000,
14   "totalCashValueSOD": 25000,
15   "cashUSD": 15000,
16   "cashSODUSD": 14500,
17   "fullInitialMargin": 5200,
18   "fullInitialMarginSOD": 5100,
19   "autoLiqLevel": 1500
20 }

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

Note: Using this endpoint many times in succession is an anti-pattern. If you need to check a cashBalance in real-time, instead use a WebSocket connected to the standard Tradovate WebSocket URL and initialize a real-time user data subscription via the user/syncrequest endpoint.

### Get a snapshot of an account's current cash balance. > *Note*: Using this endpoint many times in succession is an anti-pattern. If you need to check a `cashBalance` in real-time, instead use a WebSocket connected to the standard Tradovate WebSocket URL and initialize a real-time user data subscription via the `user/syncrequest` endpoint.

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