Detailed Vaults

get

Retrieves a detailed performance metrics of single vault including APY, TVL, rewards, risk scores, and protocol information based on specified filters.

Authorizations

apiKey

x-api-keystringRequired

Path parameters

networkstring · enumRequired

Include only vaults with provided network(name or CAIP)

Possible values:

vaultAddressstringRequired

Address of the vault for which the data will be returned

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

Responses

200

Default Response

application/json

addressstringRequired

Address of the vault

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

isTransactionalbooleanRequired

Indicates if the vault supports transactional endpoints

isAppFeaturedbooleanRequired

Indicates if the vault is featured in app.vaults.fyi

namestringRequired

Name of the vault

lendUrlstringOptional

URL to lend the asset

descriptionstringOptional

Description of the vault

protocolVaultUrlstringOptional

URL to the protocol vault

tagsstring[]Required

Tags of the vault

lastUpdateTimestampintegerRequired

Timestamp of the last vault data update

additionalIncentivesstringOptional

Additional incentives of the vault

remainingCapacitystringOptional

Remaining capacity of the vault

maxCapacitystringOptional

Maximum capacity limit of the vault

isCorruptedbooleanRequired

Indicates if the vault is corrupted

warningsstring[]Required

List of warnings related to the vault

400

Default Response

application/json

401

Default Response

application/json

402

Default Response

application/json

403

Default Response

application/json

404

Default Response

application/json

408

Default Response

application/json

500

Default Response

application/json

503

Default Response

application/json

get

/v2/detailed-vaults/{network}/{vaultAddress}

HTTPcURLJavaScriptPython

