get_wallets_with_balancesPython,latest
Go to PyPIRetrieves a list of wallets that match the specified parameters, including native token balances and, if specified, USDC/EURC balances. Balances update automatically with transfers or using the Get token balance for a wallet endpoint for accuracy.
Parameters
blockchain
string
Required
Filter by blockchain.
Allowed valuesETHETH-SEPOLIAAVAXAVAX-FUJIMATICMATIC-AMOYSOLSOL-DEVNETARBARB-SEPOLIANEARNEAR-TESTNETEVMEVM-TESTNETUNIUNI-SEPOLIABASEBASE-SEPOLIAOPOP-SEPOLIA
x_request_id
string
Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
address
string
Filter by the blockchain address of the wallet.
sca_core
string
Filters results by the SCA version.
Allowed valuescircle_4337_v1circle_6900_singleowner_v1circle_6900_singleowner_v2circle_6900_singleowner_v3
wallet_set_id
string
Filter by the wallet set.
ref_id
string
Filter by the reference identifier.
amount_gte
string
Filters wallets with a balance greater than or equal to the specified amount. If tokenAddress is provided, the filter applies to the specified token; otherwise, it applies to the native token.
token_address
string
Filter by token address.
from
string
Queries items created since the specified date-time (inclusive) in ISO 8601 format.
to
string
Queries items created before the specified date-time (inclusive) in ISO 8601 format.
page_before
string
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.
page_after
string
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.
page_size
integer
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.
Responses
Example
1from circle.web3 import developer_controlled_wallets
2from circle.web3 import utils
3
4client = utils.init_developer_controlled_wallets_client(api_key=key, entity_secret=entitySecret)
5
6api_instance = developer_controlled_wallets.WalletsApi(client)
7response = api_instance.get_wallets_with_balances(blockchain="ETH-SEPOLIA")
8print(response.json())
9ResponseChoose an example
1{
2 "data": {
3 "wallets": [
4 {
5 "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
6 "address": "0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350",
7 "blockchain": "MATIC-AMOY",
8 "create_date": "2023-01-01T12:04:05Z",
9 "update_date": "2023-01-01T12:04:05Z",
10 "custody_type": "DEVELOPER",
11 "name": "",
12 "ref_id": "custom_ref_id",
13 "state": "LIVE",
14 "user_id": "ext_user_id_1",
15 "wallet_set_id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
16 "initial_public_key": "3eQoJ3ex6uWX3R8F1THF6Y6oBQwPYpF1X9HBM1gjqw7w",
17 "account_type": "EOA",
18 "token_balances": [
19 {
20 "amount": "6.62607015",
21 "token": {
22 "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
23 "name": "",
24 "standard": "ERC20",
25 "blockchain": "MATIC-AMOY",
26 "decimals": 0,
27 "is_native": false,
28 "symbol": "",
29 "token_address": "0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350",
30 "update_date": "2023-01-01T12:04:05Z",
31 "create_date": "2023-01-01T12:04:05Z"
32 },
33 "update_date": "2023-01-01T12:04:05Z"
34 }
35 ]
36 }
37 ]
38 }
39}Did this page help you?
© 2023-2025 Circle Technology Services, LLC. All rights reserved.
