latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Margin

Get margin risk profile

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

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

Path parameters

accountIdstring required

The ID of the account

Response

Margin risk profile

Example response

{
  "riskProfile": {
    "netOpenPosition": {
      "quantity": "1000000",
      "currency": "USD"
    },
    "transferredCollateral": {
      "quantity": "500000",
      "currency": "USD"
    },
    "unrealizedPnL": {
      "quantity": "200000",
      "currency": "USD"
    },
    "marginBalance": {
      "quantity": "700000",
      "currency": "USD"
    },
    "marginRequirement": {
      "quantity": "600000",
      "currency": "USD"
    },
    "marginUtilizationPercentage": "0.85"
  }
}