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

get
Authorizations
x-api-keystringRequired
Query parameters
networkstring · enumRequiredPossible values:
Responses
get
/v1/transactions/assets
200

Default Response

get
Authorizations
x-api-keystringRequired
Query parameters
networkstring · enumRequiredPossible values:
Responses
get
/v1/transactions/vaults
200

Default Response

get
Authorizations
x-api-keystringRequired
Query parameters
networkstring · enumRequiredPossible values:
userAddressstringRequiredPattern: ^0x[a-fA-F0-9]{40}$
vaultAddressstringRequiredPattern: ^0x[a-fA-F0-9]{40}$
Responses
get
/v1/transactions/vaults/actions/details
200

Default Response

get
Authorizations
x-api-keystringRequired
Query parameters
networkstring · enumRequiredPossible values:
senderstringRequiredPattern: ^0x[a-fA-F0-9]{40}$
simulateany ofOptional

DEPRECATED: This parameter is deprecated and no longer functional

Default: false
string · enumOptionalPossible values:
or
string · enumOptionalPossible values:
assetAddressstringRequiredPattern: ^0x[a-fA-F0-9]{40}$
vaultAddressstringRequiredPattern: ^0x[a-fA-F0-9]{40}$
amountstringRequired
Responses
get
/v1/transactions/vaults/deposit
200

Default Response

get
Authorizations
x-api-keystringRequired
Query parameters
networkstring · enumRequiredPossible values:
senderstringRequiredPattern: ^0x[a-fA-F0-9]{40}$
simulateany ofOptional

DEPRECATED: This parameter is deprecated and no longer functional

Default: false
string · enumOptionalPossible values:
or
string · enumOptionalPossible values:
assetAddressstringRequiredPattern: ^0x[a-fA-F0-9]{40}$
vaultAddressstringRequiredPattern: ^0x[a-fA-F0-9]{40}$
amountstringRequired
allany ofOptional
string · enumOptionalPossible values:
or
string · enumOptionalPossible values:
Responses
get
/v1/transactions/vaults/redeem
200

Default Response

get
Authorizations
x-api-keystringRequired
Query parameters
networkstring · enumRequiredPossible values:
senderstringRequiredPattern: ^0x[a-fA-F0-9]{40}$
simulateany ofOptional

DEPRECATED: This parameter is deprecated and no longer functional

Default: false
string · enumOptionalPossible values:
or
string · enumOptionalPossible values:
assetAddressstringRequiredPattern: ^0x[a-fA-F0-9]{40}$
vaultAddressstringRequiredPattern: ^0x[a-fA-F0-9]{40}$
amountstringRequired
Responses
get
/v1/transactions/vaults/request-redeem
200

Default Response

get
Authorizations
x-api-keystringRequired
Query parameters
networkstring · enumRequiredPossible values:
senderstringRequiredPattern: ^0x[a-fA-F0-9]{40}$
simulateany ofOptional

DEPRECATED: This parameter is deprecated and no longer functional

Default: false
string · enumOptionalPossible values:
or
string · enumOptionalPossible values:
assetAddressstringRequiredPattern: ^0x[a-fA-F0-9]{40}$
vaultAddressstringRequiredPattern: ^0x[a-fA-F0-9]{40}$
Responses
get
/v1/transactions/vaults/claim-redeem
200

Default Response

get
Authorizations
x-api-keystringRequired
Query parameters
networkstring · enumRequiredPossible values:
senderstringRequiredPattern: ^0x[a-fA-F0-9]{40}$
simulateany ofOptional

DEPRECATED: This parameter is deprecated and no longer functional

Default: false
string · enumOptionalPossible values:
or
string · enumOptionalPossible values:
assetAddressstringRequiredPattern: ^0x[a-fA-F0-9]{40}$
vaultAddressstringRequiredPattern: ^0x[a-fA-F0-9]{40}$
Responses
get
/v1/transactions/vaults/claim-rewards
200

Default Response

post
Authorizations
x-api-keystringRequired
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

maxVaultsPerAssetinteger · min: 1 · max: 5Optional

Maximum number of vaults per asset

Default: 3
minApyintegerOptional

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

alwaysReturnAssetsstring[]Optional

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

Default: []
distinctProtocolsbooleanOptional

Return only one vault per protocol for each asset

Responses
post
/v1/portfolio/best-deposit-options/{userAddress}
200

Default Response

post
Authorizations
x-api-keystringRequired
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
post
/v1/portfolio/best-vault/{userAddress}
200

Default Response

get
Authorizations
x-api-keystringRequired
Query parameters
accountstringRequiredPattern: ^0x[a-fA-F0-9]{40}$
Responses
get
/v1/portfolio/wallet-balances
200

Default Response

get
Authorizations
x-api-keystringRequired
Path parameters
userAddressstringRequiredPattern: ^0x[a-fA-F0-9]{40}$
Query parameters
apyIntervalstring · enumOptionalDefault: 7dayPossible values:
Responses
get
/v1/portfolio/positions/{userAddress}

Last updated