UserSubAccount

Position data for a single sub-account within a lender.

accountIdstringrequired

Sub-account identifier (e.g., "0" for default, NFT ID for Init)

Example: 0

healthnumbernullable

Health factor (null if no debt). Values > 1 are healthy, < 1 at risk of liquidation.

Example: 1.85

borrowCapacityUSDnumber

Total USD borrowable while maintaining health >= 1

Example: 3000

balanceData objectrequired

Aggregated balance data for a sub-account.

depositsnumber

Total deposits in USD

Example: 10000.5

debtnumber

Total debt in USD

Example: 5000.25

adjustedDebtnumber

Debt adjusted for borrow factors

Example: 5500

collateralnumber

Collateral value in USD

Example: 9000

collateralAllActivenumber

Collateral if all assets were enabled

Example: 10000.5

borrowDiscountedCollateralnumber

Collateral discounted by borrow factors

Example: 8000

borrowDiscountedCollateralAllActivenumber

Discounted collateral if all enabled

Example: 9000

navnumber

Net asset value (deposits - debt)

Example: 5000.25

deposits24hnumber

Deposits 24h ago (for change calculation)

Example: 9800

debt24hnumber

Debt 24h ago

Example: 4900

nav24hnumber

NAV 24h ago

Example: 4900

rewards object[]nullable

Pending reward token claims. Each entry represents a single reward program.

Array [

assetstring

Reward token contract address

Example: 0xc00e94Cb662C3520282E6f5717214004A7f26888

totalRewardsnumber

Total accumulated rewards (token units)

Example: 12.5

claimableRewardsnumber

Immediately claimable rewards (token units)

Example: 12.5

]

aprData objectrequired

APR breakdown for a sub-account.

aprnumber

Net APR (deposit - borrow)

Example: 2.5

depositAprnumber

Weighted deposit APR

Example: 3.5

borrowAprnumber

Weighted borrow APR

Example: 5.2

rewardAprnumber

Total reward APR

Example: 1.2

rewardDepositAprnumber

Reward APR on deposits

Example: 0.8

rewardBorrowAprnumber

Reward APR on borrows

Example: 0.4

intrinsicAprnumber

Intrinsic yield APR (e.g., stETH staking)

Example: 0

intrinsicDepositAprnumber

Intrinsic yield APR portion from deposits

Example: 0

intrinsicBorrowAprnumber

Intrinsic yield APR portion from borrows

Example: 0

rewards object

Per-reward-token APR breakdown. Keys are reward token addresses.

property name* RewardAprBreakdown

APR breakdown for a single reward token.

aprnumber

Net reward APR (normalized to NAV)

Example: 0.045

borrowAprnumber

Reward APR on borrows

Example: 0.012

depositAprnumber

Reward APR on deposits

Example: 0.078

positions object[]required

Individual asset positions in this sub-account