GET /v2/detailed-vaults/{network}/{vaultAddress} HTTP/1.1
Host: api.vaults.fyi
x-api-key: YOUR_API_KEY
Accept: */*

{
  "address": "text",
  "network": {
    "name": "mainnet",
    "chainId": 1,
    "networkCaip": "text"
  },
  "asset": {
    "address": "text",
    "assetCaip": "text",
    "name": "text",
    "symbol": "text",
    "decimals": 1,
    "assetLogo": "https://example.com",
    "assetPriceInUsd": "text",
    "assetGroup": "text"
  },
  "isTransactional": true,
  "isAppFeatured": true,
  "name": "text",
  "protocol": {
    "name": "text",
    "product": "text",
    "version": "text",
    "protocolUrl": "text",
    "description": "text",
    "protocolLogo": "text"
  },
  "lendUrl": "text",
  "description": "text",
  "protocolVaultUrl": "text",
  "tags": [
    "text"
  ],
  "holdersData": {
    "totalCount": 1,
    "totalBalance": "text",
    "topHolders": [
      {
        "address": "text",
        "lpTokenBalance": "text"
      }
    ]
  },
  "apy": {
    "1day": {
      "base": 1,
      "reward": 1,
      "total": 1
    },
    "7day": {
      "base": 1,
      "reward": 1,
      "total": 1
    },
    "30day": {
      "base": 1,
      "reward": 1,
      "total": 1
    },
    "1hour": {
      "base": 1,
      "reward": 1,
      "total": 1
    }
  },
  "tvl": {
    "usd": "text",
    "native": "text"
  },
  "lastUpdateTimestamp": 1,
  "rewards": [
    {
      "asset": {
        "address": "text",
        "assetCaip": "text",
        "name": "text",
        "symbol": "text",
        "decimals": 1,
        "assetLogo": "https://example.com",
        "assetPriceInUsd": "text",
        "assetGroup": "text"
      },
      "apy": {
        "1hour": 1,
        "1day": 1,
        "7day": 1,
        "30day": 1
      }
    }
  ],
  "score": {
    "vaultScore": 1,
    "vaultTvlScore": 1,
    "protocolTvlScore": 1,
    "holderScore": 1,
    "networkScore": 1,
    "assetScore": 1
  },
  "additionalIncentives": "text",
  "curator": {
    "name": "text",
    "description": "text",
    "websiteUrl": "text"
  },
  "lpToken": {
    "address": "text",
    "tokenCaip": "text",
    "name": "text",
    "symbol": "text",
    "decimals": 1
  },
  "remainingCapacity": "text",
  "maxCapacity": "text",
  "isCorrupted": true,
  "childrenVaults": [
    {
      "address": "text",
      "asset": {
        "address": "text",
        "assetCaip": "text",
        "name": "text",
        "symbol": "text",
        "decimals": 1,
        "assetLogo": "https://example.com",
        "assetPriceInUsd": "text",
        "assetGroup": "text"
      },
      "lpToken": {
        "address": "text",
        "tokenCaip": "text",
        "name": "text",
        "symbol": "text",
        "decimals": 1
      },
      "additionalAssets": [
        {
          "address": "text",
          "assetCaip": "text",
          "name": "text",
          "symbol": "text",
          "decimals": 1,
          "assetLogo": "https://example.com",
          "assetPriceInUsd": "text",
          "assetGroup": "text"
        }
      ]
    }
  ],
  "additionalAssets": [
    {
      "address": "text",
      "assetCaip": "text",
      "name": "text",
      "symbol": "text",
      "decimals": 1,
      "assetLogo": "https://example.com",
      "assetPriceInUsd": "text",
      "assetGroup": "text"
    }
  ],
  "transactionalProperties": {
    "depositStepsType": "instant",
    "redeemStepsType": "instant",
    "rewardsSupported": true
  },
  "fees": {
    "performanceFee": 1,
    "managementFee": 1,
    "withdrawalFee": 1,
    "depositFee": 1
  },
  "warnings": [
    "text"
  ]
}

get

Retrieves a comprehensive list of vaults with detailed performance metrics including APY, TVL, rewards, risk scores, and protocol information based on specified filters.

Authorizations

apiKey

x-api-keystringRequired

Query parameters

pageintegerOptional

Page number (starting from 0)

Default: 0

perPageinteger · max: 5000Optional

Number of items per page

Default: 50

allowedAssetsstring[]Optional

Assets to be included by symbol(ticker).

disallowedAssetsstring[]Optional

Assets to be excluded by symbol(ticker). The parameter is ignored if "allowedAssets" is specified.

allowedProtocolsstring[]Optional

Protocols to be included by name.

disallowedProtocolsstring[]Optional

Protocols to be excluded by name. The parameter is ignored if "allowedProtocols" is specified.

minTvlintegerOptional

Minimum TVL in USD of the vaults to be included

Default: 100000

onlyTransactionalbooleanOptional

Include only vaults that are supported in the transactional interface.

onlyAppFeaturedbooleanOptional

Include only vaults that are featured in app.vaults.fyi

allowCorruptedbooleanOptional

Allow inclusion of corrupted vaults.

Default: false

allowVaultsWithWarningsbooleanOptional

Whether to include vaults with warnings. Defaults to true.

maxTvlintegerOptional

Maximum TVL in USD of the vaults to be included

maxApynumberOptional

Maximum APY (in decimal) of the vaults to be included

minApynumberOptional

Minimum APY (in decimal) of the vaults to be included

tagsstring[]Optional

Tags to be included.

curatorsstring[]Optional

Curators to be included.

sortOrderstring · enumOptional

Sort order, either asc or desc. Ascending is default.

Default: ascPossible values:

sortBystring · enumOptional

Field to sort by

Possible values:

Responses

200

Default Response

application/json

itemsOnPageintegerRequired

Number of items on the current page

nextPageintegerOptional

Next page number

400

Default Response

application/json

401

Default Response

application/json

402

Default Response

application/json

403

Default Response

application/json

404

Default Response

application/json

408

Default Response

application/json

500

Default Response

application/json

503

Default Response

application/json

get

/v2/detailed-vaults

HTTPcURLJavaScriptPython

GET /v2/detailed-vaults HTTP/1.1
Host: api.vaults.fyi
x-api-key: YOUR_API_KEY
Accept: */*

