This endpoint returns the portfolio overview of a web3 wallet.
Temporary limitations for Solana addresses:
NOTE: Don’t forget to stop retries after some reasonable period of time. If the
200status is not returned within 2 minutes it most probably means that some unexpected error occurred and the client should stop the polling.
NOTE: Consider all IDs as abstract strings, without making any assumptions about their format or relying on such assumptions. There is a non-zero probability that IDs may change in the future, and this should not result in any breaking changes.
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
The web3 wallet address A wallet address, which can be either an EVM or Solana address
^0x[a-fA-F0-9]{40}$"0x42b9df65b219b3dd36ff330a4dd8f327a6ada990"
This parameter allows to customize the aggregation of DeFi positions within a portfolio based on their types. The aggregation can include:
only_simple: Only includes wallet-type positions, which are basic, non-protocol related assets. This is the default selection if the parameter is not specified.only_complex: Aggregates positions associated with DeFi protocols only (e.g., staked assets, liquidity pools), like Uniswap or Aave, excluding simple wallet positions.no_filter: Provides an aggregated view of both protocol-related and simple wallet positions without any filtering.The selection of filters affects the composition of the aggregated portfolio results, allowing for tailored analysis and reporting based on the types of positions of interest.
⚠️ Note: Enterprise usage of this API may be subject to different pricing models depending on the selected filter type. For detailed pricing information, please contact
api@zerion.io.
only_simple, only_complex, no_filter Denominated currency value of returned prices
eth, btc, usd, eur, krw, rub, gbp, aud, cad, inr, jpy, nzd, try, zar, cny, chf Controls whether the endpoint should trigger a synchronous position data refresh before responding.
true: Triggers a position sync and waits up to 30 seconds for portfolio data to be refreshed from the blockchain before responding. If data is ready sooner, the response is returned immediately. If data is not ready within 30 seconds, a timeout error may occur.false (default): The endpoint returns immediately with cached portfolio data without triggering any position sync.NOTE: When using
sync=true, be prepared to handle longer response times (up to 30 seconds). Ensure your client timeout settings accommodate this duration.