Getting started with the developer-controlled wallets Python SDK

Use the Python SDK to interact with Circle’s Developer-Controlled Wallet APIs, which allow you to embed secure wallets in your applications and create blockchain transactions using the Developer Services platform.

This page provides short examples of how to install and use the developer-controlled wallets SDK. For complete examples, see the Sample Projects page. For more information see the developer-controlled wallets documentation.

Pydantic v2 upgrade

Starting from major version 9, the Python SDK uses Pydantic v2. This change brings performance improvements, enhanced features, and bug fixes.

If you are already using the SDK, and choose to upgrade to major version 9, you may need to make some changes to your code.

For more information, see Server-side SDK Pydantic v2 upgrade.

Prerequisites

To use the Python SDK, ensure you have:

• Python installed.
• A Circle Developer Console account
• An API key created in the Console:
  Keys → Create a key → API key → Standard Key
• Your Entity Secret registered

Although not a requirement for using the SDK, Circle recommends that you use a virtual environment for development. A Python virtual environment is an isolated environment that you can use to silo your project from the global Python environment.

Install the SDK

Use the following command to install the SDK with pip:

pip install circle-developer-controlled-wallets

Developer-controlled wallets client

To start using the SDK, you first need to configure a client and initialize it with your API key and entity secret.

Import the client

The following example shows how to import the client and configure it to use your API key and entity secret:

from circle.web3 import utils

client = utils.init_developer_controlled_wallets_client(
  api_key="Your API KEY",
  entity_secret="Your entity secret"
)

Create a wallet

The following example shows how to create a wallet using the client:

from circle.web3 import developer_controlled_wallets

api_instance = developer_controlled_wallets.WalletSetsApi(client)

# create wallet sets
try:
    request = developer_controlled_wallets.CreateWalletSetRequest.from_dict({
        "name": "my_wallet_set"
    })
    api_instance.create_wallet_set(request)
except developer_controlled_wallets.ApiException as e:
    print("Exception when calling WalletSetsApi->create_wallet_set: %s\n" % e)

# get wallet sets
try:
    response = api_instance.get_wallet_sets()
    for wallet_set in response.data.wallet_sets:
        print(wallet_set.actual_instance.id)
except developer_controlled_wallets.ApiException as e:
    print("Exception when calling WalletSetsApi->get_wallet_sets: %s\n" % e)

Client configuration options

The client for the developer-controlled wallets SDK accepts the following configuration parameters:

Option	Required?	Description
api_key	Yes	The API key used to authenticate requests to the Circle API.
entity_secret	Yes	Your configured entity secret.
host	No	The base URL that overrides the default API URL of https://api.circle.com/v1/w3s.
user_agent	No	Custom user agent request header. If provided, it’s added before the default user agent header.