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. Market data

Get data on single vault

PreviousGet data for multiple vaultsNextGet APY on single vault
get

Get a vault information given a specific address and network

Authorizations
Path parameters
vaultAddressstringRequired

Address of a vault

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

Network name or caip

Possible values:
Responses
200
Object describing the vault
application/json
get
GET //v1/vaults/{network}/{vaultAddress}/ HTTP/1.1
Host: api.vaults.fyi
x-api-key: YOUR_API_KEY
Accept: */*
200

Object describing the vault

{
  "name": "text",
  "address": "text",
  "network": "mainnet",
  "protocol": "text",
  "tvlDetails": {
    "tvlNative": "text",
    "tvlUsd": "text",
    "lockedNative": "text",
    "lockedUsd": "text",
    "liquidNative": "text",
    "liquidUsd": "text"
  },
  "numberOfHolders": 1,
  "lendLink": "text",
  "tags": [
    "text"
  ],
  "token": {
    "name": "text",
    "assetAddress": "text",
    "assetCaip": "text",
    "symbol": "text",
    "decimals": 1
  },
  "apy": {
    "base": {
      "1day": 1,
      "7day": 1,
      "30day": 1
    },
    "rewards": {
      "1day": 1,
      "7day": 1,
      "30day": 1
    },
    "total": {
      "1day": 1,
      "7day": 1,
      "30day": 1
    }
  },
  "description": "text",
  "additionalIncentives": "text",
  "rewards": [
    {
      "apy": {
        "1day": 1,
        "7day": 1,
        "30day": 1
      },
      "assetPriceInUsd": 1,
      "asset": {
        "name": "text",
        "assetAddress": "text",
        "assetCaip": "text",
        "symbol": "text",
        "decimals": 1
      }
    }
  ],
  "isTransactional": true,
  "score": {
    "vaultScore": 1,
    "vaultTvlScore": 1,
    "protocolTvlScore": 1,
    "holderScore": 1,
    "networkScore": 1,
    "assetScore": 1
  },
  "assetPriceInUsd": 1,
  "topHolders": [
    {
      "address": "text",
      "balance": "text"
    }
  ],
  "holdersTotalBalance": "text"
}