Pods Yield
  • Pods Yield
    • Introduction to Pods Yield
  • stETHvv
    • What is stETHvv?
    • Description
    • System Actors
    • How stETHvv Works
      • User Flow
    • stETHvv Timeline
    • Fees
    • 📃Whitepaper
  • security
    • 🛡️Security Overview
    • 🛡️Audits
    • 🐛Bug Bounty Program (BBP)
    • 🔐Access Control
  • Risks
    • Introduction
    • Market Risks
    • Smart Contract Risks
  • Developers
    • Smart Contracts Overview
      • ConfigurationManager
      • EthAdapter
      • STETHVault
      • BaseVault
    • Contracts Addresses
    • Integration guide
      • How to deposit
      • How to withdraw
      • How to read Vault info
  • Connect
    • Brand Assets
  • Appendix
    • FAQ
    • Glossary of Terms
  • 3rd party integrations
    • 3rd party integrations list
  • Additional Resources
    • pods.finance
    • app.pods.finance
    • Pods' other products
    • Github
    • Blog
    • Discord
    • Twitter
Powered by GitBook
On this page
  • 1) Vault information
  • 2) User information
  1. Developers
  2. Integration guide

How to read Vault info

PreviousHow to withdrawNextBrand Assets

Last updated 1 year ago

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).

1) Vault information

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:

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

2) User information

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

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:

The easiest way to fetch this information is through our API: user/<userAddress>

https://yield-backend.pods.finance/strategies/
https://yield-backend.pods.finance/