> ## Documentation Index > Fetch the complete documentation index at: https://docs.onebalance.io/llms.txt > Use this file to discover all available pages before exploring further. # Get aggregated balance > Fetches the aggregated balance of assets for given accounts with support for multiple chain types (EVM, Solana, etc.). Returns a unified view with all balances intermixed. Supports filtering by specific aggregated asset IDs. ## OpenAPI ````yaml get /v3/balances/aggregated-balance openapi: 3.1.0 info: version: 1.6.2 title: OneBalance API description: > # OneBalance API The OneBalance API provides a programmatic interface for managing OneBalance resources using standard HTTP requests. The API documentation includes a design and technology overview, followed by detailed endpoint information. ## Features OneBalance API provides a complete chain abstraction toolkit: - Smart Account Management: Predict addresses and deploy accounts - Cross-Chain Balances: View aggregated balances across multiple chains - Multichain Transactions: Execute transfers and swaps using aggregated balances - Transaction Status: Track multichain transaction history and status - Token Aggregation: Access unified token lists and pricing information Enterprise API Access: Need higher rate limits, dedicated infrastructure, or custom SLAs? [Contact our sales](mailto:sales@onebalance.io) team for enterprise API solutions. ## Base URL OneBalance API is built on REST principles and is served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported. The Base URL for all API endpoints is: ```bash https://be.onebalance.io/api ``` ## Quickstart Try our reference application at [app.onebalance.io](https://app.onebalance.io) to see the API in action or jump straight into our [API Reference](https://docs.onebalance.io/api-reference/account/predict-address) to start building. ## Authentication 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: ```bash curl -X 'GET' \ 'https://be.onebalance.io/api/path-to/endpoint' \ -H 'x-api-key: 42bb629272001ee1163ca0dbbbc07bcbb0ef57a57baf16c4b1d4672db4562c11' ``` A public API key is available for testing purposes with limited usage: **42bb629272001ee1163ca0dbbbc07bcbb0ef57a57baf16c4b1d4672db4562c11** All API requests must be made over [HTTPS](https://en.wikipedia.org/wiki/HTTPS). Calls made over plain HTTP will fail. API requests without authentication will also fail. license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html contact: name: OneBalance Support email: support@onebalance.io termsOfService: https://onebalance.io/terms-of-service servers: - url: https://be.onebalance.io/api description: Production environment security: - ApiKeyAuth: [] tags: - name: Account x-displayName: Smart Accounts description: >- Manage and predict addresses for OneBalance smart accounts. These accounts enable features like resource locks and streamlined cross-chain interactions. - name: Assets x-displayName: Aggregated Assets description: >- Retrieve details about supported aggregated assets. Aggregated assets represent a unified view of a token across multiple chains, simplifying cross-chain operations. - name: Balances x-displayName: Aggregated Balances description: >- Access and track aggregated asset balances for user accounts. These balances reflect a user's total holdings of an asset across all supported chains, usable for multichain transactions. - name: Chains x-displayName: Supported Chains description: >- List and get details about the blockchain networks currently integrated with and supported by the OneBalance platform. - name: Status x-displayName: Transaction Status & History description: >- Track the real-time status of quote executions and retrieve complete transaction histories for user accounts, offering visibility into multichain operations. - name: Quotes x-displayName: Quotes & Execution description: >- Request, prepare, and execute quotes for various cross-chain operations including asset transfers, swaps, and arbitrary contract interactions. These endpoints facilitate the core transaction lifecycle on OneBalance. paths: /v3/balances/aggregated-balance: get: tags: - Balances summary: Get aggregated balance description: >- Fetches the aggregated balance of assets for given accounts with support for multiple chain types (EVM, Solana, etc.). Returns a unified view with all balances intermixed. Supports filtering by specific aggregated asset IDs. operationId: getAggregatedBalanceV3 parameters: - name: account required: true in: query description: >- Account identifiers in CAIP-10 format or custom chain-agnostic format, separated by commas schema: type: string example: >- eip155:42161:0xfe52613d747E20F2f62e0A5cC36B0DFAe771C442,solana:J5CCzBULFax899tcirb6wMbenQUd8whbaetG7EfSick5 - name: aggregatedAssetId required: false in: query description: >- Aggregated asset IDs to filter by, separated by commas. At least one of aggregatedAssetId or assetId must be provided. schema: type: string example: ob:eth,ob:usdc,ob:arb - name: assetId required: false in: query description: >- Additional token assetIds to include, separated by commas. At least one of aggregatedAssetId or assetId must be provided. schema: type: string example: >- eip155:42161/erc20:0xaf88d065e77c8cC2239327C5EDb3A432268e5831,solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/token:EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v responses: '200': description: Successfully retrieved aggregated balance content: application/json: schema: $ref: '#/components/schemas/aggregated-balance-v3-response' examples: EVMOnlyBalance: summary: EVM-only aggregated balance description: Example of aggregated balance for EVM accounts only value: accounts: evm: '0xfe52613d747E20F2f62e0A5cC36B0DFAe771C442' balanceByAggregatedAsset: - aggregatedAssetId: ob:eth balance: '26720629499317191152' individualAssetBalances: - assetType: eip155:42161/slip44:60 balance: '43872973277400073' fiatValue: 77.727114 - assetType: eip155:8453/slip44:60 balance: '26488136306212020002' fiatValue: 46927.441806 fiatValue: 47005.16892 - aggregatedAssetId: ob:usdc balance: '843936437' individualAssetBalances: - assetType: >- eip155:42161/erc20:0xaf88d065e77c8cc2239327c5edb3a432268e5831 balance: '62459466' fiatValue: 62.456468 - assetType: >- eip155:8453/erc20:0x833589fcd6edb6e08f4c7c32d4f71b54bda02913 balance: '774598041' fiatValue: 774.563184 fiatValue: 837.019652 balanceBySpecificAsset: [] totalBalance: fiatValue: 47842.188572 SolanaOnlyBalance: summary: Solana-only aggregated balance description: Example of aggregated balance for Solana accounts only value: accounts: solana: J5CCzBULFax899tcirb6wMbenQUd8whbaetG7EfSick5 balanceByAggregatedAsset: - aggregatedAssetId: ob:single balance: '15000000' individualAssetBalances: - assetType: solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501 balance: '15000000' fiatValue: 2.51 fiatValue: 2.51 - aggregatedAssetId: ob:single balance: '5000000' individualAssetBalances: - assetType: >- solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/token:EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v balance: '5000000' fiatValue: 5 fiatValue: 5 balanceBySpecificAsset: [] totalBalance: fiatValue: 7.51 MultichainBalance: summary: Multichain EVM and Solana aggregated balance description: Example of aggregated balance across EVM and Solana accounts value: accounts: evm: '0xfe52613d747E20F2f62e0A5cC36B0DFAe771C442' solana: J5CCzBULFax899tcirb6wMbenQUd8whbaetG7EfSick5 balanceByAggregatedAsset: - aggregatedAssetId: ob:eth balance: '26720629499317191152' individualAssetBalances: - assetType: eip155:42161/slip44:60 balance: '43872973277400073' fiatValue: 77.727114 - assetType: eip155:8453/slip44:60 balance: '26488136306212020002' fiatValue: 46927.441806 fiatValue: 47005.16892 - aggregatedAssetId: ob:usdc balance: '848936437' individualAssetBalances: - assetType: >- eip155:42161/erc20:0xaf88d065e77c8cc2239327c5edb3a432268e5831 balance: '62459466' fiatValue: 62.456468 - assetType: >- eip155:8453/erc20:0x833589fcd6edb6e08f4c7c32d4f71b54bda02913 balance: '774598041' fiatValue: 774.563184 - assetType: >- solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/token:EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v balance: '5000000' fiatValue: 5 fiatValue: 842.019652 - aggregatedAssetId: ob:single balance: '15000000' individualAssetBalances: - assetType: solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501 balance: '15000000' fiatValue: 2.51 fiatValue: 2.51 balanceBySpecificAsset: - assetType: >- eip155:1/erc20:0xae7ab96520de3a18e5e111b5eaab095312d7fe84 balance: '0' fiatValue: 0 totalBalance: fiatValue: 47849.698572 FilteredAggregatedAssets: summary: Filtered aggregated balance by specific asset IDs description: >- Example of aggregated balance filtered to only include specific aggregated assets (ob:usdc,ob:arb) value: accounts: evm: '0xfe52613d747E20F2f62e0A5cC36B0DFAe771C442' solana: J5CCzBULFax899tcirb6wMbenQUd8whbaetG7EfSick5 balanceByAggregatedAsset: - aggregatedAssetId: ob:usdc balance: '4383332' individualAssetBalances: - assetType: >- eip155:42161/erc20:0xaf88d065e77c8cc2239327c5edb3a432268e5831 balance: '105' fiatValue: 0.000105 - assetType: >- eip155:8453/erc20:0x833589fcd6edb6e08f4c7c32d4f71b54bda02913 balance: '0' fiatValue: 0 - assetType: >- eip155:10/erc20:0x0b2c639c533813f4aa9d7837caf62653d097ff85 balance: '0' fiatValue: 0 - assetType: >- eip155:43114/erc20:0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E balance: '0' fiatValue: 0 - assetType: >- eip155:1329/erc20:0x3894085Ef7Ff0f0aeDf52E2A2704928d1Ec074F1 balance: '0' fiatValue: 0 - assetType: >- solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/token:EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v balance: '4383227' fiatValue: 4.383234 fiatValue: 4.383338999999999 - aggregatedAssetId: ob:arb balance: '0' individualAssetBalances: - assetType: >- eip155:42161/erc20:0x912CE59144191C1204E64559FE8253a0e49E6548 balance: '0' fiatValue: 0 fiatValue: 0 balanceBySpecificAsset: [] totalBalance: fiatValue: 4.383338999999999 SpecificAssetBalance: summary: Specific asset balance response description: >- Example response when querying specific assets with assetId parameter value: accounts: evm: '0xfe52613d747E20F2f62e0A5cC36B0DFAe771C442' solana: J5CCzBULFax899tcirb6wMbenQUd8whbaetG7EfSick5 balanceByAggregatedAsset: [] balanceBySpecificAsset: - assetType: >- eip155:42161/erc20:0xaf88d065e77c8cC2239327C5EDb3A432268e5831 balance: '105' fiatValue: 0 - assetType: >- solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/token:EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v balance: '4383227' fiatValue: 0 totalBalance: fiatValue: 0 '400': description: Bad Request - Validation error content: application/json: schema: $ref: '#/components/schemas/http-exception' example: error: Validation failed message: >- Validation error: At least one of assetId or aggregatedAssetId must be provided and non-empty at "assetId.aggregatedAssetId" statusCode: 400 '401': $ref: '#/components/responses/unauthorized' components: schemas: aggregated-balance-v3-response: type: object description: >- Aggregated balance response for v3 endpoints supporting multiple accounts and chain types properties: accounts: type: object description: Parsed account addresses from the request, organized by chain type example: evm: '0xfe52613d747E20F2f62e0A5cC36B0DFAe771C442' solana: J5CCzBULFax899tcirb6wMbenQUd8whbaetG7EfSick5 properties: evm: type: string description: EVM account address if provided in request example: '0xfe52613d747E20F2f62e0A5cC36B0DFAe771C442' solana: type: string description: Solana account address if provided in request example: J5CCzBULFax899tcirb6wMbenQUd8whbaetG7EfSick5 balanceByAggregatedAsset: type: array description: >- List of aggregated asset balances across all queried accounts and chains items: $ref: '#/components/schemas/asset-balance' example: - aggregatedAssetId: ob:eth balance: '26720629499317191152' individualAssetBalances: - assetType: eip155:42161/slip44:60 balance: '43872973277400073' fiatValue: 77.727114 fiatValue: 47005.16892 balanceBySpecificAsset: type: array description: >- List of specific asset balances that were queried by assetId parameter items: $ref: '#/components/schemas/specific-asset-balance' example: - assetType: eip155:42161/erc20:0xaf88d065e77c8cC2239327C5EDb3A432268e5831 balance: '105' fiatValue: 0.000105 totalBalance: $ref: '#/components/schemas/total-balance' required: - accounts - balanceByAggregatedAsset - balanceBySpecificAsset - totalBalance http-exception: type: object properties: error: type: string description: Error name example: Validation failed message: type: string description: Error message example: >- Validation error: Must be a valid hex string starting with 0x at "address" statusCode: type: number description: Error status code example: 400 required: - error - message - statusCode asset-balance: type: object properties: aggregatedAssetId: type: string description: The aggregated asset ID (e.g., ob:eth, ob:usdc) example: ob:eth balance: type: string description: The total balance of this asset across all chains example: '26720629499317191152' individualAssetBalances: type: array description: Balances of individual assets that make up this aggregated asset items: $ref: '#/components/schemas/individual-asset-balance' example: - assetType: eip155:42161/slip44:60 balance: '43872973277400073' fiatValue: 77.727114 fiatValue: type: number description: The total fiat value of this asset example: 47166.608328 required: - aggregatedAssetId - balance - individualAssetBalances - fiatValue specific-asset-balance: type: object properties: assetType: type: string description: The CAIP-19 asset type identifier example: eip155:1/erc20:0xae7ab96520de3a18e5e111b5eaab095312d7fe84 balance: type: string description: The balance of this specific asset example: '0' fiatValue: type: number description: The fiat value of this specific asset example: 0 required: - assetType - balance - fiatValue total-balance: type: object properties: fiatValue: type: number description: The total fiat value of all assets example: 77871.483693 required: - fiatValue HttpUnauthorizedException: type: object properties: error: type: string description: Error name example: UnauthorizedException message: type: string description: Error message example: Invalid or missing API key statusCode: type: number description: Error status code example: 401 timestamp: type: string description: Error timestamp example: '2024-12-18T14:38:24.793Z' path: type: string description: Error path example: /api/account/predict-address required: - error - message - statusCode - timestamp - path individual-asset-balance: type: object properties: assetType: type: string description: The CAIP-19 asset type identifier example: eip155:42161/slip44:60 balance: type: string description: The balance of this asset example: '43872973277400073' fiatValue: type: number description: The fiat value of this asset example: 77.435798 required: - assetType - balance - fiatValue responses: unauthorized: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/HttpUnauthorizedException' example: error: UnauthorizedException message: Invalid or missing API key statusCode: 401 timestamp: '2024-12-18T14:38:24.793Z' path: /api/xxx/xxx securitySchemes: ApiKeyAuth: type: apiKey name: x-api-key in: header description: >- 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: ```bash 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: `42bb629272001ee1163ca0dbbbc07bcbb0ef57a57baf16c4b1d4672db4562c11`. 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](https://docs.onebalance.io). ````