get_wallet | Circle

SDK Explorer

Getting Started

get_walletPython,latest

Go to PyPI

Retrieves info for a single user-controlled wallet using it's unique identifier.

Parameters

string

Required

The universally unique identifier of the resource.

x_user_token

string

Required

Unique system generated JWT session token for specific user.

x_request_id

string

Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.

Responses

200WalletResponse

Response Body

object

data

object

Required

Show 1 properties

wallet

object

Required

option_1: EOAWallet

Show 13 properties

string

Required

System-generated unique identifier of the resource.

address

string

Required

Blockchain generated unique identifier, associated with wallet (account), smart contract or other blockchain objects.

blockchain

string

Required

The blockchain network that the resource is to be created on or is currently on.

Allowed valuesETHETH-SEPOLIAAVAXAVAX-FUJIMATICMATIC-AMOYSOLSOL-DEVNETARBARB-SEPOLIANEARNEAR-TESTNETEVMEVM-TESTNETUNIUNI-SEPOLIABASEBASE-SEPOLIAOPOP-SEPOLIAAPTOSAPTOS-TESTNET

create_date

string

Required

Date and time the resource was created, in ISO-8601 UTC format.

update_date

string

Required

Date and time the resource was last updated, in ISO-8601 UTC format.

custody_type

string

Required

Describes who controls the digital assets in a wallet: either the end-user or the developer.

Allowed valuesDEVELOPERENDUSER

name

string

Name or description associated with the wallet or walletSet.

ref_id

string

Reference or description used to identify the object.

state

string

Required

This enum describes the current state of the wallet.

Allowed valuesLIVEFROZEN

user_id

string

Unique system generated identifier for the user.

wallet_set_id

string

Required

System-generated unique identifier of the resource.

initial_public_key

string

For NEAR blockchains only, the originally assigned public key of a wallet at the time of its creation.

account_type

string

Required

An account can be a Smart Contract Account (SCA) or an Externally Owned Account (EOA). To learn more, see the account types guide.

If an account type is not specified during the creation of a wallet, it defaults to EOA (Externally Owned Account). Note that Solana and Aptos don't support Smart Contract Account (SCA).

Allowed valuesEOA

option_2: SCAWallet

Show 14 properties

string

Required

System-generated unique identifier of the resource.

address

string

Required

Blockchain generated unique identifier, associated with wallet (account), smart contract or other blockchain objects.

blockchain

string

Required

The blockchain network that the resource is to be created on or is currently on.

Allowed valuesETHETH-SEPOLIAAVAXAVAX-FUJIMATICMATIC-AMOYSOLSOL-DEVNETARBARB-SEPOLIANEARNEAR-TESTNETEVMEVM-TESTNETUNIUNI-SEPOLIABASEBASE-SEPOLIAOPOP-SEPOLIAAPTOSAPTOS-TESTNET

create_date

string

Required

Date and time the resource was created, in ISO-8601 UTC format.

update_date

string

Required

Date and time the resource was last updated, in ISO-8601 UTC format.

custody_type

string

Required

Describes who controls the digital assets in a wallet: either the end-user or the developer.

Allowed valuesDEVELOPERENDUSER

name

string

Name or description associated with the wallet or walletSet.

ref_id

string

Reference or description used to identify the object.

state

string

Required

This enum describes the current state of the wallet.

Allowed valuesLIVEFROZEN

user_id

string

Unique system generated identifier for the user.

wallet_set_id

string

Required

System-generated unique identifier of the resource.

initial_public_key

string

For NEAR blockchains only, the originally assigned public key of a wallet at the time of its creation.

account_type

string

Required

An account can be a Smart Contract Account (SCA) or an Externally Owned Account (EOA). To learn more, see the account types guide.

If an account type is not specified during the creation of a wallet, it defaults to EOA (Externally Owned Account). Note that Solana and Aptos don't support Smart Contract Account (SCA).

Allowed valuesSCA

sca_core

string

Required

SCAs have different versions, each with unique functionality. SCACore displays the version of the SCA being created. For a list of supported versions, refer to the developer documentation.

Allowed valuescircle_4337_v1circle_6900_singleowner_v1circle_6900_singleowner_v2circle_6900_singleowner_v3

401NotAuthorizedResponse

404NotFoundResponse

Example

1from circle.web3 import user_controlled_wallets
2from circle.web3 import utils
3
4client = utils.init_user_controlled_wallets_client(api_key=key)
5
6api_instance = user_controlled_wallets.WalletsApi(client)
7
8response = api_instance.get_wallet(x_user_token=user_token, id='290926b7-3790-5789-a7a9-594a9b99f1cc')
9print(response.json())
10

ResponseChoose an example

1{
2  "data": {
3    "wallet": {
4      "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
5      "address": "0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350",
6      "blockchain": "MATIC-AMOY",
7      "create_date": "2023-01-01T12:04:05Z",
8      "update_date": "2023-01-01T12:04:05Z",
9      "custody_type": "DEVELOPER",
10      "name": "",
11      "ref_id": "custom_ref_id",
12      "state": "LIVE",
13      "user_id": "ext_user_id_1",
14      "wallet_set_id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
15      "initial_public_key": "3eQoJ3ex6uWX3R8F1THF6Y6oBQwPYpF1X9HBM1gjqw7w",
16      "account_type": "EOA"
17    }
18  }
19}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy