Comment on page
How to read Vault info
This page will be braked into 2 sections. One regarding the Vault general information (eg: TVL) and the other regarding the user-specific information (Eg: Balances).
Inside the Vault information, the main info that you will have:
- TVL
- Accumulated Returns (since creation)
- Estimated APY (Get the last 30 days and project this for the year)
- Monthly returns
- Historical transactions
The easiest way to fetch this information is through our API: https://yield-backend.pods.finance/strategies/
There you will find the information needed from all our vaults.
In this table, you can find the relation between the information above and the response keys.
Metric | Object Key Name |
|---|---|
TVL | tvlInTokenDeposited |
Accumulated Returns | lastAccReturn |
Estimated APY | projectedAPY |
Monthly Returns | monthlyReturnsBreakdown |
Historical transactions | not supported yet in the API |
The basic information that you show about the user are:
- Amount Idle (waiting to be processed)
- Amount invested (already processed, waiting to earn yield)
- Historical transactions
The easiest way to fetch this information is through our API: https://yield-backend.pods.finance/user/<userAddress>
In this table, you can find the relation between the information above and the response keys.
Metric | Object Key Name |
|---|---|
Amount idle | idleAmountInTokenDeposited |
Amount invested | investedAmountInTokenDeposited |
Number of shares | totalShares |
Returns | returns |
Historical transactions | actions |
This information is what we show in this part of our app:
Last modified 5mo ago