Portals Logo

Documentation
Guides
Getting Balances

Getting Balances

Summary

The account endpoint can be used to fetch balances for any externally owned account (EOA) or smart contract address belonging to any or all of the supported networks. This endpoint is useful for creating dashboards, populating input token lists for portals, checking balances after a transaction, and more.

Endpoints

GET v2/account

This endpoint returns an object containing an array of balances of tokens that owner is holding, in addition to of the details for each token. This response includes balances of Native, Basic, and LP tokens. At least one network must be specified to query balances, and you can query balances for multiple networks in a single request.

Filters

Networks

You can filter balances by network using the networks filter. For example, to return balances from only the ethereum network, use the networks=ethereum filter. For a list of networks, see the networks section.

Example

The below example is an abbreviated response from querying the /v2/account endpoint with the owner 0xd8da6bf26964af9d7eed9e03e53415d37aa96045 (i.e. vitalik.eth) and networks=ethereum.

{
  "balances": [
    {
      "key": "ethereum:0x0000000000000000000000000000000000000000",
      "name": "Ethereum",
      "decimals": 18,
      "symbol": "ETH",
      "price": 1917.89,
      "address": "0x0000000000000000000000000000000000000000",
      "addresses": {
        "arbitrum": "0x0000000000000000000000000000000000000000",
        "optimism": "0x0000000000000000000000000000000000000000",
        "ethereum": "0x0000000000000000000000000000000000000000"
      },
      "platform": "native",
      "network": "ethereum",
      "updatedAt": "2023-07-20T12:46:07.752Z",
      "createdAt": "2023-07-04T19:33:08.478Z",
      "tokens": [],
      "liquidity": 229924476141,
      "image": "https://assets.coingecko.com/coins/images/279/large/ethereum.png?1595348880",
      "balanceUSD": 7517559.09,
      "balance": 3919.7029518948907,
      "rawBalance": "3919702951894890768345"
    },
    {
      "key": "ethereum:0x1f961bceaef8edf6fb2797c0293ffbde3e994614",
      "name": "Dingo",
      "decimals": 9,
      "symbol": "DINGO",
      "price": 5.634e-9,
      "address": "0x1f961bceaef8edf6fb2797c0293ffbde3e994614",
      "addresses": {
        "ethereum": "0x1f961bceaef8edf6fb2797c0293ffbde3e994614"
      },
      "platform": "basic",
      "network": "ethereum",
      "updatedAt": "2023-07-20T11:41:14.390Z",
      "createdAt": "2023-07-04T19:33:08.478Z",
      "tokens": [],
      "liquidity": 0,
      "image": "https://assets.coingecko.com/coins/images/16315/large/tzI4QPI7_400x400.png?1623733248",
      "balanceUSD": 2535675.22,
      "balance": 450066600000000,
      "rawBalance": "450066600000000000000000"
    },
    ...
  ]
}