Get Cash Balance Snapshot | Partner Developer Platform

const url = 'https://demo-d.tradovateapi.com/v1/cashBalance/getcashbalancesnapshot';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"accountId":1}'
};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "errorText": "string",
  "totalCashValue": 1.1,
  "totalPnL": 1.1,
  "initialMargin": 1.1,
  "maintenanceMargin": 1.1,
  "netLiq": 1.1,
  "openPnL": 1.1,
  "realizedPnL": 1.1,
  "weekRealizedPnL": 1.1,
  "withdrawalRejectReason": "NoData",
  "currencyCashAvailWithdrawalUSD": 1.1,
  "netLiqSOD": 1.1,
  "totalCashValueSOD": 1.1,
  "cashUSD": 1.1,
  "cashSODUSD": 1.1,
  "fullInitialMargin": 1.1,
  "fullInitialMarginSOD": 1.1,
  "autoLiqLevel": 1.1
}

### 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.

const url = 'https://demo-d.tradovateapi.com/v1/cashBalance/getcashbalancesnapshot';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"accountId":1}'
};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "errorText": "string",
  "totalCashValue": 1.1,
  "totalPnL": 1.1,
  "initialMargin": 1.1,
  "maintenanceMargin": 1.1,
  "netLiq": 1.1,
  "openPnL": 1.1,
  "realizedPnL": 1.1,
  "weekRealizedPnL": 1.1,
  "withdrawalRejectReason": "NoData",
  "currencyCashAvailWithdrawalUSD": 1.1,
  "netLiqSOD": 1.1,
  "totalCashValueSOD": 1.1,
  "cashUSD": 1.1,
  "cashSODUSD": 1.1,
  "fullInitialMargin": 1.1,
  "fullInitialMarginSOD": 1.1,
  "autoLiqLevel": 1.1
}

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

errorTextstring<=8192 characters

Non-empty if the request failed

totalCashValuedouble

totalPnLdouble

initialMargindouble

maintenanceMargindouble

netLiqdouble

openPnLdouble

realizedPnLdouble

weekRealizedPnLdouble

withdrawalRejectReasonenum

NoData, PendingContactInfoChange

Allowed values:

currencyCashAvailWithdrawalUSDdouble

netLiqSODdouble

totalCashValueSODdouble

cashUSDdouble

cashSODUSDdouble

fullInitialMargindouble

fullInitialMarginSODdouble

autoLiqLeveldouble

1	const url = 'https://demo-d.tradovateapi.com/v1/cashBalance/getcashbalancesnapshot';
2	const options = {
3	method: 'POST',
4	headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5	body: '{"accountId":1}'
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	}

1	{
2	"errorText": "string",
3	"totalCashValue": 1.1,
4	"totalPnL": 1.1,
5	"initialMargin": 1.1,
6	"maintenanceMargin": 1.1,
7	"netLiq": 1.1,
8	"openPnL": 1.1,
9	"realizedPnL": 1.1,
10	"weekRealizedPnL": 1.1,
11	"withdrawalRejectReason": "NoData",
12	"currencyCashAvailWithdrawalUSD": 1.1,
13	"netLiqSOD": 1.1,
14	"totalCashValueSOD": 1.1,
15	"cashUSD": 1.1,
16	"cashSODUSD": 1.1,
17	"fullInitialMargin": 1.1,
18	"fullInitialMarginSOD": 1.1,
19	"autoLiqLevel": 1.1
20	}