Skip to main content
GET
/
wallets
import cobo_waas2
from cobo_waas2.models.list_wallets200_response import ListWallets200Response
from cobo_waas2.models.wallet_subtype import WalletSubtype
from cobo_waas2.models.wallet_type import WalletType
from cobo_waas2.rest import ApiException
from pprint import pprint

# See configuration.py for a list of all supported configurations.
configuration = cobo_waas2.Configuration(
    # Replace `<YOUR_PRIVATE_KEY>` with your private key
    api_private_key="<YOUR_PRIVATE_KEY>",
    # Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2.
    host="https://api.dev.cobo.com/v2",
)
# Enter a context with an instance of the API client
with cobo_waas2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cobo_waas2.WalletsApi(api_client)
    wallet_type = cobo_waas2.WalletType()
    wallet_subtype = cobo_waas2.WalletSubtype()
    project_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"
    vault_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"
    limit = 10
    before = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1"
    after = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"

    try:
        # List all wallets
        api_response = api_instance.list_wallets(
            wallet_type=wallet_type,
            wallet_subtype=wallet_subtype,
            project_id=project_id,
            vault_id=vault_id,
            limit=limit,
            before=before,
            after=after,
        )
        print("The response of WalletsApi->list_wallets:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WalletsApi->list_wallets: %s\n" % e)


{
  "data": [
    {
      "wallet_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "wallet_type": "Custodial",
      "wallet_subtype": "Asset",
      "name": "Example Wallet",
      "org_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "enable_auto_sweep": true
    }
  ],
  "pagination": {
    "before": "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
    "after": "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
    "total_count": 10000
  }
}
import cobo_waas2
from cobo_waas2.models.list_wallets200_response import ListWallets200Response
from cobo_waas2.models.wallet_subtype import WalletSubtype
from cobo_waas2.models.wallet_type import WalletType
from cobo_waas2.rest import ApiException
from pprint import pprint

# See configuration.py for a list of all supported configurations.
configuration = cobo_waas2.Configuration(
    # Replace `<YOUR_PRIVATE_KEY>` with your private key
    api_private_key="<YOUR_PRIVATE_KEY>",
    # Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2.
    host="https://api.dev.cobo.com/v2",
)
# Enter a context with an instance of the API client
with cobo_waas2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cobo_waas2.WalletsApi(api_client)
    wallet_type = cobo_waas2.WalletType()
    wallet_subtype = cobo_waas2.WalletSubtype()
    project_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"
    vault_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"
    limit = 10
    before = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1"
    after = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"

    try:
        # List all wallets
        api_response = api_instance.list_wallets(
            wallet_type=wallet_type,
            wallet_subtype=wallet_subtype,
            project_id=project_id,
            vault_id=vault_id,
            limit=limit,
            before=before,
            after=after,
        )
        print("The response of WalletsApi->list_wallets:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WalletsApi->list_wallets: %s\n" % e)

Authorizations

​
BIZ-API-KEY
string
header
required

The API key. For more details, refer to API key.

In the API playground, enter your API secret, and your API key will be accordingly calculated.

Query Parameters

​
wallet_type
enum<string>

The wallet type.

The wallet type. Possible values include:

Available options:
Custodial,
MPC,
SmartContract,
Exchange
Example:

"Custodial"

​
wallet_subtype
enum<string>

The wallet subtype.

  • Asset: Custodial Wallets (Asset Wallets)

  • Web3: Custodial Wallets (Web3 Wallets)

  • Main: Exchange Wallets (Main Account)

  • Sub: Exchange Wallets (Sub Account)

  • Org-Controlled: MPC Wallets (Organization-Controlled Wallets)

  • User-Controlled: MPC Wallets (User-Controlled Wallets)

  • Safe{Wallet}: Smart Contract Wallets (Safe{Wallet})

The wallet sub-type. Possible values include:

  • Asset: Custodial Wallets (Asset Wallets).
  • Web3: Custodial Wallets (Web3 Wallets).
  • Org-Controlled: MPC Wallets (Organization-Controlled Wallets).
  • User-Controlled: MPC Wallets (User-Controlled Wallets).
  • Safe{Wallet}: Smart Contract Wallets (Safe).
  • Main: Exchange Wallets (Main Account).
  • Sub: Exchange Wallets (Sub Account).

Each wallet sub-type requires a different set of properties. Switch between the above tabs for details.

Available options:
Asset,
Web3,
Org-Controlled,
User-Controlled,
Safe{Wallet},
Main,
Sub
Example:

"Asset"

​
project_id
string<uuid>

(This parameter is only applicable to User-Controlled Wallets.) The project ID, which you can retrieve by calling List all projects.

​
vault_id
string<uuid>

The vault ID, which you can retrieve by calling List all vaults.

​
limit
integer<int32>
default:10

The maximum number of objects to return. For most operations, the value range is [1, 50].

​
before
string

A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response.

​
after
string

A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response.

Response

Successfully listed wallets

​
data
(Custodial Wallets · object | MPC Wallets · object | Smart Contract Wallets · object | Exchange Wallets · object)[]

The basic information of a wallet.

​
pagination
object

The pagination information of the returned data.