listWallets | Circle

SDK Explorer

Developer Controlled Wallets

Getting Started

Methods Overview

Developer Account

Initialization

Transactions

Monitored Tokens

Webhook Subscriptions

Wallets

Wallet Sets

Token Lookup

Faucet

Signing

listWalletsNode.js,latest

Go to NPM

Retrieves a list of user-controlled wallets.

Parameters

input

object

Required

Represents the input for listing wallets.

option 1:

Show 10 properties

userId

string

Required

Unique system-generated identifier for the user.

address

string

The address of the wallet to filter by.

blockchain

string

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.

walletSetId

string

The ID of the wallet set to filter by.

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.

option 2:

Show 10 properties

userToken

string

Required

The JSON Web Token (JWT) representing the user.

address

string

The address of the wallet to filter by.

blockchain

string

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.

walletSetId

string

The ID of the wallet set to filter by.

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 - WalletsResponse

Response Body

object

data

object

Required

Show 1 properties

wallets

array of objects

Required

option 1: EOAWallet

Show 13 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

option 2: SCAWallet

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 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

Error - NotAuthorizedResponse

Example

1const response = await client.listWallets({
2  userToken: 'dummy-user-token',
3})
4console.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      }
19    ]
20  }
21}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy