vaults.fyi
  • General
    • ๐ŸฆOverview
    • ๐Ÿ’กUse Cases
      • For Wallets and Apps
      • For Analysts
      • For Protocols & Product Teams
    • ๐Ÿ”ŽMethodology
      • vaults.fyi USD benchmark rate
      • vaults.fyi ETH benchmark rate
    • โ“FAQ
      • Vault requirements for inclusion on vaults.fyi
    • ๐Ÿค–AI
  • API
    • vaults.fyi API Overview
      • Insights API
      • Earn API
        • Product demo
        • Flow diagrams
      • Plans
        • Credits
    • Endpoints
      • Market data
        • Get historical data
          • Get historical APY and TVL data on single vault over timestamp range
          • Get historical APY on single vault over timestamp range
          • Get historical TVL on single vault at single timestamp
          • Get historical APY on single vault at single timestamp
        • 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
      • Generate payloads (Earn API)
        • Prepare calldata
          • Supply/Deposit
          • Withdraw/Redeem
            • Request redeem
            • Claim redeem
          • Claim rewards
        • Get contract interaction details
        • Get supported assets
        • Get supported vaults
      • Position tracking (Portfolio 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 Studies
    • Kraken Wallet
    • Etherscan Cards
  • Links
    • vaults.fyi
    • X
    • Farcaster
    • Wallfacer Labs
Powered by GitBook
On this page
  1. API
  2. Endpoints
  3. Contextual insights

[Etherscan cards] Get top USD, top ETH vault for address

PreviousGet single top option for addressNextGenerate payloads (Earn API)

Last updated 2 months ago

This endpoint is used to power Etherscan Cards

get

Get the best vault for the user

Authorizations
Path parameters
userAddressstringRequired

User wallet address

Pattern: ^0x[a-fA-F0-9]{40}$
networkstring ยท enumRequired

Network name or caip

Possible values:
Responses
200
Default Response
application/json
get
GET //v1/top-vault/{network}/{userAddress} HTTP/1.1
Host: api.vaults.fyi
x-api-key: YOUR_API_KEY
Accept: */*
200

Default Response

{
  "userAddress": "text",
  "bestVault": {
    "name": "text",
    "protocol": {
      "name": "text",
      "product": "text",
      "version": "text"
    },
    "vaultAddress": "text",
    "networkName": "mainnet",
    "tvlInUsd": 1,
    "apy": 1,
    "projectedEarnings": 1,
    "asset": {
      "assetAddress": "text",
      "decimals": 1,
      "name": "text",
      "symbol": "text"
    }
  },
  "bestEthVault": {
    "name": "text",
    "protocol": {
      "name": "text",
      "product": "text",
      "version": "text"
    },
    "vaultAddress": "text",
    "networkName": "mainnet",
    "tvlInUsd": 1,
    "apy": 1,
    "projectedEarnings": 1
  }
}