| Capability | How to call | Required inputs |
|---|---|---|
| List all vault positions for a wallet | GET /v2/portfolio/positions/{userAddress} | Path: userAddress. Optional query filters include allowedNetworks, allowedAssets, allowedProtocols, minTvl, minVaultScore, onlyTransactional, onlyAppFeatured, apyInterval, and minUsdAssetValueThreshold |
| Fetch one vault position for a wallet | GET /v2/portfolio/positions/{userAddress}/{network}/{vaultId} | Path: userAddress, network, vaultId. Optional query: apyInterval |
| List uninvested token balances | GET /v2/portfolio/idle-assets/{userAddress} | Path: userAddress. Optional query filters include allowedNetworks, allowedAssets, minUsdAssetValueThreshold, sortBy, and sortDirection |
| Rank deposit opportunities matching wallet holdings | GET /v2/portfolio/best-deposit-options/{userAddress} | Path: userAddress. Optional query filters include allowedNetworks, allowedAssets, allowedProtocols, minTvl, minVaultScore, minApy, apyInterval, alwaysReturnAssets, and maxVaultsPerAsset |
| Fetch the single best-fit vault for a wallet | GET /v2/portfolio/best-vault/{userAddress} | Path: userAddress. Optional query filters include allowedNetworks, allowedAssets, allowedProtocols, minTvl, minVaultScore, minApy, and apyInterval |
| Calculate earned yield for one position | GET /v2/portfolio/total-returns/{userAddress}/{network}/{vaultId} | Path: userAddress, network, vaultId |
| List deposit, redeem, and claim history for one position | GET /v2/portfolio/events/{userAddress}/{network}/{vaultId} | Path: userAddress, network, vaultId |
Sections
Portfolio
User positions, idle assets, deposit recommendations, transaction history, and returns.
Wallet-aware endpoints that return a user’s vault positions, uninvested balances, personalized deposit suggestions, total returns, and transaction history.