Array [

marketUidstring

Unique market identifier (format: {lender}:{chainId}:{address})

Example: AAVE_V3:1:0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2

depositsstring

Deposit amount in token units (wei)

Example: 1000000000000000000

debtstring

Variable debt in token units

Example: 0

debtStablestring

Stable debt in token units

Example: 0

debtSharesstring

Debt share amount (protocol-specific, present when the protocol uses share-based accounting)

Example: 0

depositSharesstring

Deposit share amount (protocol-specific, present when the protocol uses share-based accounting)

Example: 0

depositsUSDnumber

Deposits in USD (market price)

Example: 2500

debtUSDnumber

Variable debt in USD (market price)

Example: 0

debtStableUSDnumber

Stable debt in USD (market price)

Example: 0

depositsUSDOraclenumber

Deposits in USD using on-chain oracle price (used for risk/health calculations)

Example: 2510

debtUSDOraclenumber

Variable debt in USD using on-chain oracle price

Example: 0

debtStableUSDOraclenumber

Stable debt in USD using on-chain oracle price

Example: 0

collateralEnabledboolean

Whether this asset is enabled as collateral

Example: true

claimableRewardsnumber

Claimable rewards in USD

Example: 0.5

withdrawablestring

Max tokens withdrawable while maintaining health >= 1. Equals full deposit balance if collateral is not enabled.

Example: 0.5

borrowablestring

Max tokens borrowable against remaining credit line. Zero if borrowing is disabled, reserve is frozen, or debt is disabled for the active mode.

Example: 100

underlyingInfo object

Nested asset metadata, oracle prices, and market prices for a lending market.

asset object

Token metadata for an underlying asset.

chainIdstring

Example: 1

addressstring

Token contract address (lowercase)

Example: 0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48

symbolstring

Example: USDC

namestring

Example: USD Coin

decimalsintegernullable

Example: 6

logoURIstringnullable

assetGroupstringnullable

Canonical asset group (e.g. "USDC", "ETH", "BTC")

Example: USDC

currencyIdstringnullable

props objectnullable

Protocol-specific asset properties

property name*anynullable

Protocol-specific asset properties

oraclePrice object

On-chain oracle price data.

oraclePricenumbernullable

Raw on-chain oracle price

oraclePriceUsdnumbernullable

Oracle price denominated in USD

prices object

Market prices for an asset with 24h comparison.

priceUsdnumbernullable

Current price in USD

priceTsstring<date-time>nullable

Timestamp of current price

priceUsd24hnumbernullable

Price 24 hours ago in USD

priceTs24hstring<date-time>nullable

Timestamp of 24h-ago price

priceChange24hnumbernullable

Percentage price change over 24h

]

userConfig objectrequired

User configuration for a sub-account.

selectedModestring

Mode/config key (e.g. e-mode category or vault address)

Example: 0

idstring

Config identifier

Example: 0

isWhitelistedboolean

Whether user is whitelisted (for permissioned markets)

UserSubAccount

{
  "accountId": "0",
  "health": 1.85,
  "borrowCapacityUSD": 3000,
  "balanceData": {
    "deposits": 10000.5,
    "debt": 5000.25,
    "adjustedDebt": 5500,
    "collateral": 9000,
    "collateralAllActive": 10000.5,
    "borrowDiscountedCollateral": 8000,
    "borrowDiscountedCollateralAllActive": 9000,
    "nav": 5000.25,
    "deposits24h": 9800,
    "debt24h": 4900,
    "nav24h": 4900,
    "rewards": [
      {
        "asset": "0xc00e94Cb662C3520282E6f5717214004A7f26888",
        "totalRewards": 12.5,
        "claimableRewards": 12.5
      }
    ]
  },
  "aprData": {
    "apr": 2.5,
    "depositApr": 3.5,
    "borrowApr": 5.2,
    "rewardApr": 1.2,
    "rewardDepositApr": 0.8,
    "rewardBorrowApr": 0.4,
    "intrinsicApr": 0,
    "intrinsicDepositApr": 0,
    "intrinsicBorrowApr": 0,
    "rewards": {}
  },
  "positions": [
    {
      "marketUid": "AAVE_V3:1:0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
      "deposits": "1000000000000000000",
      "debt": "0",
      "debtStable": "0",
      "debtShares": "0",
      "depositShares": "0",
      "depositsUSD": 2500,
      "debtUSD": 0,
      "debtStableUSD": 0,
      "depositsUSDOracle": 2510,
      "debtUSDOracle": 0,
      "debtStableUSDOracle": 0,
      "collateralEnabled": true,
      "claimableRewards": 0.5,
      "withdrawable": "0.5",
      "borrowable": "100",
      "underlyingInfo": {
        "asset": {
          "chainId": "1",
          "address": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
          "symbol": "USDC",
          "name": "USD Coin",
          "decimals": 6,
          "logoURI": "string",
          "assetGroup": "USDC",
          "currencyId": "string",
          "props": {}
        },
        "oraclePrice": {
          "oraclePrice": 0,
          "oraclePriceUsd": 0
        },
        "prices": {
          "priceUsd": 0,
          "priceTs": "2024-07-29T15:51:28.071Z",
          "priceUsd24h": 0,
          "priceTs24h": "2024-07-29T15:51:28.071Z",
          "priceChange24h": 0
        }
      }
    }
  ],
  "userConfig": {
    "selectedMode": "0",
    "id": "0",
    "isWhitelisted": true
  }
}