| layout | title | permalink | description |
|---|---|---|---|
page |
Yearn API |
/Yearn-API/ |
Describes the Yearn Exporter Metrics and what the outputs mean. This guide assumes your using Docker thus the metric will show at localhost:8800/metrics |
This metric holds v1 vaults' info.
Amount of shares that are free to withdrawal without a fee. (Liquidity in Vault - Invested in all Strategies)
boost
Current Boost.
crv apy
Lowest amount of CRV APY generated with 0 boost.
crv price
The current price of CRV.
crv reward rate
Curve APY * Boost?
earned
Current amount of accumulated CRV rewards.
gauge balance
Amount of LP tokens deposited in the gauge. ?
gauge total
Total deposited in the gauge.
inflation rate
max boost
Max boost you can get with that % of the gauge.
min vecrv
How much veCRV you need to get max boost.
relative weight
% of all CRV rewards this curve pool gets. This weeks weights can also be viewed here and the future weights for next week can be viewed here.
share price
getPricePerFullShare()/1e18.
strategy balance
Current amount of lp tokens allocated to the strategy.
strategy buffer
From 0 to 1: with 1 meaning the vault has all liquidity allocated to strategies. ? (minus some percent 5%?)
token price
Base price * virtual_price. This is meant to provide a balance price incase the vault's base price for some reason didn't start at 1.
vault balance
Total amount of shares in the vault. ( Shares invested in Strategy + Shares not invested in Strategy)
vault total
Total amount of shares in the whole vault
vecrv balance
Yearn total veCRV voting power.
vecrv total
Total voting power of the Curve Dao.
virtual price
Price of the underlying curve pool
working balance
(Gauge balance / (2.5 * Boost)) - Balance which is being rewarded.
working total
Total balance which is rewarded, from which you can calculate avg boost.
The vault's address. Deprecated for v1 vaults as "n/a"
This is the vault version deprecated for v1 vaults as "n/a"
This is the metrics for v2 vaults
This will show "n/a" if address doesn't exist or the vault is special else it will show the vaults contract address.
Bool: True or False
Is vault non-production or production.
totalAssets
The total quantity of all assets under control of this Vault, whether they're loaned out to a Strategy, or currently held in the Vault.
totalBalanceSheet
Provides an accurate estimate for the total amount of assets (principle + return) that the strategies are currently managing, denominated in terms of ?.
maxAvailableShares
Determines the total quantity of shares this Vault can provide, factoring in assets currently residing in the Vault, as well as those deployed to strategies.
pricePerShare
Price for a single vault share - returns the price of the Vault’s wrapped token, denominated in the unwrapped native token. More info here
debtOutstanding
Total debt the whole vault has outstanding
creditAvailable
expectedReturn
totalSupply
emergencyShutdown
True or false: 0 = false 1 = true more info here.
depositLimit
Max amount of tokens able to be deposited in this vault in lp shares.
debtLimit
Current max debt limit the vault is able to take on across all strategies
totalDebt
lastReport
Last time a strategy harvested in unix time
managementFee
performanceFee
version type: v1 or v2 or n/a. For yearn_vault this should all be v2.
Metrics for v2 strategies and their smart contract methods
This is the address of the strategy's vault.
Bool: True or False
Is vault non-production or production.
debtOutstanding
creditAvailable
expectedReturn
emergencyExit
estimatedTotalAssets
performanceFee
activation
debtLimit
rateLimit
lastReport
totalDebt
totalReturns
collateralTarget
getCompValInWei
getCurrentPosition_supply
getCurrentPosition_borrow
getblocksUntilLiquidation
netBalanceLent
predictCompAccrued
storedCollateralisation
wantPrice
The name of the strategy pulled from the contract name function.
The name of the vault affixed with the vault version number
The vault version number usually "v2" could be "n/a" for special vaults.
Metrics for Earn
Metrics for Cream v2 aka Ironbank
total supply
The total amount of tokens deposited for lending
total cash
total supplied
``
total borrows
``
total reserves
``
exchange rate
``
token price
underlying price
The underlying price of the deposit asset in USD
supply apy
The Annual Percentage Yield gained to supply the asset
borrow apy
The Annual Percentage Yield being paid to borrow the asset
utilizzation
Ratio of Lent / Supplied Assets from 0 to 1.
tvl
Total Value Locked for that lending assets in USD.