Get data on single vault

get

Get a vault information given a specific address and network

Authorizations

apiKey

x-api-keystringRequired

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

Object describing the vault

namestringRequired

Name of the vault

addressstringRequired

Address of a vault

networkstring · enumRequired

Network name on which vault exists

Possible values:

protocolstringRequired

Protocol name to which the vault belongs

numberOfHoldersnumber · nullableRequired

Number of holders of vault LP tokens

lendLinkstring · nullableRequired

Lend link of the vault

tagsstring[]Required

Array of tags present on vault

descriptionstring · nullableRequired

Description of the vault

additionalIncentivesstring · nullableRequired

Additional incentives of the vault

isTransactionalbooleanRequired

Boolean indicating if the vault is transactional

assetPriceInUsdnumberRequired

Price of the underlying vault asset in USD with 1e8 precision

holdersTotalBalancestringRequired

Total balance of all holders of vault LP tokens

get

/v1/vaults/{network}/{vaultAddress}/

HTTPcURLJavaScriptPython

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"
}