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

Request

Base URL
https://developers.bitgo.com
URL
https://developers.bitgo.com/api/prime/trading/v1/accounts/{accountId}/margin/riskprofile
Auth
none declared

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"
  }
}

Changes

No operation changes recorded.