Get Risk Limits
Retrieve the risk limits for a given entity. Note: Exchange clients accessing this endpoint as a Cross-Margin customer, must pass their designated Exchange UUID as the entity_id path parameter. If you do not have this value, please reach out to your dedicated Technical Account Manager.
Path Parameters
Entity ID
Response
A successful response.
Risk Limit set for a client
"10000.00"
Limit utilization calculated based on total margin and PnLs
"10000.00"
The total margin required for both positions and open orders
"1000.00"
Open Trade Equity accrued during the current trading session
"100.00"
Unsettled realized PNL for positions closed intraday
"10.12"
Unsettled accrued funding PNL from the last settlement
"10.12"
Margin utilization as a decimal percentage between 0 and 1 (e.g. 0.5 means 50%)
"0.50"
The margin health state of an FCM account.
- FCM_MARGIN_HEALTH_STATE_UNSPECIFIED: Unspecified margin health state.
- FCM_MARGIN_HEALTH_STATE_HEALTHY: Account margin is healthy.
- FCM_MARGIN_HEALTH_STATE_RESTRICTED: Account margin is restricted.
- FCM_MARGIN_HEALTH_STATE_PRE_LIQUIDATION: Account is approaching liquidation.
- FCM_MARGIN_HEALTH_STATE_LIQUIDATION: Account is in liquidation.
FCM_MARGIN_HEALTH_STATE_HEALTHY, FCM_MARGIN_HEALTH_STATE_RESTRICTED, FCM_MARGIN_HEALTH_STATE_PRE_LIQUIDATION, FCM_MARGIN_HEALTH_STATE_LIQUIDATION