getWalletsWithBalances

SDK Explorer

Developer Controlled Wallets

Getting Started

Methods Overview

Developer Account

Initialization

Transactions

Monitored Tokens

Webhook Subscriptions

Wallets

Wallet Sets

Token Lookup

Faucet

Signing

getWalletsWithBalancesNode.js,latest

Go to NPM

Retrieves a list of all wallets that fit the specified parameters, including native balances and USDC/EURC token balances if specified.

NOTE: Balances update automatically with transfers or via the Get token balance for a wallet for accuracy.

Parameters

input

object

Required

Represents the input for listing wallets.

Show 12 properties

address

string

The address of the wallet to filter by.

amountGte

string

Filters wallets where the balance is greater than or equal to the specified amount. Applies to the specified token if tokenAddress is provided; otherwise, to the native token.

blockchain

string

Required

The blockchain network that the resource is to be created on or is currently on.

Allowed valuesARBARB-SEPOLIAAVAXAVAX-FUJIBASEBASE-SEPOLIAETHETH-SEPOLIAEVMEVM-TESTNETMATICMATIC-AMOYNEARNEAR-TESTNETOPOP-SEPOLIASOLSOL-DEVNETUNIUNI-SEPOLIA

refId

string

Reference or description used to identify the wallet.

tokenAddress

string

Blockchain address of the transferred token. Empty for native tokens.

walletSetId

string

The ID of the wallet set to filter by.

xRequestId

string

Developer-provided parameter used to identify this request.

from

string

Start time of the query, inclusive.

pageAfter

string

Used to return items after the specified item exclusively. SHOULD NOT be used in conjunction with pageBefore.

pageBefore

string

Used to return items before the specified item exclusively. SHOULD NOT be used in conjunction with pageAfter.

pageSize

number

The number of items to return.

string

End time of the query, inclusive. Defaults to the current time.

Responses

Data - WalletsWithBalancesResponse

Response Body

object

data

object

Required

Show 1 properties

wallets

array of objects

Required

option 1: EOAWalletWithBalances

Show 14 properties

string

Required

System-generated unique identifier of the resource.

address

string

Required

Blockchain generated unique identifier, associated with wallet (account), smart contract or other blockchain objects.

blockchain

string

Required

The blockchain network that the resource is to be created on or is currently on.

Allowed valuesETHETH-SEPOLIAAVAXAVAX-FUJIMATICMATIC-AMOYSOLSOL-DEVNETARBARB-SEPOLIANEARNEAR-TESTNETEVMEVM-TESTNETUNIUNI-SEPOLIABASEBASE-SEPOLIAOPOP-SEPOLIA

createDate

string

Required

Date and time the resource was created, in ISO-8601 UTC format.

updateDate

string

Required

Date and time the resource was last updated, in ISO-8601 UTC format.

custodyType

string

Required

Describes who controls the digital assets in a wallet: either the end-user or the developer.

Allowed valuesDEVELOPERENDUSER

name

string

Name or description associated with the wallet or walletSet.

refId

string

Reference or description used to identify the object.

state

string

Required

This enum describes the current state of the wallet.

Allowed valuesLIVEFROZEN

userId

string

Unique system generated identifier for the user.

walletSetId

string

Required

System-generated unique identifier of the resource.

initialPublicKey

string

For NEAR blockchains only, the originally assigned public key of a wallet at the time of its creation.

accountType

string

Required

An account can be a Smart Contract Account (SCA) or an Externally Owned Account (EOA). To learn more, see the account types guide.

If an account type is not specified during the creation of a wallet, it defaults to EOA (Externally Owned Account). Note that Solana doesn't support Smart Contract Account (SCA).

Allowed valuesEOA

tokenBalances

array of objects

Required

Lists native token balances and, if specified, USDC/EURC balances for the wallets.

Show 3 properties

amount

string

Required

Token balance for each token in the wallet.

token

object

Required

Show 10 properties

string

Required

System-generated unique identifier of the resource.

name

string

Blockchain name of the specified token.

standard

string

Allowed valuesERC20ERC721ERC1155FungibleFungibleAssetNonFungibleNonFungibleEditionProgrammableNonFungibleProgrammableNonFungibleEdition

blockchain

string

Required

The blockchain network that the resource is to be created on or is currently on.

Allowed valuesETHETH-SEPOLIAAVAXAVAX-FUJIMATICMATIC-AMOYSOLSOL-DEVNETARBARB-SEPOLIANEARNEAR-TESTNETEVMEVM-TESTNETUNIUNI-SEPOLIABASEBASE-SEPOLIAOPOP-SEPOLIA

decimals

integer

Number of decimal places shown in the token amount.

isNative

boolean

Required

Defines if the token is a native token of the specified blockchain. If TRUE, the token is a native token.

symbol

string

Blockchain symbol of the specified token.

tokenAddress

string

Blockchain generated unique identifier, associated with wallet (account), smart contract or other blockchain objects.

updateDate

string

Required

Date and time the resource was last updated, in ISO-8601 UTC format.

