Skip to navigation
REST API EndpointsRisks

Account Risk Status List

View as Markdown

Return the current risk and liquidation status for your accounts.

Environments: Demo, Live

Rate Limit: No endpoint-specific limit

Returns an AccountRiskStatus entity for each account you can access. This is the quickest way to check where an account currently stands with auto-liquidation. Key fields include:

  • adminAction: the account’s current status (for example, Normal or LiquidateImmediately)
  • adminActionReasonCode: the reason code for that status
  • autoLiqStarted and autoLiqStopped: the start and stop timestamps of the most recent auto-liquidation period
  • autoLiqCounter: how many times the account has been auto-liquidated

To monitor status continuously, subscribe to the accountRiskStatus entity type over a WebSocket instead of polling this endpoint. See User Synchronization for receiving entity updates in real time. For the risk settings that drive these statuses, see Post-Trade Risk.

Authentication

AuthorizationBearer

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

Response

AccountRiskStatus
idlongOptional
adminActionenumOptional
AgreedOnLiqOnlyModeByAutoLiq, AgreedOnLiquidationByAutoLiq, DisableAutoLiq, LiquidateImmediately, LiquidateOnlyModeImmediately, LockTradingImmediately, Normal, PlaceAutoLiqOnHold
adminTimestampdatetimeOptional
liquidateOnlydatetimeOptional
userTriggeredLiqOnlybooleanOptional
maxNetLiqdoubleOptional

$ Max Net Liq

minNetLiqdoubleOptional

$ Min Net Liq