Ctrl+K

Get margin risk settings

get/api/prime/trading/v1/accounts/{accountId}/margin/risksettings

Returns the margin risk settings for the specified account.

Path Parameters

  • accountIdstringRequired
    The ID of the account

200 Response

totalShortPositionLimit 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"}
quantity string <decimal>required
The specified quantity.
currency string required
The specified quantity currency.
marginCallPercentage string
Number representing the percentage at which a margin call will be initiated if the margin percentage falls below this number. It is in decimal form (eg. 0.8 to mean 80%)
Example: 0.8
Match pattern: ^[0-9]+(\.[0-9]+)?$
liquidationThresholdPercentage string
Number representing the liquidation threshold percentage at which positions will be automatically liquidated if the margin utilization exceeds this level. It is in decimal form (eg. 1.2 to mean 120%)
Example: 1.2
Match pattern: ^[0-9]+(\.[0-9]+)?$
marginRequirementPercentage string
Number representing the margin requirement percentage which is used with the NOP to determine the margin required. It is in decimal form (eg.0.2 for 20%)
Example: 0.2
Match pattern: ^[0-9]+(\.[0-9]+)?$
minimumCollateralValue object
Quantity representing the minimum collateral value required for margin trading. Currency represents the currency that the quantity is valued in (eg. USD)
Example: {"quantity":"100.0","currency":"USD"}
quantity string <decimal>required
The specified quantity.
currency string required
The specified quantity currency.