Skip to main content

Account Updates

Method: WebSocket

Description


Retrieve updates on accounts as they occur in real time.

Response Attributes


NameTypeDescription
idintegerThe id associated with the Trading Account.
accountNamestringThe name of the Trading Account.
nicknamestringThe nickname of the Trading Account.
balancedecimalThe Trading Account's current balance.
unrealizedPnldecimalThe Trading Account's unrealized p&l.
highestUnrealizedBalancedecimalThe Trading Account's highest unrealized balance.
highestRealizedBalancedecimalThe Trading Account's highest realized balance.
realizedDayPnldecimalThe Trading Account's realized day p&l.
statusintegerThe Trading Account's status.
lockoutExpirationdatetimeThe date and time of lockout.
lockoutReasonstringThe reason for the lockout.
dailyTradeLimitintegerThe number of trades allowed per account in a day.
weeklyTradeLimitintegerThe number of trades allowed per account in a week.
latestTradeDateTimedatetimeThe date and time of latest trade.
ineligiblebooleanThe Trading Account's ineligibility flag
maximumLossLimitdecimalThe maximum amount a Trading Account can lose.
dailyLossLimitdecimalThe amount a Trading Account can lose in a day.
updatedAtdatetimeThe date and time of last update for the Trading Account.

Example Usage


Example Response

{
"data": {
"id": 202,
"accountName": "TEST_ACCOUNT",
"nickname": null,
"balance": 147186.78,
"unrealizedPnl": -840.00,
"highestUnrealizedBalance": 151014.10,
"highestRealizedBalance": 150371.90,
"realizedDayPnl": -2454.20,
"status": 0,
"lockoutExpiration": null,
"lockoutReason": null,
"dailyTradeLimit": null,
"weeklyTradeLimit": null,
"latestTradeDateTime": null,
"ineligible": false,
"maximumLossLimit": 145714.50,
"dailyLossLimit": 3000.00,
"updatedAt": "2025-02-25T14:41:35.2143684+00:00"
},
"action": 0 // 0 = create, 1 = update, 2 = delete/remove
}