# 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
```sh
pip install circle-user-controlled-wallets
```
Then import the package:
```python
from circle.web3 import user_controlled_wallets
```
## Usage
1. Generate an API key, if you haven't already, in the [Web3 Services Console](https://console.circle.com/). 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
```sh
export CIRCLE_WEB3_API_KEY="Your API KEY"
```
2. Follow our [User-Controlled QuickStart](https://developers.circle.com/interactive-quickstarts/user-controlled-wallets). This step ensures that you fully grasp the concept of Circle's User-Controlled Wallets.
3. Initiate API client
```python
from circle.web3 import utils
client = utils.init_user_controlled_wallets_client(api_key="Your API KEY")
```
4. Interact with the client:
```python
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](https://developers.circle.com/w3s/docs) and [QuickStart guides](https://developers.circle.com/interactive-quickstarts) 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:
- 📖 [Getting started](https://developers.circle.com/interactive-quickstarts/user-controlled-wallets): Check out our official Developer-Controlled Wallets QuickStart.
- 🎮 [Join our Discord Community](https://discord.com/invite/buildoncircle): Engage, learn, and collaborate.
- 🛎 [Visit our Help-Desk Page](https://support.usdc.circle.com/hc/en-us/p/contactus?_gl=1*1va6vat*_ga*MTAyNTA0NTQ2NC4xNjk5NTYyMjgx*_ga_GJDVPCQNRV*MTcwMDQ5Mzg3Ny4xNC4xLjE3MDA0OTM4ODQuNTMuMC4w): Dive into curated FAQs and guides.
- 📧 [Direct Email](mailto:customer-support@circle.com): We're always a message away.
- 📖 [Read docs](https://developers.circle.com/w3s/docs?_gl=1*15ozb5b*_ga*MTAyNTA0NTQ2NC4xNjk5NTYyMjgx*_ga_GJDVPCQNRV*MTcwMDQ5Mzg3Ny4xNC4xLjE3MDA0OTM4ODQuNTMuMC4w): Check out our developer documentation.
Happy coding!
Raw data
{
"_id": null,
"home_page": null,
"name": "circle-user-controlled-wallets",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, User-Controlled Wallets",
"author": "OpenAPI Generator community",
"author_email": "team@openapitools.org",
"download_url": "https://files.pythonhosted.org/packages/d1/b8/61cb9b9a2b5199f65852ccc0e358505dd6ef1d36bc9f31035dbad5fe7a3b/circle_user_controlled_wallets-3.0.0.tar.gz",
"platform": null,
"description": "# circle-user-controlled-wallets\nUser-Controlled Wallets API documentation.\n\n- API version: 1.0\n- Package version: 3.0.0\n\n## Requirements.\n\nPython 3.7+\n\n## Installation\n### pip install\n\n```sh\npip install circle-user-controlled-wallets\n```\n\nThen import the package:\n```python\nfrom circle.web3 import user_controlled_wallets\n```\n\n\n## Usage\n\n1. Generate an API key, if you haven't already, in the [Web3 Services Console](https://console.circle.com/). 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\n\n```sh\nexport CIRCLE_WEB3_API_KEY=\"Your API KEY\"\n```\n\n2. Follow our [User-Controlled QuickStart](https://developers.circle.com/interactive-quickstarts/user-controlled-wallets). This step ensures that you fully grasp the concept of Circle's User-Controlled Wallets.\n\n3. Initiate API client\n\n```python\nfrom circle.web3 import utils\n\nclient = utils.init_user_controlled_wallets_client(api_key=\"Your API KEY\")\n```\n\n4. Interact with the client:\n\n```python\nimport uuid\nfrom circle.web3 import user_controlled_wallets\n\n# generate a user id\nuser_id = str(uuid.uuid4())\n\n# create user\napi_instance = user_controlled_wallets.UsersApi(client)\ntry:\n request = user_controlled_wallets.CreateUserRequest(user_id=user_id)\n api_instance.create_user(request)\nexcept user_controlled_wallets.ApiException as e:\n print(\"Exception when calling UsersApi->create_user: %s\\n\" % e)\n\n# get user\ntry:\n response = api_instance.get_user(id=user_id)\n print(response.data)\nexcept user_controlled_wallets.ApiException as e:\n print(\"Exception when calling UsersApi->get_user: %s\\n\" % e)\n\n# get user token\ntry:\n auth_api_instance = user_controlled_wallets.PINAuthenticationApi(client)\n request = user_controlled_wallets.UserTokenRequest.from_dict({\"userId\": user_id})\n response = auth_api_instance.get_user_token(request)\n print(response)\nexcept user_controlled_wallets.ApiException as e:\n print(\"Exception when calling PINAuthenticationApi->get_user_token: %s\\n\" % e)\n```\n\nWe recommend reading through the official [documentation](https://developers.circle.com/w3s/docs) and [QuickStart guides](https://developers.circle.com/interactive-quickstarts) mentioned above to ensure a smooth setup and usage experience.\n\n\n## Configuration\n\nThe client accept following configuration parameters:\n\nOption | Required | Description\n------------ | ------------- | -------------\napi_key | Yes | Api Key that is used to authenticate against Circle APIs. Must be provided by ether env variable or function parameter.\nhost | No | Optional base URL to override the default: https://api.circle.com/v1/w3s.\nuser_agent | No | Optional custom user agent request header. We will prepend it to default user agent header if provided.\n\n\n## Need help or have questions?\n\nHere are some helpful links, if you encounter any issues or have questions about this SDK:\n\n- \ud83d\udcd6 [Getting started](https://developers.circle.com/interactive-quickstarts/user-controlled-wallets): Check out our official Developer-Controlled Wallets QuickStart.\n- \ud83c\udfae [Join our Discord Community](https://discord.com/invite/buildoncircle): Engage, learn, and collaborate.\n- \ud83d\udece [Visit our Help-Desk Page](https://support.usdc.circle.com/hc/en-us/p/contactus?_gl=1*1va6vat*_ga*MTAyNTA0NTQ2NC4xNjk5NTYyMjgx*_ga_GJDVPCQNRV*MTcwMDQ5Mzg3Ny4xNC4xLjE3MDA0OTM4ODQuNTMuMC4w): Dive into curated FAQs and guides.\n- \ud83d\udce7 [Direct Email](mailto:customer-support@circle.com): We're always a message away.\n- \ud83d\udcd6 [Read docs](https://developers.circle.com/w3s/docs?_gl=1*15ozb5b*_ga*MTAyNTA0NTQ2NC4xNjk5NTYyMjgx*_ga_GJDVPCQNRV*MTcwMDQ5Mzg3Ny4xNC4xLjE3MDA0OTM4ODQuNTMuMC4w): Check out our developer documentation.\nHappy coding!\n",
"bugtrack_url": null,
"license": null,
"summary": "User-Controlled Wallets",
"version": "3.0.0",
"project_urls": null,
"split_keywords": [
"openapi",
" openapi-generator",
" user-controlled wallets"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f4afe6058f8b9bcfb12cffe79e3ba4c28c6f3fd812937149306492595969ba9c",
"md5": "b2ca5d54fa18bde184f6608600966e41",
"sha256": "0551c26e3f2b1d1e3610468844088aba5c3f16c794960d2d781261cf16c73989"
},
"downloads": -1,
"filename": "circle_user_controlled_wallets-3.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b2ca5d54fa18bde184f6608600966e41",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 168157,
"upload_time": "2024-10-31T14:54:46",
"upload_time_iso_8601": "2024-10-31T14:54:46.776229Z",
"url": "https://files.pythonhosted.org/packages/f4/af/e6058f8b9bcfb12cffe79e3ba4c28c6f3fd812937149306492595969ba9c/circle_user_controlled_wallets-3.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d1b861cb9b9a2b5199f65852ccc0e358505dd6ef1d36bc9f31035dbad5fe7a3b",
"md5": "dfc07e17c092d3f1ee6a71d9d763e3a3",
"sha256": "41e666897856afd54463f743b7287ab35002eae0564d9f5e9c5f95beaa775a3b"
},
"downloads": -1,
"filename": "circle_user_controlled_wallets-3.0.0.tar.gz",
"has_sig": false,
"md5_digest": "dfc07e17c092d3f1ee6a71d9d763e3a3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 85426,
"upload_time": "2024-10-31T14:54:55",
"upload_time_iso_8601": "2024-10-31T14:54:55.747584Z",
"url": "https://files.pythonhosted.org/packages/d1/b8/61cb9b9a2b5199f65852ccc0e358505dd6ef1d36bc9f31035dbad5fe7a3b/circle_user_controlled_wallets-3.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-31 14:54:55",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "circle-user-controlled-wallets"
}
JSON