{
  "itemsOnPage": 1,
  "nextPage": 1,
  "data": [
    {
      "address": "text",
      "network": {
        "name": "mainnet",
        "chainId": 1,
        "networkCaip": "text"
      },
      "asset": {
        "address": "text",
        "assetCaip": "text",
        "name": "text",
        "symbol": "text",
        "decimals": 1,
        "assetLogo": "https://example.com",
        "assetPriceInUsd": "text",
        "assetGroup": "text"
      },
      "isTransactional": true,
      "isAppFeatured": true,
      "name": "text",
      "protocol": {
        "name": "text",
        "product": "text",
        "version": "text",
        "protocolUrl": "text",
        "description": "text",
        "protocolLogo": "text"
      },
      "lendUrl": "text",
      "description": "text",
      "protocolVaultUrl": "text",
      "tags": [
        "text"
      ],
      "holdersData": {
        "totalCount": 1,
        "totalBalance": "text",
        "topHolders": [
          {
            "address": "text",
            "lpTokenBalance": "text"
          }
        ]
      },
      "apy": {
        "1day": {
          "base": 1,
          "reward": 1,
          "total": 1
        },
        "7day": {
          "base": 1,
          "reward": 1,
          "total": 1
        },
        "30day": {
          "base": 1,
          "reward": 1,
          "total": 1
        },
        "1hour": {
          "base": 1,
          "reward": 1,
          "total": 1
        }
      },
      "tvl": {
        "usd": "text",
        "native": "text"
      },
      "lastUpdateTimestamp": 1,
      "rewards": [
        {
          "asset": {
            "address": "text",
            "assetCaip": "text",
            "name": "text",
            "symbol": "text",
            "decimals": 1,
            "assetLogo": "https://example.com",
            "assetPriceInUsd": "text",
            "assetGroup": "text"
          },
          "apy": {
            "1hour": 1,
            "1day": 1,
            "7day": 1,
            "30day": 1
          }
        }
      ],
      "score": {
        "vaultScore": 1,
        "vaultTvlScore": 1,
        "protocolTvlScore": 1,
        "holderScore": 1,
        "networkScore": 1,
        "assetScore": 1
      },
      "additionalIncentives": "text",
      "curator": {
        "name": "text",
        "description": "text",
        "websiteUrl": "text"
      },
      "lpToken": {
        "address": "text",
        "tokenCaip": "text",
        "name": "text",
        "symbol": "text",
        "decimals": 1
      },
      "remainingCapacity": "text",
      "maxCapacity": "text",
      "isCorrupted": true,
      "childrenVaults": [
        {
          "address": "text",
          "asset": {
            "address": "text",
            "assetCaip": "text",
            "name": "text",
            "symbol": "text",
            "decimals": 1,
            "assetLogo": "https://example.com",
            "assetPriceInUsd": "text",
            "assetGroup": "text"
          },
          "lpToken": {
            "address": "text",
            "tokenCaip": "text",
            "name": "text",
            "symbol": "text",
            "decimals": 1
          },
          "additionalAssets": [
            {
              "address": "text",
              "assetCaip": "text",
              "name": "text",
              "symbol": "text",
              "decimals": 1,
              "assetLogo": "https://example.com",
              "assetPriceInUsd": "text",
              "assetGroup": "text"
            }
          ]
        }
      ],
      "additionalAssets": [
        {
          "address": "text",
          "assetCaip": "text",
          "name": "text",
          "symbol": "text",
          "decimals": 1,
          "assetLogo": "https://example.com",
          "assetPriceInUsd": "text",
          "assetGroup": "text"
        }
      ],
      "transactionalProperties": {
        "depositStepsType": "instant",
        "redeemStepsType": "instant",
        "rewardsSupported": true
      },
      "fees": {
        "performanceFee": 1,
        "managementFee": 1,
        "withdrawalFee": 1,
        "depositFee": 1
      },
      "warnings": [
        "text"
      ]
    }
  ],
  "errors": {
    "unsupportedNetworks": [
      "text"
    ],
    "unsupportedAssets": [
      "text"
    ],
    "unsupportedProtocols": [
      "text"
    ]
  }
}

get

Retrieves vault APY breakdown.

Authorizations

apiKey

x-api-keystringRequired

Path parameters

networkstring · enumRequired

Include only vaults with provided network(name or CAIP)

Possible values:

vaultAddressstringRequired

Address of the vault for which the data will be returned

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

Responses

200

Default Response

application/json

400

Default Response

application/json

401

Default Response

application/json

402

Default Response

application/json

403

Default Response

application/json

404

Default Response

application/json

408

Default Response

application/json

500

Default Response

application/json

503

Default Response

application/json

get

/v2/detailed-vaults/{network}/{vaultAddress}/apy

HTTPcURLJavaScriptPython

GET /v2/detailed-vaults/{network}/{vaultAddress}/apy HTTP/1.1
Host: api.vaults.fyi
x-api-key: YOUR_API_KEY
Accept: */*

{
  "1day": {
    "base": 1,
    "reward": 1,
    "total": 1
  },
  "7day": {
    "base": 1,
    "reward": 1,
    "total": 1
  },
  "30day": {
    "base": 1,
    "reward": 1,
    "total": 1
  }
}

get

Retrieves vault Tvl breakdown.

Authorizations

apiKey

x-api-keystringRequired

Path parameters

networkstring · enumRequired

Include only vaults with provided network(name or CAIP)

Possible values:

vaultAddressstringRequired

Address of the vault for which the data will be returned

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

Responses

200

Default Response

application/json

usdstringRequired

TVL in USD

nativestringRequired

Native TVL

400

Default Response

application/json

401

Default Response

application/json

402

Default Response

application/json

403

Default Response

application/json

404

Default Response

application/json

408

Default Response

application/json

500

Default Response

application/json

503

Default Response

application/json

get

/v2/detailed-vaults/{network}/{vaultAddress}/tvl

HTTPcURLJavaScriptPython

GET /v2/detailed-vaults/{network}/{vaultAddress}/tvl HTTP/1.1
Host: api.vaults.fyi
x-api-key: YOUR_API_KEY
Accept: */*

{
  "usd": "text",
  "native": "text"
}