View Risk Settings and Profile

View your margin risk profile and risk settings to make informed trading decisions. See the Guide.

  1. View your margin risk profile to make informed trading decisions and help prevent a margin call or liquidation. Your risk profile includes your net open position, transferred collateral, unrealized PnL, margin balance, margin requirement, and margin utilization percentage.

    Prerequisites: You must have created wallets and deposited assets.

    API Reference

  2. View your risk settings, which are limits determined by BitGo. These include your total short position limit, margin call percentage, liquidation threshold percentage, margin requirement percentage, and minimum transferred collateral.

    API Reference

// 1. View Risk Profile
export ACCOUNT_ID="<YOUR_ACCOUNT_ID>"
export ACCESS_TOKEN="<YOUR_ACCESS_TOKEN>"
curl -X GET \
  https://app.bitgo-test.com/api/prime/trading/v1/accounts/$ACCOUNT_ID/margin/riskprofile \
  -H 'Content-Type: application/json' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

// 2. View Risk Settings
export ACCOUNT_ID="<YOUR_ACCOUNT_ID>"
export ACCESS_TOKEN="<YOUR_ACCESS_TOKEN>"
curl -X GET \
  https://app.bitgo-test.com/api/prime/trading/v1/accounts/$ACCOUNT_ID/margin/risksettings \
  -H 'Content-Type: application/json' \
  -H "Authorization: Bearer $ACCESS_TOKEN"
Response 
// 1. View Risk Profile 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
  }
}

// 2. View Risk Settings Response
{
  "totalShortPositionLimit": {
    "quantity": "1000000",
    "currency": "USD"
  },
  "marginCallPercentage": "1.1",
  "liquidationThresholdPercentage": "1.2",
  "marginRequirementPercentage": "0.2",
  "minimumTransferredCollateral": {
    "quantity": "50000",
    "currency": "USD"
  }
}