Skip to main content
POST
/
agent
/
check-risk
Check risk for a DeFi action
curl --request POST \
  --url https://api.circular.rosetta.sh/api/v1/agent/check-risk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "deposit",
  "marketId": "<string>",
  "amountUsd": 123,
  "walletAddress": "<string>",
  "policy": {
    "minRating": "BBB",
    "maxUtilization": 0.85,
    "maxConcentrationPct": 0.05,
    "requireFreshOracle": true,
    "maxLeverage": 3
  }
}
'
{
  "data": {
    "decision": "ALLOW",
    "reasons": [
      {
        "check": "<string>",
        "severity": "critical",
        "message": "<string>",
        "value": "<unknown>",
        "threshold": "<unknown>"
      }
    ],
    "market": {
      "name": "<string>",
      "rating": "<string>",
      "riskScore": 123,
      "utilization": 123,
      "tvl": 123,
      "supplyApy": 123,
      "borrowApy": 123
    },
    "position": {
      "healthFactor": 123,
      "currentLeverage": 123,
      "distanceToLiq": 123
    },
    "alternative": {
      "marketId": "<string>",
      "name": "<string>",
      "rating": "<string>",
      "riskScore": 123,
      "supplyApy": 123,
      "borrowApy": 123,
      "tvl": 123,
      "utilization": 123,
      "chainId": 123,
      "protocol": "<string>",
      "reason": "<string>"
    },
    "alternatives": [
      {
        "marketId": "<string>",
        "name": "<string>",
        "rating": "<string>",
        "riskScore": 123,
        "supplyApy": 123,
        "borrowApy": 123,
        "tvl": 123,
        "utilization": 123,
        "chainId": 123,
        "protocol": "<string>",
        "reason": "<string>"
      }
    ],
    "meta": {
      "latencyMs": 123,
      "policyApplied": {
        "minRating": "BBB",
        "maxUtilization": 0.85,
        "maxConcentrationPct": 0.05,
        "requireFreshOracle": true,
        "maxLeverage": 3
      },
      "checksRun": [
        "<string>"
      ],
      "timestamp": "2023-11-07T05:31:56Z"
    }
  },
  "meta": {
    "latencyMs": 123,
    "freshness": "<string>",
    "source": "<string>"
  }
}

Authorizations

Authorization
string
header
required

API key in format circ_live_* or circ_test_*

Body

application/json
action
enum<string>
required
Available options:
deposit,
borrow,
withdraw,
swap
marketId
string
required
amountUsd
number
required
walletAddress
string
policy
object

Response

Risk check result

data
object
meta
object