Get single top option for address

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

post

Authorizations

Path parameters

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

Body

apyIntervalstring · enumOptional

Resolution of the APY data

Default: 7dayPossible values:

allowedAssetsstring[]Optional

Assets to be included (by symbol/ticker)

disallowedAssetsstring[]Optional

Assets to be excluded (by symbol/ticker)

allowedProtocolsstring[]Optional

Protocols to be included (by name)

disallowedProtocolsstring[]Optional

Protocols to be excluded (by name)

minimumBalanceThresholdnumberOptional

Minimum balance in USD of the assets to be included

Default: 1

minimumVaultTvlnumberOptional

Minimum TVL in USD of the vaults to be included

Default: 100000

transactionalOnlybooleanOptional

Boolean indicating if only transactional vaults should be included

transactionalFeaturedOnlybooleanOptional

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

Responses

200

Default Response

application/json

post

HTTPcURLJavaScriptPython

POST //v1/portfolio/best-vault/{userAddress} HTTP/1.1
Host: api.vaults.fyi
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 308

{
  "apyInterval": "7day",
  "allowedNetworks": [
    "mainnet"
  ],
  "disallowedNetworks": [
    "mainnet"
  ],
  "allowedAssets": [
    "text"
  ],
  "disallowedAssets": [
    "text"
  ],
  "allowedProtocols": [
    "text"
  ],
  "disallowedProtocols": [
    "text"
  ],
  "minimumBalanceThreshold": 1,
  "minimumVaultTvl": 100000,
  "transactionalOnly": true,
  "transactionalFeaturedOnly": true
}

200

Default Response

{
  "requestedAddress": "text",
  "asset": {
    "name": "text",
    "assetAddress": "text",
    "assetCaip": "text",
    "symbol": "text",
    "decimals": 1,
    "networkName": "mainnet",
    "networkCaip": "text",
    "balanceNative": "text",
    "balanceUsd": 1
  },
  "vault": {
    "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"
    ]
  }
}