Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.circle.com/llms.txt

Use this file to discover all available pages before exploring further.

Use the Python SDK to interact with Contracts APIs, which allow you interact with smart contracts on the blockchain using the Developer Services platform. This page provides short examples of how to install and use the Smart Contract Platform SDK. For complete examples, see the Sample Projects page. For more information see the Contracts documentation.
Pydantic v2 upgradeStarting 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: 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-smart-contract-platform

​
Contracts 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_smart_contract_platform_client(
  api_key="Your API KEY",
  entity_secret="Your entity secret"
)

​
Import a smart contract

The following example shows how to import a smart contract using the client: 
from circle.web3 import smart_contract_platform

api_instance = smart_contract_platform.DeployImportApi(client)

# import contract
try:
    request = smart_contract_platform.ImportContractRequest.from_dict({
        "name": "UChildERC20Proxy",
        "address": "0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174",
        "blockchain": "MATIC"
    })
    response = api_instance.import_contract(request)
    print(response)
except smart_contract_platform.ApiException as e:
    print("Exception when calling DeployImportApi->import_contract: %s\n" % e)

​
Client configuration options

The client for the Contracts SDK accepts the following configuration parameters:
OptionRequired?Description
api_keyYesThe API key used to authenticate requests to the Circle API.
entity_secretYesYour configured entity secret.
hostNoThe base URL that overrides the default API URL of https://api.circle.com/v1/w3s.
user_agentNoCustom user agent request header. If provided, it’s added before the default user agent header.