/zerion/wallets

POST /api/zerion/wallets

Price: 1 credit

Get a wallet's multichain portfolio summary by EVM address or ENS name

How to use it

Get the portfolio summary of a crypto wallet by its EVM address (0x...) or ENS / identity name (e.g. 'vitalik.eth'). Returns the total portfolio value, 24h change (absolute and percent), value broken down by position type (wallet assets, deposited, staked, borrowed, locked) and by blockchain network, NFT floor value, premium status, and the wallet's resolved identities (ENS and other name providers). Use the positions endpoint for the individual token and DeFi holdings.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• address string required — Wallet address: an EVM 0x address or an ENS / identity name (examples: "0xd8da6bf26964af9d7eed9e03e53415d37aa96045", "vitalik.eth")
• currency string — Currency to denominate portfolio values in (default: "usd"; one of: "usd", "eur", "gbp", "jpy", "aud", "cad", "chf", "cny", "inr", "krw", "rub", "brl", "try", "btc", "eth")

Response

• @type string (default: "ZerionWallet")
• address string required
• name string nullable
• image string nullable
• total_value number nullable
• change_24h_absolute number nullable
• change_24h_percent number nullable
• nft_floor_price number nullable
• nft_last_price number nullable
• is_premium boolean (default: false)
• position_value_by_type object nullable
  • @type string (default: "ZerionPositionTypeValues")
  • assets number nullable
  • deposited number nullable
  • staked number nullable
  • borrowed number nullable
  • locked number nullable
• value_by_chain object (default: {})
  • * number
• nft_value_by_chain object (default: {})
  • * number
• identities array (default: [])
  • @type string (default: "ZerionWalletIdentity")
  • provider string nullable
  • handle string nullable
  • address string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Wallet or ENS name not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.