Skip to main content

OptimizerPairsResponse

chainIdsstring[]
collateralsstring[]
debtsstring[]
collateralAmountnumber
collateralAmountUsdnumber
debtAmountnumber
debtAmountUsdnumber
startinteger
countinteger
items object[]
  • Array [
  • chainIdstring
    lenderstring
    marketLongUidstring

    Market UID of the collateral side

    marketShortUidstring

    Market UID of the debt side

    marketNameLongstringnullable

    Display name of the collateral market/vault (e.g. the Euler eVault name). Disambiguates rows that share the collateral/debt token symbols and lender.

    marketNameShortstringnullable

    Display name of the debt market/vault. For Euler this is the controller (debt) eVault — the primary way to tell otherwise-identical WETH→USDC rows apart.

    curatorNameLongstringnullable

    Curator/brand of the collateral market (Euler: resolved from the vault governor). Null for lenders without a curator, or until the curator registry is seeded. Render as "curatorName + symbol", falling back to marketNameLong.

    curatorNameShortstringnullable

    Curator/brand of the debt (controller) market. Same semantics as curatorNameLong.

    assetLongstring
    assetShortstring
    assetGroupLongstring
    assetGroupShortstring
    symbolLongstring

    Collateral token symbol

    nameLongstring

    Collateral token name

    symbolShortstring

    Debt token symbol

    nameShortstring

    Debt token name

    aprBasenumber

    Leverage-weighted net APR % EXCLUDING rewards — the SUSTAINABLE rate (reward incentives are typically transient).

    aprTotalnumber

    Leverage-weighted net APR % INCLUDING rewards. The reward contribution is aprTotal − aprBase.

    maxLeveragenumber
    ltvnumber
    depositAprLongnumber

    Effective deposit APR (depositRate + intrinsicYield)

    borrowAprShortnumber

    Effective borrow APR % (borrowRate + intrinsicYield − rewards, plus any 1y-amortized origination fee — see originationFeeShort). For Liquity-family CDPs the amortized origination fee is the whole borrow cost (variable rate is 0).

    originationFeeShortnumbernullable

    One-time origination / mint fee on the debt side, PERCENT (Liquity-family CDPs: River, Felix, Nerite, Ebisu, Soneta, USDAf, Liquity). NOT an APR — it is already folded (1y-amortized) into borrowAprShort / aprTotal, and surfaced raw so consumers can re-amortize over a different holding horizon. Null/absent for markets without one.

    totalDepositsUsdLongnumber
    totalDepositsUsdShortnumber
    totalDebtUsdLongnumber
    totalDebtUsdShortnumber
    totalLiquidityUsdLongnumber
    totalLiquidityUsdShortnumber
    borrowLiquidityShortnumber
    utilizationLongnumber
    utilizationShortnumber
    maxDebtAmountnumber

    Max borrowable amount given collateral (only when collateralAmount/collateralAmountUsd param provided)

    maxDebtAmountUsdnumber

    USD value of maxDebtAmount

    minCollateralAmountnumber

    Min collateral needed for debt amount (only when debtAmount/debtAmountUsd param provided)

    minCollateralAmountUsdnumber

    USD value of minCollateralAmount

    borrowAprAtAmountnumbernullable

    Effective borrow APR % at the computed debt notional: the headline borrowAprShort with only its organic (IRM) component re-priced at the post-borrow utilization (intrinsic + rewards are size-invariant). Present when an amount is supplied; null for non-curve lenders and brokered debt markets.

    depositAprAtAmountnumbernullable

    Effective supply APR % at the collateral notional: the headline depositAprLong with only its organic (IRM) component re-priced at the post-deposit utilization. Present when an amount is supplied; null for non-curve lenders.

    netAprAtAmountnumbernullable

    Leverage-weighted net position APR % on equity at the supplied amount, using the effective legs (INCLUDING rewards). Same components as aprTotal (directly comparable), but at the position's actual size/leverage. Null when equity is non-positive or a leg is unavailable.

    netAprAtAmountBasenumbernullable

    Net APR % at the supplied amount EXCLUDING rewards — the sustainable at-size rate (netAprAtAmount with per-leg rewards stripped). The at-size reward contribution is netAprAtAmount − netAprAtAmountBase. Null when netAprAtAmount is.

    borrowDepthShort objectnullable

    Debt-market rate-vs-amount borrow grid. Only when depth=true.

    property name*anynullable

    Debt-market rate-vs-amount borrow grid. Only when depth=true.

    supplyDepthLong objectnullable

    Collateral-market rate-vs-amount supply grid. Only when depth=true.

    property name*anynullable

    Collateral-market rate-vs-amount supply grid. Only when depth=true.

  • ]
  • OptimizerPairsResponse
    {
    "chainIds": [
    "string"
    ],
    "collaterals": [
    "string"
    ],
    "debts": [
    "string"
    ],
    "collateralAmount": 0,
    "collateralAmountUsd": 0,
    "debtAmount": 0,
    "debtAmountUsd": 0,
    "start": 0,
    "count": 0,
    "items": [
    {
    "chainId": "string",
    "lender": "string",
    "marketLongUid": "string",
    "marketShortUid": "string",
    "marketNameLong": "string",
    "marketNameShort": "string",
    "curatorNameLong": "string",
    "curatorNameShort": "string",
    "assetLong": "string",
    "assetShort": "string",
    "assetGroupLong": "string",
    "assetGroupShort": "string",
    "symbolLong": "string",
    "nameLong": "string",
    "symbolShort": "string",
    "nameShort": "string",
    "aprBase": 0,
    "aprTotal": 0,
    "maxLeverage": 0,
    "ltv": 0,
    "depositAprLong": 0,
    "borrowAprShort": 0,
    "originationFeeShort": 0,
    "totalDepositsUsdLong": 0,
    "totalDepositsUsdShort": 0,
    "totalDebtUsdLong": 0,
    "totalDebtUsdShort": 0,
    "totalLiquidityUsdLong": 0,
    "totalLiquidityUsdShort": 0,
    "borrowLiquidityShort": 0,
    "utilizationLong": 0,
    "utilizationShort": 0,
    "maxDebtAmount": 0,
    "maxDebtAmountUsd": 0,
    "minCollateralAmount": 0,
    "minCollateralAmountUsd": 0,
    "borrowAprAtAmount": 0,
    "depositAprAtAmount": 0,
    "netAprAtAmount": 0,
    "netAprAtAmountBase": 0,
    "borrowDepthShort": {},
    "supplyDepthLong": {}
    }
    ]
    }