We refreshed our doc site!

Bookmarked links may have changed

Read release notes

listWalletBalance

Web3 Services
Compliance Engine

Get token balance for a wallet

GEThttps://api.circle.com/v1/w3s/wallets/{id}/balances

Fetches the digital asset balance for a single developer-controlled wallet using its unique identifier.

Path parameters
id
string
Required

Wallet ID

Query parameters
includeAll
boolean

Return all recourses with monitored and non-monitored tokens.

name
string

Filter by token name.

tokenAddress
string

Filter by token addresses.

standard
string

Filter by the token standard. ERC20/ERC721/ERC1155 are the standards for EVM chains, Fungible/FungibleAsset/NonFungible/NonFungibleEdition/ProgrammableNonFungible/ProgrammableNonFungibleEdition are the standards for the Solana chain.

pageBefore
uuid

A collection ID value used for pagination.

It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize.

The items will be returned in the natural order of the collection.

The resource will return the first page if neither pageAfter nor pageBefore are specified.

SHOULD NOT be used in conjunction with pageAfter.

pageAfter
uuid

A collection ID value used for pagination.

It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize.

The items will be returned in the natural order of the collection.

The resource will return the first page if neither pageAfter nor pageBefore are specified.

SHOULD NOT be used in conjunction with pageBefore.

pageSize
integer
1 to 50
Default is 10

Limits the number of items to be returned.

Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used.

If avoided, the collection will determine the page size itself.

Response
RequestChoose a language
ResponseChoose an example
1{
2  "data": {
3    "tokenBalances": [
4      {
5        "amount": "6.62607015",
6        "token": {
7          "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
8          "name": "",
9          "standard": "ERC20",
10          "blockchain": "MATIC-AMOY",
11          "decimals": 0,
12          "isNative": false,
13          "symbol": "",
14          "tokenAddress": "",
15          "updateDate": "2023-01-01T12:04:05Z",
16          "createDate": "2023-01-01T12:04:05Z"
17        },
18        "updateDate": "2023-01-01T12:04:05Z"
19      }
20    ]
21  }
22}
Did this page help you?
© 2023-2024 Circle Technology Services, LLC. All rights reserved.