List token balances

This operation retrieves cached token balances across all wallets accessible to the authenticated principal. Balances are synchronized from on-chain data and may be slightly delayed. You can filter by wallet, chain, address, or token. Use cursor-based pagination with after/before. Set force_refresh=true together with address to force a fresh sync from on-chain before returning.

GET /api/v1/wallets/balances

List token balances

Python

import requests

url = "https://api.example.com/api/v1/wallets/balances"

response = requests.get(url)

print(response.text)

200

{
  "result": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "wallet_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "cobo_wallet_id": "<string>",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "address": "<string>",
      "token_id": "<string>",
      "amount": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "chain_id": "<string>",
      "chain_type": "<string>",
      "compatible_chains": [
        "<string>"
      ],
      "total": "<string>",
      "pending": "<string>",
      "locked": "<string>",
      "balance_updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "success": true,
  "suggestion": "",
  "message": "",
  "meta": {
    "total": 123,
    "offset": 123,
    "limit": 123,
    "has_more": true,
    "after": "<string>",
    "before": "<string>"
  }
}

Headers

X-API-Key · string | null

Query Parameters

wallet_uuid · string<uuid> | null

Filter balances by wallet ID. The wallet ID can be retrieved by calling the List all wallets operation.

chain_id · string | null

Filter balances by chain ID (for example, SETH, BASE_ETH).

address · string | null

Filter balances by on-chain address.

token_id · string | null

Filter balances by token ID (for example, SETH, SETH_USDC).

force_refresh · boolean · default: false

When true and address is provided, force a fresh sync of balances from on-chain before returning results.

limit · integer · default: 50

The maximum number of items to return. Range: [1, 200].

Required range: 1 <= x <= 200

after · string | null

A cursor for forward pagination. Pass the after value from a previous response to retrieve the next page.

before · string | null

A cursor for backward pagination. Pass the before value from a previous response to retrieve the preceding page.

offset · integer | null · deprecated

Deprecated. Use after/before cursors instead.

Required range: 0 <= x <= 9223372036854776000

Response

200

application/json

Successful Response

result · BalanceRead · object[] · required

Show child attributes

success · boolean · default: true

suggestion · string · default: ""

message · string · default: ""

meta · PaginationMeta · object

Pagination metadata for list responses.

Supports both legacy offset-based and cursor-based pagination. Cursor fields (has_more, after, before) are populated for cursor-paginated endpoints. Legacy fields (offset, limit) are populated when the caller uses the deprecated offset parameter.

Show child attributes