Skip to main content

LendingMarket

Enriched lending market data as returned by /lending and /pools endpoints. Numeric fields are parsed to number | null.

lenderKeystring

Protocol identifier

Example: AAVE_V3
poolIdstring

Pool/vault address or protocol-specific ID

depositRatenumbernullable

Deposit APR (percent)

variableBorrowRatenumbernullable

Variable borrow APR (percent)

stableBorrowRatenumbernullable

Stable borrow APR (percent)

intrinsicYieldnumbernullable

Intrinsic yield APR from underlying asset (e.g. stETH staking)

totalDepositsnumbernullable

Total deposits in token units

totalDebtStablenumbernullable

Total stable debt in token units

totalDebtnumbernullable

Total variable debt in token units

totalLiquiditynumbernullable

Available liquidity (totalDeposits - totalDebt) in token units

totalDepositsUsdnumbernullable

Total deposits in USD

totalDebtStableUsdnumbernullable

Total stable debt in USD

totalDebtUsdnumbernullable

Total variable debt in USD

totalLiquidityUsdnumbernullable

Available liquidity in USD

utilizationnumbernullable

Utilization ratio (totalDebt / totalDeposits)

decimalsintegernullable
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

caps object

Supply, borrow, and debt ceiling caps for a lending market.

borrowCapnumbernullable

Maximum borrowable amount (token units)

supplyCapnumbernullable

Maximum depositable amount (token units)

debtCeilingstringnullable

Isolation-mode debt ceiling

flags object

Boolean flags describing the operational status of a lending market. Values may be null if unavailable from the protocol.

isActivebooleannullable

Whether the market is active

isFrozenbooleannullable

Whether the market is frozen (no new deposits/borrows)

hasStablebooleannullable

Whether stable-rate borrowing is available

borrowingEnabledbooleannullable

Whether borrowing is enabled

collateralActivebooleannullable

Whether the asset can be used as collateral

rewards object[]

Active reward programs. Defaults to [] when none.

  • Array [
  • assetstring

    Reward token address

    depositRatenumber

    Reward APR on deposits

    variableBorrowRatenumber

    Reward APR on variable borrows

    stableBorrowRatenumber

    Reward APR on stable borrows

  • ]
  • config object

    Risk config keyed by mode/category ID (e.g. "0" for default, "1" for e-mode)

    property name* MarketConfigEntry

    Risk parameters for a specific e-mode or collateral category.

    categoryinteger

    E-mode category ID

    borrowCollateralFactornumber

    LTV for borrowing (0-1)

    Example: 0.8
    collateralFactornumber

    Liquidation threshold (0-1)

    Example: 0.85
    borrowFactornumber

    Borrow factor (typically 1)

    Example: 1
    collateralDisabledboolean
    debtDisabledboolean
    property name*any

    Enriched lending market data as returned by /lending and /pools endpoints. Numeric fields are parsed to number | null.

    LendingMarket
    {
    "lenderKey": "AAVE_V3",
    "poolId": "string",
    "depositRate": 0,
    "variableBorrowRate": 0,
    "stableBorrowRate": 0,
    "intrinsicYield": 0,
    "totalDeposits": 0,
    "totalDebtStable": 0,
    "totalDebt": 0,
    "totalLiquidity": 0,
    "totalDepositsUsd": 0,
    "totalDebtStableUsd": 0,
    "totalDebtUsd": 0,
    "totalLiquidityUsd": 0,
    "utilization": 0,
    "decimals": 0,
    "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
    }
    },
    "caps": {
    "borrowCap": 0,
    "supplyCap": 0,
    "debtCeiling": "string"
    },
    "flags": {
    "isActive": true,
    "isFrozen": true,
    "hasStable": true,
    "borrowingEnabled": true,
    "collateralActive": true
    },
    "rewards": [
    {
    "asset": "string",
    "depositRate": 0,
    "variableBorrowRate": 0,
    "stableBorrowRate": 0
    }
    ],
    "config": {}
    }