Skip to content

Get portfolio

GET /portfolio

Return non-zero token balances for a wallet across all configured chains, with USD valuations where a price is available. Balances are strings in each token's base units; balanceUsd is null when the token cannot be priced.

Authentication

Send your API key in the api-key header.

Parameters

Name In Type Required Description
wallet query string yes Wallet address to value.

Responses

Status Description
200 Balances and total USD value.
400 Invalid wallet address. Plausible catalog code behind the numeric status is VALIDATION_002 (invalid address format).
401 Missing or invalid API key. Plausible catalog codes behind the numeric status are AUTH_001 (unauthorized access) and AUTH_002 (invalid API key).
500 Unexpected server-side failure. Plausible catalog codes behind the numeric status include SYSTEM_002 (internal server error) and SYSTEM_001 (database operation failed).
200 response
{
  "code": 0,
  "message": "success",
  "data": {
    "wallet": "0x1a2B3c4D5e6F7a8B9c0D1e2F3a4B5c6D7e8F9a0B",
    "totalUsd": 1251.04,
    "assets": [
      {
        "chainId": 8453,
        "token": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
        "symbol": "USDC",
        "balance": "1000000000",
        "balanceUsd": 1000.0
      },
      {
        "chainId": 8453,
        "token": "0x4200000000000000000000000000000000000006",
        "symbol": "WETH",
        "balance": "100000000000000000",
        "balanceUsd": 251.04
      }
    ]
  }
}
400 response
{
  "code": 400,
  "data": null,
  "message": "invalid wallet address"
}
401 response
{
  "code": 401,
  "data": null,
  "message": "missing api-key header"
}
500 response
{
  "code": 500,
  "data": null,
  "message": "internal server error"
}