Skip to main content
GET
/
v1
/
w3s
/
wallets
List wallets
curl --request GET \
  --url https://api.circle.com/v1/w3s/wallets \
  --header 'Authorization: Bearer <token>' \
  --header 'X-User-Token: <x-user-token>'
{
  "data": {
    "wallets": [
      {
        "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
        "address": "0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350",
        "blockchain": "MATIC-AMOY",
        "createDate": "2023-01-01T12:04:05Z",
        "updateDate": "2023-01-01T12:04:05Z",
        "custodyType": "DEVELOPER",
        "name": "<string>",
        "refId": "custom_ref_id",
        "state": "LIVE",
        "userId": "ext_user_id_1",
        "walletSetId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
        "initialPublicKey": "3eQoJ3ex6uWX3R8F1THF6Y6oBQwPYpF1X9HBM1gjqw7w",
        "accountType": "EOA"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Circle's API Keys are formatted in the following structure "PREFIX:ID:SECRET". All three parts are requred to make a successful request.

Headers

​
X-User-Token
string
required

Unique system generated JWT session token for specific user.

​
X-Request-Id
string

Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.

Example:

"2adba88e-9d63-44bc-b975-9b6ae3440dde"

Query Parameters

​
address
string

Filter by the blockchain address of the wallet.

Example:

"0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350"

​
blockchain
enum<string>

Filter by blockchain.

Available options:
ETH,
ETH-SEPOLIA,
AVAX,
AVAX-FUJI,
MATIC,
MATIC-AMOY,
SOL,
SOL-DEVNET,
ARB,
ARB-SEPOLIA,
NEAR,
NEAR-TESTNET,
EVM,
EVM-TESTNET,
UNI,
UNI-SEPOLIA,
BASE,
BASE-SEPOLIA,
OP,
OP-SEPOLIA,
APTOS,
APTOS-TESTNET
Example:

"MATIC-AMOY"

​
scaCore
enum<string>

Filters results by the SCA version.

Available options:
circle_4337_v1,
circle_6900_singleowner_v1,
circle_6900_singleowner_v2,
circle_6900_singleowner_v3
Example:

"circle_6900_singleowner_v2"

​
walletSetId
string<uuid>

Filter by the wallet set.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

​
refId
string

Filter by the reference identifier.

Example:

"custom_ref_id"

​
from
string<date-time>

Queries items created since the specified date-time (inclusive) in ISO 8601 format.

Example:

"2023-01-01T12:04:05Z"

​
to
string<date-time>

Queries items created before the specified date-time (inclusive) in ISO 8601 format.

Example:

"2023-01-01T12:04:05Z"

​
pageBefore
string<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
string<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
default: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.

Required range: 1 <= x <= 50
​
order
enum<string>
default:DESC

Specifies the sort order of the collection by CreateDate.

Valid values:

  • ASC – Sort results in ascending order.
  • DESC – Sort results in descending order (default).
Available options:
ASC,
DESC

Response

Successfully retrieved wallets.

​
data
object
required