Earn API endpoints

vaults.fyi Earn API endpoints help prepare transaction payloads for interactions with vaults across leading DeFi protocols, including Aave, Sky, Morpho, Euler, Compound, and more.

Endpoints

PreviousEarn API NextProduct demo

Last updated 2 days ago

get

/v1/transactions/assets

Authorizations

Query parameters

networkstring · enumrequired

Options: mainnet, arbitrum, optimism, polygon, base, gnosis, eip155:1, eip155:42161, eip155:10, eip155:137, eip155:8453, eip155:100

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1/transactions/assets?network=mainnet' \
  --header 'x-api-key: YOUR_API_KEY'

200

[
  {
    "address": "text",
    "name": "text",
    "symbol": "text",
    "decimals": 1,
    "network": "mainnet"
  }
]

Default Response

get

/v1/transactions/vaults

Authorizations

Query parameters

networkstring · enumrequired

Options: mainnet, arbitrum, optimism, polygon, base, gnosis, eip155:1, eip155:42161, eip155:10, eip155:137, eip155:8453, eip155:100

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1/transactions/vaults?network=mainnet' \
  --header 'x-api-key: YOUR_API_KEY'

200

[
  {
    "name": "text",
    "protocol": "text",
    "address": "text",
    "lpTokenAddress": "text",
    "network": "mainnet",
    "assets": [
      {
        "address": "text",
        "name": "text",
        "symbol": "text",
        "decimals": 1,
        "network": "mainnet"
      }
    ]
  }
]

Default Response

get

/v1/transactions/vaults/actions/details

Authorizations

Query parameters

networkstring · enumrequired

Options: mainnet, arbitrum, optimism, polygon, base, gnosis, eip155:1, eip155:42161, eip155:10, eip155:137, eip155:8453, eip155:100

userAddressstringrequired

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

vaultAddressstringrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1/transactions/vaults/actions/details?network=mainnet&userAddress=text&vaultAddress=text' \
  --header 'x-api-key: YOUR_API_KEY'

200

{
  "currentDepositStep": "text",
  "currentRedeemStep": "text",
  "lpTokenBalance": "text",
  "vaultSpecificData": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "idleAssets": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "lockedValueInAssets": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "unclaimedAssets": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "depositSteps": [
    {
      "actionsUrl": "text",
      "name": "deposit",
      "actions": [
        "text"
      ]
    }
  ],
  "redeemSteps": [
    {
      "actionsUrl": "text",
      "name": "redeem",
      "actions": [
        "text"
      ]
    }
  ],
  "rewards": {
    "currentStep": "text",
    "steps": [
      {
        "actionsUrl": "text",
        "name": "claim",
        "actions": [
          "text"
        ]
      }
    ],
    "claimable": [
      {
        "amount": "text",
        "token": {
          "address": "text",
          "name": "text",
          "symbol": "text",
          "decimals": 1,
          "network": "mainnet"
        }
      }
    ]
  }
}

Default Response

get

/v1/transactions/vaults/deposit

Authorizations

Query parameters

networkstring · enumrequired

Options: mainnet, arbitrum, optimism, polygon, base, gnosis, eip155:1, eip155:42161, eip155:10, eip155:137, eip155:8453, eip155:100

senderstringrequired

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

simulateany of · default: false

assetAddressstringrequired

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

vaultAddressstringrequired

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

amountstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1/transactions/vaults/deposit?network=mainnet&sender=text&assetAddress=text&vaultAddress=text&amount=text' \
  --header 'x-api-key: YOUR_API_KEY'

200