createDate

string

Required

Date and time the resource was created, in ISO-8601 UTC format.

updateDate

string

Required

Date and time the resource was last updated, in ISO-8601 UTC format.

option 2: SCAWalletWithBalances

Show 15 properties

string

Required

System-generated unique identifier of the resource.

address

string

Required

Blockchain generated unique identifier, associated with wallet (account), smart contract or other blockchain objects.

blockchain

string

Required

The blockchain network that the resource is to be created on or is currently on.

Allowed valuesETHETH-SEPOLIAAVAXAVAX-FUJIMATICMATIC-AMOYSOLSOL-DEVNETARBARB-SEPOLIANEARNEAR-TESTNETEVMEVM-TESTNETUNIUNI-SEPOLIABASEBASE-SEPOLIAOPOP-SEPOLIA

createDate

string

Required

Date and time the resource was created, in ISO-8601 UTC format.

updateDate

string

Required

Date and time the resource was last updated, in ISO-8601 UTC format.

custodyType

string

Required

Describes who controls the digital assets in a wallet: either the end-user or the developer.

Allowed valuesDEVELOPERENDUSER

name

string

Name or description associated with the wallet or walletSet.

refId

string

Reference or description used to identify the object.

state

string

Required

This enum describes the current state of the wallet.

Allowed valuesLIVEFROZEN

userId

string

Unique system generated identifier for the user.

walletSetId

string

Required

System-generated unique identifier of the resource.

initialPublicKey

string

For NEAR blockchains only, the originally assigned public key of a wallet at the time of its creation.

accountType

string

Required

An account can be a Smart Contract Account (SCA) or an Externally Owned Account (EOA). To learn more, see the account types guide.

If an account type is not specified during the creation of a wallet, it defaults to EOA (Externally Owned Account). Note that Solana doesn't support Smart Contract Account (SCA).

Allowed valuesSCA

scaCore

string

Required

SCAs have different versions, each with unique functionality. SCACore displays the version of the SCA being created. For a list of supported versions, refer to the developer documentation.

Allowed valuescircle_4337_v1circle_6900_singleowner_v1circle_6900_singleowner_v2circle_6900_singleowner_v3

tokenBalances

array of objects

Required

Lists native token balances and, if specified, USDC/EURC balances for the wallets.

Show 3 properties

amount

string

Required

Token balance for each token in the wallet.

token

object

Required

Show 10 properties

string

Required

System-generated unique identifier of the resource.

name

string

Blockchain name of the specified token.

standard

string

Allowed valuesERC20ERC721ERC1155FungibleFungibleAssetNonFungibleNonFungibleEditionProgrammableNonFungibleProgrammableNonFungibleEdition

blockchain

string

Required

The blockchain network that the resource is to be created on or is currently on.

Allowed valuesETHETH-SEPOLIAAVAXAVAX-FUJIMATICMATIC-AMOYSOLSOL-DEVNETARBARB-SEPOLIANEARNEAR-TESTNETEVMEVM-TESTNETUNIUNI-SEPOLIABASEBASE-SEPOLIAOPOP-SEPOLIA

decimals

integer

Number of decimal places shown in the token amount.

isNative

boolean

Required

Defines if the token is a native token of the specified blockchain. If TRUE, the token is a native token.

symbol

string

Blockchain symbol of the specified token.

tokenAddress

string

Blockchain generated unique identifier, associated with wallet (account), smart contract or other blockchain objects.

updateDate

string

Required

Date and time the resource was last updated, in ISO-8601 UTC format.

createDate

string

Required

Date and time the resource was created, in ISO-8601 UTC format.

updateDate

string

Required

Date and time the resource was last updated, in ISO-8601 UTC format.

Error - NotAuthorizedResponse

Example

1const response = await client.getWalletsWithBalances({
2 blockchain: 'ETH-SEPOLIA',
3 amountGte: '1',
4})
5console.log(response.data?.wallets)

ResponseChoose an example

1{
2  "data": {
3    "wallets": [
4      {
5        "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
6        "address": "0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350",
7        "blockchain": "MATIC-AMOY",
8        "createDate": "2023-01-01T12:04:05Z",
9        "updateDate": "2023-01-01T12:04:05Z",
10        "custodyType": "DEVELOPER",
11        "name": "",
12        "refId": "custom_ref_id",
13        "state": "LIVE",
14        "userId": "ext_user_id_1",
15        "walletSetId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
16        "initialPublicKey": "3eQoJ3ex6uWX3R8F1THF6Y6oBQwPYpF1X9HBM1gjqw7w",
17        "accountType": "EOA",
18        "tokenBalances": [
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              "isNative": false,
28              "symbol": "",
29              "tokenAddress": "0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350",
30              "updateDate": "2023-01-01T12:04:05Z",
31              "createDate": "2023-01-01T12:04:05Z"
32            },
33            "updateDate": "2023-01-01T12:04:05Z"
34          }
35        ]
36      }
37    ]
38  }
39}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy