Skip to main content

User-Controlled Wallets

Project description

circle-user-controlled-wallets

User-Controlled Wallets API documentation.

  • API version: 1.0
  • Package version: 3.0.0

Requirements.

Python 3.7+

Installation

pip install

pip install circle-user-controlled-wallets

Then import the package:

from circle.web3 import user_controlled_wallets

Usage

  1. Generate an API key, if you haven't already, in the Web3 Services Console. This API key will be used for authentication and authorization when making requests to Circle's APIs. API key can be set by environment variable or function parameter
export CIRCLE_WEB3_API_KEY="Your API KEY"
  1. Follow our User-Controlled QuickStart. This step ensures that you fully grasp the concept of Circle's User-Controlled Wallets.

  2. Initiate API client

from circle.web3 import utils

client = utils.init_user_controlled_wallets_client(api_key="Your API KEY")
  1. Interact with the client:
import uuid
from circle.web3 import user_controlled_wallets

# generate a user id
user_id = str(uuid.uuid4())

# create user
api_instance = user_controlled_wallets.UsersApi(client)
try:
    request = user_controlled_wallets.CreateUserRequest(user_id=user_id)
    api_instance.create_user(request)
except user_controlled_wallets.ApiException as e:
    print("Exception when calling UsersApi->create_user: %s\n" % e)

# get user
try:
    response = api_instance.get_user(id=user_id)
    print(response.data)
except user_controlled_wallets.ApiException as e:
    print("Exception when calling UsersApi->get_user: %s\n" % e)

# get user token
try:
    auth_api_instance = user_controlled_wallets.PINAuthenticationApi(client)
    request = user_controlled_wallets.UserTokenRequest.from_dict({"userId": user_id})
    response = auth_api_instance.get_user_token(request)
    print(response)
except user_controlled_wallets.ApiException as e:
    print("Exception when calling PINAuthenticationApi->get_user_token: %s\n" % e)

We recommend reading through the official documentation and QuickStart guides mentioned above to ensure a smooth setup and usage experience.

Configuration

The client accept following configuration parameters:

Option Required Description
api_key Yes Api Key that is used to authenticate against Circle APIs. Must be provided by ether env variable or function parameter.
host No Optional base URL to override the default: https://api.circle.com/v1/w3s.
user_agent No Optional custom user agent request header. We will prepend it to default user agent header if provided.

Need help or have questions?

Here are some helpful links, if you encounter any issues or have questions about this SDK:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

circle_user_controlled_wallets-3.0.0.tar.gz (85.4 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file circle_user_controlled_wallets-3.0.0.tar.gz.

File metadata

File hashes

Hashes for circle_user_controlled_wallets-3.0.0.tar.gz
Algorithm Hash digest
SHA256 41e666897856afd54463f743b7287ab35002eae0564d9f5e9c5f95beaa775a3b
MD5 dfc07e17c092d3f1ee6a71d9d763e3a3
BLAKE2b-256 d1b861cb9b9a2b5199f65852ccc0e358505dd6ef1d36bc9f31035dbad5fe7a3b

See more details on using hashes here.

File details

Details for the file circle_user_controlled_wallets-3.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for circle_user_controlled_wallets-3.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0551c26e3f2b1d1e3610468844088aba5c3f16c794960d2d781261cf16c73989
MD5 b2ca5d54fa18bde184f6608600966e41
BLAKE2b-256 f4afe6058f8b9bcfb12cffe79e3ba4c28c6f3fd812937149306492595969ba9c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page