Ctrl+K

Get margin risk profile

get/api/prime/trading/v1/accounts/{accountID}/margin/riskprofile

Runs margin calculations and returns the margin risk profile for the specified account.

Path Parameters

  • accountIDstringRequired
    The ID of the account

200 Response

riskProfile object
netOpenPosition object
Quantity representing the total NOP limit across all currencies. It sets a limit that is compared to the total short position across all currencies (eg. 1000000). Currency represents the currency that the quantity is valued in (eg. USD)
Example: {"quantity":"100.0","currency":"USD"}
transferredCollateral object
Quantity representing the notional value of all collateral balances. This may change as the value of collateral changes with market movements. Currency represents the notional currency (eg. USD)
Example: {"quantity":"100.0","currency":"USD"}
unrealizedPnL object
Quantity representing the sum of unrealized profit and loss across all per-asset open positions. Currency represents the notional currency (eg. USD)
Example: {"quantity":"100.0","currency":"USD"}
marginBalance object
Quantity representing the sum of the transferredCollateral and unrealizedPnL. Currency represents the notional currency (eg. USD)
Example: {"quantity":"100.0","currency":"USD"}
marginRequirement object
Quantity representing the marginBalance required to continue trading without risk of margin call or liquidation. If margin requirement is not present, either netOpenPosition is zero or there is no requirement. Currency represents the notional currency (eg. USD)
Example: {"quantity":"100.0","currency":"USD"}
marginUtilizationPercentage
number or null
Quantity representing the ratio of marginRequirement to marginBalance, measured directly against liquidation and margin call thresholds. This is null if there is no margin requirement.