vaults.fyi
  • General
    • 🏦Overview
    • 🔎Methodology
      • vaults.fyi USD benchmark rate
      • vaults.fyi ETH benchmark rate
    • ❓FAQ
      • Vault requirements for inclusion on vaults.fyi
  • API
    • vaults.fyi API Overview
      • Insights API
      • Earn API
        • Product demo
        • Flow diagrams
    • Endpoints
      • Market data
        • Get historical data
          • Get historical data on single vault
          • Get historical TVL on single vault
          • Get historical APY on single vault
        • Get data for multiple vaults
        • Get data on single vault
          • Get APY on single vault
        • Get benchmark rates
        • Get supported vaults, networks & tokens
          • /vaults
          • /networks
          • /tokens
          • /tags
      • Contextual insights
        • Top vault options for address
        • Get single top option for address
        • [Etherscan cards] Get top USD, top ETH vault for address
      • Transactional (Earn API)
        • Get supported assets
        • Get supported vaults
        • Get transaction prep details
        • Prepare transaction calldata
          • Deposit
          • Redeem
            • Request redeem
            • Claim redeem
          • Claim rewards
      • Position tracking (Earn API)
        • Get user balances
        • Get user positions
        • Get list of past vault txns by user address
        • Get estimated returns for user's vault position
  • Case Study: Etherscan Cards
  • Links
    • vaults.fyi
    • X
    • Farcaster
    • Wallfacer Labs
Powered by GitBook
On this page
  • Make transactions a breeze
  • Where can I see a demo?
  • How does it work?
  1. API
  2. Endpoints

Transactional (Earn API)

Our Earn API endpoints make it seamless to integrate DeFi experiences into your product by enabling a unified interface across dozens of staking and lending protocols.

  • Transaction execution: prepare transaction details and calldata for deposits, withdrawals, and rewards-related interactions on leading DeFi yield vaults. Additionally, our API simulates transactions and helps protect end users against malicious transactions.

Our Earn API remains entirely non-custodial, preserving your users' autonomy and security. The Earn API simply prepares transaction details and calldata, facilitating the staking/lending process without ever holding or controlling funds.

Make transactions a breeze

  • Supply/Deposit transactions: Use the /v1/transactions/vaults/deposit to prepare transaction details and calldata for deposit transactions. Optionally, this can also return simulations for transactions.

  • Redeem transactions: Use /v1/transactions/vaults/redeem to prepare transaction details and calldata for withdrawals from vaults.

    • for protocols with redemptions requests (e.g. Lido stETH):

      • Request redemption: Utilize the /v1/transactions/vaults/request-redeem endpoint to initiate a redeem request, ensuring you have access to your assets when needed.

      • Claim redemption: Once redemption is ready, use the /v1/transactions/vaults/claim-redeem endpoint to claim your assets seamlessly.

  • Claim rewards: use /v1/transactions/vaults/claim-rewards to prepare transaction details and calldata for claiming rewards accrued by a user for a specified vault.

  • Vault info: Use/v1/transactions/vaults/actions/details to get information about potential and necessary interactions for each lending/staking vault.

Where can I see a demo?

For a brief overview, see our Product demo.

Go to the vaults.fyi app to see the full power of our APIs. Everything on our app is powered by our APIs.

How does it work?

For a simplified overview, view our Flow diagrams. Contact us for API access and to learn more.

Previous[Etherscan cards] Get top USD, top ETH vault for addressNextGet supported assets

Last updated 2 days ago