{
  "currentActionIndex": 1,
  "actions": [
    {
      "name": "text",
      "tx": {
        "to": "text",
        "chainId": 1,
        "data": "text",
        "value": "text"
      },
      "simulation": {
        "url": "text",
        "status": "success",
        "tokensReceived": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "tokensSpent": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    }
  ]
}

Default Response

get

/v1/transactions/vaults/redeem

Authorizations

Query parameters

networkstring · enumrequired

Options: mainnet, arbitrum, optimism, polygon, base, gnosis, eip155:1, eip155:42161, eip155:10, eip155:137, eip155:8453, eip155:100

senderstringrequired

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

simulateany of · default: false

assetAddressstringrequired

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

vaultAddressstringrequired

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

amountstringrequired

allany of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1/transactions/vaults/redeem?network=mainnet&sender=text&assetAddress=text&vaultAddress=text&amount=text' \
  --header 'x-api-key: YOUR_API_KEY'

200

{
  "currentActionIndex": 1,
  "actions": [
    {
      "name": "text",
      "tx": {
        "to": "text",
        "chainId": 1,
        "data": "text",
        "value": "text"
      },
      "simulation": {
        "url": "text",
        "status": "success",
        "tokensReceived": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "tokensSpent": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    }
  ]
}

Default Response

get

/v1/transactions/vaults/request-redeem

Authorizations

Query parameters

networkstring · enumrequired

Options: mainnet, arbitrum, optimism, polygon, base, gnosis, eip155:1, eip155:42161, eip155:10, eip155:137, eip155:8453, eip155:100

senderstringrequired

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

simulateany of · default: false

assetAddressstringrequired

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

vaultAddressstringrequired

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

amountstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1/transactions/vaults/request-redeem?network=mainnet&sender=text&assetAddress=text&vaultAddress=text&amount=text' \
  --header 'x-api-key: YOUR_API_KEY'

200

{
  "currentActionIndex": 1,
  "actions": [
    {
      "name": "text",
      "tx": {
        "to": "text",
        "chainId": 1,
        "data": "text",
        "value": "text"
      },
      "simulation": {
        "url": "text",
        "status": "success",
        "tokensReceived": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "tokensSpent": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    }
  ]
}

Default Response

get

/v1/transactions/vaults/claim-redeem

Authorizations

Query parameters

networkstring · enumrequired

Options: mainnet, arbitrum, optimism, polygon, base, gnosis, eip155:1, eip155:42161, eip155:10, eip155:137, eip155:8453, eip155:100

senderstringrequired

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

simulateany of · default: false

assetAddressstringrequired

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

vaultAddressstringrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1/transactions/vaults/claim-redeem?network=mainnet&sender=text&assetAddress=text&vaultAddress=text' \
  --header 'x-api-key: YOUR_API_KEY'

200

{
  "currentActionIndex": 1,
  "actions": [
    {
      "name": "text",
      "tx": {
        "to": "text",
        "chainId": 1,
        "data": "text",
        "value": "text"
      },
      "simulation": {
        "url": "text",
        "status": "success",
        "tokensReceived": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "tokensSpent": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    }
  ]
}

Default Response

get

/v1/transactions/vaults/claim-rewards

Authorizations

Query parameters

networkstring · enumrequired

Options: mainnet, arbitrum, optimism, polygon, base, gnosis, eip155:1, eip155:42161, eip155:10, eip155:137, eip155:8453, eip155:100

senderstringrequired

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

simulateany of · default: false

assetAddressstringrequired

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

vaultAddressstringrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1/transactions/vaults/claim-rewards?network=mainnet&sender=text&assetAddress=text&vaultAddress=text' \
  --header 'x-api-key: YOUR_API_KEY'

200

{
  "currentActionIndex": 1,
  "actions": [
    {
      "name": "text",
      "tx": {
        "to": "text",
        "chainId": 1,
        "data": "text",
        "value": "text"
      },
      "simulation": {
        "url": "text",
        "status": "success",
        "tokensReceived": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "tokensSpent": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    }
  ]
}

Default Response

post

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

Authorizations

Path parameters

userAddressstringrequired

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

Body

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

apyIntervalstring · enum · default: 7day

Resolution of the APY data

Options: 1day, 7day, 30day

allowedAssetsstring · min: 1[]

Assets to be included (by symbol/ticker)

disallowedAssetsstring · min: 1[]

Assets to be excluded (by symbol/ticker)

allowedProtocolsstring · min: 1[]

Protocols to be included (by name)

disallowedProtocolsstring · min: 1[]

Protocols to be excluded (by name)

alwaysReturnAssetsstring · min: 1[] · default:

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

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

Networks to be included (name or CAIP)

disallowedNetworksstring · enum[]

Networks to be excluded (name or CAIP)

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

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

Default Response

post

/v1/portfolio/best-vault/{userAddress}

Authorizations

Path parameters

userAddressstringrequired

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

Body

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

apyIntervalstring · enum · default: 7day

Resolution of the APY data

Options: 1day, 7day, 30day

allowedAssetsstring · min: 1[]

Assets to be included (by symbol/ticker)

disallowedAssetsstring · min: 1[]

Assets to be excluded (by symbol/ticker)

allowedProtocolsstring · min: 1[]

Protocols to be included (by name)

disallowedProtocolsstring · min: 1[]

Protocols to be excluded (by name)

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

Networks to be included (name or CAIP)

disallowedNetworksstring · enum[]

Networks to be excluded (name or CAIP)

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v1/portfolio/best-vault/{userAddress}' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"minimumBalanceThreshold":1,"minimumVaultTvl":100000,"apyInterval":"7day","allowedAssets":[null],"disallowedAssets":[null],"allowedProtocols":[null],"disallowedProtocols":[null],"allowedNetworks":["base","mainnet","arbitrum","polygon"],"disallowedNetworks":["mainnet"]}'

200

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

Default Response

get

/v1/portfolio/wallet-balances

Authorizations

Query parameters

accountstringrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1/portfolio/wallet-balances?account=text' \
  --header 'x-api-key: YOUR_API_KEY'

200

{
  "mainnet": [
    {
      "address": "text",
      "name": "text",
      "symbol": "text",
      "decimals": 1,
      "balance": "text",
      "balanceNative": "text",
      "balanceUsd": "text",
      "network": "mainnet",
      "type": "asset"
    }
  ],
  "arbitrum": [
    {
      "address": "text",
      "name": "text",
      "symbol": "text",
      "decimals": 1,
      "balance": "text",
      "balanceNative": "text",
      "balanceUsd": "text",
      "network": "mainnet",
      "type": "asset"
    }
  ],
  "optimism": [
    {
      "address": "text",
      "name": "text",
      "symbol": "text",
      "decimals": 1,
      "balance": "text",
      "balanceNative": "text",
      "balanceUsd": "text",
      "network": "mainnet",
      "type": "asset"
    }
  ],
  "polygon": [
    {
      "address": "text",
      "name": "text",
      "symbol": "text",
      "decimals": 1,
      "balance": "text",
      "balanceNative": "text",
      "balanceUsd": "text",
      "network": "mainnet",
      "type": "asset"
    }
  ],
  "base": [
    {
      "address": "text",
      "name": "text",
      "symbol": "text",
      "decimals": 1,
      "balance": "text",
      "balanceNative": "text",
      "balanceUsd": "text",
      "network": "mainnet",
      "type": "asset"
    }
  ],
  "gnosis": [
    {
      "address": "text",
      "name": "text",
      "symbol": "text",
      "decimals": 1,
      "balance": "text",
      "balanceNative": "text",
      "balanceUsd": "text",
      "network": "mainnet",
      "type": "asset"
    }
  ]
}

Default Response

get

/v1/portfolio/positions/{userAddress}

Authorizations

Path parameters

userAddressstringrequired

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

Query parameters

apyIntervalstring · enum · default: 7day

Options: 1day, 7day, 30day

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1/portfolio/positions/{userAddress}' \
  --header 'x-api-key: YOUR_API_KEY'

200

301

{
  "mainnet": [
    {
      "vaultAddress": "text",
      "protocolName": "text",
      "protocolLogo": "https://example.com",
      "vaultName": "text",
      "balanceUsd": "text",
      "balanceNative": "text",
      "balanceLp": "text",
      "unclaimedUsd": "text",
      "unclaimedNative": "text",
      "apy": {
        "base": 1,
        "rewards": 1,
        "total": 1
      },
      "asset": {
        "name": "text",
        "assetAddress": "text",
        "assetCaip": "text",
        "symbol": "text",
        "decimals": 1
      }
    }
  ],
  "arbitrum": [
    {
      "vaultAddress": "text",
      "protocolName": "text",
      "protocolLogo": "https://example.com",
      "vaultName": "text",
      "balanceUsd": "text",
      "balanceNative": "text",
      "balanceLp": "text",
      "unclaimedUsd": "text",
      "unclaimedNative": "text",
      "apy": {
        "base": 1,
        "rewards": 1,
        "total": 1
      },
      "asset": {
        "name": "text",
        "assetAddress": "text",
        "assetCaip": "text",
        "symbol": "text",
        "decimals": 1
      }
    }
  ],
  "optimism": [
    {
      "vaultAddress": "text",
      "protocolName": "text",
      "protocolLogo": "https://example.com",
      "vaultName": "text",
      "balanceUsd": "text",
      "balanceNative": "text",
      "balanceLp": "text",
      "unclaimedUsd": "text",
      "unclaimedNative": "text",
      "apy": {
        "base": 1,
        "rewards": 1,
        "total": 1
      },
      "asset": {
        "name": "text",
        "assetAddress": "text",
        "assetCaip": "text",
        "symbol": "text",
        "decimals": 1
      }
    }
  ],
  "polygon": [
    {
      "vaultAddress": "text",
      "protocolName": "text",
      "protocolLogo": "https://example.com",
      "vaultName": "text",
      "balanceUsd": "text",
      "balanceNative": "text",
      "balanceLp": "text",
      "unclaimedUsd": "text",
      "unclaimedNative": "text",
      "apy": {
        "base": 1,
        "rewards": 1,
        "total": 1
      },
      "asset": {
        "name": "text",
        "assetAddress": "text",
        "assetCaip": "text",
        "symbol": "text",
        "decimals": 1
      }
    }
  ],
  "base": [
    {
      "vaultAddress": "text",
      "protocolName": "text",
      "protocolLogo": "https://example.com",
      "vaultName": "text",
      "balanceUsd": "text",
      "balanceNative": "text",
      "balanceLp": "text",
      "unclaimedUsd": "text",
      "unclaimedNative": "text",
      "apy": {
        "base": 1,
        "rewards": 1,
        "total": 1
      },
      "asset": {
        "name": "text",
        "assetAddress": "text",
        "assetCaip": "text",
        "symbol": "text",
        "decimals": 1
      }
    }
  ],
  "gnosis": [
    {
      "vaultAddress": "text",
      "protocolName": "text",
      "protocolLogo": "https://example.com",
      "vaultName": "text",
      "balanceUsd": "text",
      "balanceNative": "text",
      "balanceLp": "text",
      "unclaimedUsd": "text",
      "unclaimedNative": "text",
      "apy": {
        "base": 1,
        "rewards": 1,
        "total": 1
      },
      "asset": {
        "name": "text",
        "assetAddress": "text",
        "assetCaip": "text",
        "symbol": "text",
        "decimals": 1
      }
    }
  ]
}

Default Response