GET
/
v2
/
balances
/
aggregated-balance
curl --request GET \
  --url https://be.onebalance.io/api/v2/balances/aggregated-balance \
  --header 'x-api-key: <api-key>'
{
  "balanceByAggregatedAsset": [
    {
      "aggregatedAssetId": "ds:eth",
      "balance": "26720629499317191152",
      "individualAssetBalances": [
        {
          "assetType": "eip155:42161/slip44:60",
          "balance": "43872973277400073",
          "fiatValue": 77.727114
        },
        {
          "assetType": "eip155:8453/slip44:60",
          "balance": "26488136306212020002",
          "fiatValue": 46927.441806
        },
        {
          "assetType": "eip155:10/slip44:60",
          "balance": "188620219827771077",
          "fiatValue": 334.167126
        }
      ],
      "fiatValue": 47339.336046
    },
    {
      "aggregatedAssetId": "ds:usdc",
      "balance": "843936437",
      "individualAssetBalances": [
        {
          "assetType": "eip155:42161/erc20:0xaf88d065e77c8cc2239327c5edb3a432268e5831",
          "balance": "62459466",
          "fiatValue": 62.456468
        },
        {
          "assetType": "eip155:8453/erc20:0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
          "balance": "774598041",
          "fiatValue": 774.563184
        },
        {
          "assetType": "eip155:10/erc20:0x0b2c639c533813f4aa9d7837caf62653d097ff85",
          "balance": "5845251",
          "fiatValue": 5.844988
        },
        {
          "assetType": "eip155:43114/erc20:0xb97ef9ef8734c71904d8002f8b6bc66dd9c48a6e",
          "balance": "1033679",
          "fiatValue": 1.033632
        }
      ],
      "fiatValue": 843.898272
    }
  ],
  "balanceBySpecificAsset": [
    {
      "assetType": "eip155:1/erc20:0xae7ab96520de3a18e5e111b5eaab095312d7fe84",
      "balance": "0",
      "fiatValue": 0
    }
  ],
  "totalBalance": {
    "fiatValue": 78138.51832
  }
}

Authorizations

​
x-api-key
string
header
required

The OneBalance API uses API keys to authenticate requests. All API requests require authentication using an API key passed in the x-api-key header:

curl -X 'GET' \
  'https://be.onebalance.io/api/path-to/endpoint' \
  -H 'x-api-key: ${ONEBALANCE_API_KEY}' \
  ...

A public API key is available for testing purposes with limited usage: f9703eaqsbma20tmtphg2jirm0hk8z8v2hkodrfrvhfm6ziesi7p38u991bnih5f.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Learn how to generate API access tokens at OneBalance Docs.

Query Parameters

​
assetId
string

Additional token assetIds to include, separated by commas

Example:

"eip155:1/erc20:0xae7ab96520de3a18e5e111b5eaab095312d7fe84"

​
address
string
required

The address for which to retrieve the balance (e.g., 0x123...)

Example:

"0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"

Response

200
application/json

Successfully retrieved aggregated balance

The response is of type object.