Top vault options for address

Given a user address and specific preferences (e.g. networks and protocols to include/exclude, min. vault TVL, etc.), return a list of vault options for the user address.

post

/v1/portfolio/best-deposit-options/{userAddress}

Authorizations

Path parameters

userAddressstringrequired

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

Body

apyIntervalstring · enum · default: 7day

Resolution of the APY data

Options: 1day, 7day, 30day

allowedNetworksstring · enum[] · default: base,mainnet,arbitrum,polygon

Networks to be included (name or CAIP)

disallowedNetworksstring · enum[]

Networks to be excluded (name or CAIP)

allowedAssetsstring[]

Assets to be included (by symbol/ticker)

disallowedAssetsstring[]

Assets to be excluded (by symbol/ticker)

allowedProtocolsstring[]

Protocols to be included (by name)

disallowedProtocolsstring[]

Protocols to be excluded (by name)

minimumBalanceThresholdnumber · default: 1

Minimum balance in USD of the assets to be included

minimumVaultTvlnumber · default: 100000

Minimum TVL in USD of the vaults to be included

transactionalOnlyboolean

Boolean indicating if only transactional vaults should be included

transactionalFeaturedOnlyboolean

Boolean indicating if only transactional vaults featured in app.vaults.fyi should be included

maxVaultsPerAssetinteger · min: 1 · max: 5 · default: 3

Maximum number of vaults per asset

minApyinteger

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

alwaysReturnAssetsstring[] · default:

Symbols/tickers of assets to always return, regardless of balance

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://api.vaults.fyi/v1/portfolio/best-deposit-options/{userAddress}' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "apyInterval": "7day",
    "allowedNetworks": [
      "base",
      "mainnet",
      "arbitrum",
      "polygon"
    ],
    "disallowedNetworks": [
      "mainnet"
    ],
    "allowedAssets": [
      "text"
    ],
    "disallowedAssets": [
      "text"
    ],
    "allowedProtocols": [
      "text"
    ],
    "disallowedProtocols": [
      "text"
    ],
    "minimumBalanceThreshold": 1,
    "minimumVaultTvl": 100000,
    "transactionalOnly": true,
    "transactionalFeaturedOnly": true,
    "maxVaultsPerAsset": 3,
    "minApy": 1,
    "alwaysReturnAssets": []
  }'

200

200

{
  "requestedAddress": "text",
  "userBalances": [
    {
      "asset": {
        "name": "text",
        "assetAddress": "text",
        "assetCaip": "text",
        "symbol": "text",
        "decimals": 1,
        "networkName": "mainnet",
        "networkCaip": "text",
        "balanceNative": "text",
        "balanceUsd": 1
      },
      "depositOptions": [
        {
          "name": "text",
          "protocol": {
            "name": "text",
            "product": "text",
            "version": "text",
            "protocolLogo": "https://example.com",
            "protocolUrl": "https://example.com",
            "description": "text"
          },
          "vaultAddress": "text",
          "vaultUrl": "https://example.com",
          "networkName": "mainnet",
          "networkCaip": "text",
          "tvlInUsd": 1,
          "apy": {
            "base": 1,
            "rewards": 1,
            "total": 1
          },
          "projectedAnnualEarnings": 1,
          "tags": [
            "text"
          ],
          "isTransactional": true
        }
      ]
    }
  ],
  "errors": {
    "unsupportedNetworks": [
      "text"
    ],
    "unsupportedAssets": [
      "text"
    ],
    "unsupportedProtocols": [
      "text"
    ]
  }
}

Default Response