Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Margin

Get margin risk settings

Returns the margin risk settings for the specified account.

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

Path parameters

accountIdstring required

The ID of the account

Response

Margin risk settings

marginCallPercentagestring

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%)

liquidationThresholdPercentagestring

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%)

marginRequirementPercentagestring

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 response

{
  "totalShortPositionLimit": {
    "quantity": "1000000",
    "currency": "USD"
  },
  "marginCallPercentage": "1.1",
  "liquidationThresholdPercentage": "1.2",
  "marginRequirementPercentage": "0.2",
  "minimumTransferredCollateral": {
    "quantity": "50000",
    "currency": "USD"
  }
}