SDK Explorer

Initiates a client for Circle's Developer Controlled Wallets.

Parameters
config
object
Required

The client parameters.

apiKey
string
Required

Api Key that is used to authenticate against Circle APIs.

baseUrl
string

Optional base URL to override the default: https://api.circle.com.

headers
Record

Additional headers that should be added to each request.

key
string
value
string
storage
object

Optional custom storage solution for persisting data. We will fallback to InMemoryStorage if none was provided.

userAgent
string

Optional custom user agent request header. We will prepend it to default user agent header if provided.

entitySecret
string
Required

Your configured entity secret.

Example
1import { initiateDeveloperControlledWalletsClient } from '@circle-fin/developer-controlled-wallets'
2
3const client = initiateDeveloperControlledWalletsClient({
4  apiKey: 'YOUR_KEY',
5  entitySecret: 'YOUR_SECRET',
6  baseUrl: 'https://api.circle.com',
7})
8
9const response = await client.listWallets()
10console.log(response.data?.wallets)
Did this page help you?
© 2023-2025 Circle Technology Services, LLC. All rights reserved.