> ## Documentation Index
> Fetch the complete documentation index at: https://cobo.com/developers/llms.txt
> Use this file to discover all available pages before exploring further.
# Get wallet information
> This operation retrieves the detailed information about a specified wallet.
Try [Cobo WaaS Skill](/v2/guides/overview/cobo-waas-skill) in your AI coding assistant (Claude Code, Cursor, etc.). Describe your needs in natural language to auto-generate production-ready SDK code and debug faster 🚀
```python Python theme={null}
import cobo_waas2
from cobo_waas2.models.wallet_info import WalletInfo
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 `` with your private key
api_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_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"
try:
# Get wallet information
api_response = api_instance.get_wallet_by_id(wallet_id)
print("The response of WalletsApi->get_wallet_by_id:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling WalletsApi->get_wallet_by_id: %s\n" % e)
```
```java Java theme={null}
// Import classes:
import com.cobo.waas2.ApiClient;
import com.cobo.waas2.ApiException;
import com.cobo.waas2.Configuration;
import com.cobo.waas2.Env;
import com.cobo.waas2.api.WalletsApi;
import com.cobo.waas2.model.*;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Select the development environment. To use the production environment, replace `Env.DEV` with
// `Env.PROD
defaultClient.setEnv(Env.DEV);
// Replace `` with your private key
defaultClient.setPrivKey("");
WalletsApi apiInstance = new WalletsApi();
UUID walletId = UUID.fromString("f47ac10b-58cc-4372-a567-0e02b2c3d479");
try {
WalletInfo result = apiInstance.getWalletById(walletId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling WalletsApi#getWalletById");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
```
```go Go theme={null}
package main
import (
"context"
"fmt"
coboWaas2 "github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2"
"github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2/crypto"
"os"
)
func main() {
walletId := "f47ac10b-58cc-4372-a567-0e02b2c3d479"
configuration := coboWaas2.NewConfiguration()
// Initialize the API client
apiClient := coboWaas2.NewAPIClient(configuration)
ctx := context.Background()
// Select the development environment. To use the production environment, replace coboWaas2.DevEnv with coboWaas2.ProdEnv
ctx = context.WithValue(ctx, coboWaas2.ContextEnv, coboWaas2.DevEnv)
// Replace `` with your private key
ctx = context.WithValue(ctx, coboWaas2.ContextPortalSigner, crypto.Ed25519Signer{
Secret: "",
})
resp, r, err := apiClient.WalletsAPI.GetWalletById(ctx, walletId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `WalletsAPI.GetWalletById``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetWalletById`: WalletInfo
fmt.Fprintf(os.Stdout, "Response from `WalletsAPI.GetWalletById`: %v\n", resp)
}
```
```javascript JavaScript theme={null}
const CoboWaas2 = require("@cobo/cobo-waas2");
// Initialize the API client
const apiClient = CoboWaas2.ApiClient.instance;
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
apiClient.setEnv(CoboWaas2.Env.DEV);
// Replace `` with your private key
apiClient.setPrivateKey("");
// Call the API
const apiInstance = new CoboWaas2.WalletsApi();
const wallet_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
apiInstance.getWalletById(wallet_id).then(
(data) => {
console.log("API called successfully. Returned data: " + data);
},
(error) => {
console.error(error);
},
);
```
## OpenAPI
````yaml get /wallets/{wallet_id}
openapi: 3.0.3
info:
title: Cobo Wallet as a Service 2.0
description: >
The Cobo Wallet-as-a-Service (WaaS) 2.0 API is the latest version of Cobo's
WaaS API offering. It enables you to access Cobo's full suite of crypto
wallet technologies with powerful and flexible access controls. By
encapsulating complex security protocols and streamlining blockchain
interactions, this API allows you to concentrate on your core business
activities without worrying about the safety of your assets. The WaaS 2.0
API presents the following key features:
- A unified API for Cobo's [all four wallet
types](https://manuals.cobo.com/en/portal/introduction#an-all-in-one-wallet-platform)
- Support for 80+ chains and 3000+ tokens
- A comprehensive selection of webhook events
- Flexible usage models for MPC Wallets, including [Organization-Controlled
Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/introduction)
and [User-Controlled
Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/ucw/introduction)
- Programmatic control of smart contract wallets such as Safe{Wallet} with
fine-grained access controls
- Seamlessly transfer funds across multiple exchanges, including Binance,
OKX, Bybit, Deribit, and more
For more information about the WaaS 2.0 API, see [Introduction to WaaS
2.0](https://www.cobo.com/developers/v2/guides/overview/introduction).
termsOfService: https://cobo.com/waas/tos/
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
contact:
name: Cobo WaaS
url: https://www.cobo.com/waas
email: help@cobo.com
version: 1.0.0
servers:
- url: https://api.dev.cobo.com/v2
description: Development environment
- url: https://api.cobo.com/v2
description: Production environment
security:
- CoboAuth: []
tags:
- name: Organizations
description: Operations related to Organizations.
- name: Wallets
description: Operations related to all wallets.
- name: Wallets - MPC Wallets
description: Operations related to mpc wallet.
- name: Wallets - Exchange Wallet
description: Operations related to exchange wallet.
- name: Wallets - Smart Contract Wallets
description: Operations related to smart contract wallet.
- name: Transactions
description: Operations related to all transactions.
- name: Developers - Webhooks
description: Operations related to webhooks.
- name: Stakings
description: Operations related to staking.
- name: OAuth
description: Operations related to OAuth.
- name: Developers
description: Operations related to developers.
- name: AddressBooks
description: Operations related to address books.
- name: TravelRule
description: Operations related to travel rule.
- name: GraphQL
description: Operations related to executing GraphQL queries and mutations.
- name: PrimeBroker
description: Operations related to prime broker.
- name: AppWorkflows
description: Operations related to app workflow.
- name: FeeStation
description: Operations related to fee station.
- name: Payment
description: Operations related to payment.
- name: Batch Payouts
description: Operations related to batch payouts.
- name: Tokenization
description: Operations related to tokenization.
- name: AutoSweep
description: Operations related to auto sweep.
- name: Compliance
description: Operations related to compliance.
paths:
/wallets/{wallet_id}:
parameters:
- $ref: '#/components/parameters/walletIdParam'
get:
tags:
- Wallets
summary: Get wallet information
description: >
This operation retrieves the detailed information about a specified
wallet.
operationId: get_wallet_by_id
responses:
'200':
$ref: '#/components/responses/getWalletByIdResponse'
4XX:
$ref: '#/components/responses/badRequestError'
5XX:
$ref: '#/components/responses/internalServerError'
security:
- CoboAuth: []
- OAuth2:
- wallet.read
components:
parameters:
walletIdParam:
name: wallet_id
in: path
required: true
description: The wallet ID.
schema:
type: string
format: uuid
example: f47ac10b-58cc-4372-a567-0e02b2c3d479
responses:
getWalletByIdResponse:
description: Successful get a wallet info
content:
application/json:
schema:
$ref: '#/components/schemas/WalletInfo'
badRequestError:
description: >-
Bad request. Your request contains malformed syntax or invalid
parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
internalServerError:
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
schemas:
WalletInfo:
oneOf:
- $ref: '#/components/schemas/CustodialWalletInfo'
- $ref: '#/components/schemas/MPCWalletInfo'
- $ref: '#/components/schemas/SmartContractWalletInfo'
- $ref: '#/components/schemas/ExchangeWalletInfo'
discriminator:
propertyName: wallet_type
mapping:
Custodial:
$ref: '#/components/schemas/CustodialWalletInfo'
MPC:
$ref: '#/components/schemas/MPCWalletInfo'
SmartContract:
$ref: '#/components/schemas/SmartContractWalletInfo'
Exchange:
$ref: '#/components/schemas/ExchangeWalletInfo'
ErrorResponse:
type: object
description: The response of a failed request.
required:
- error_code
- error_message
- error_id
properties:
error_code:
type: integer
description: >-
The error code. Refer to [Error codes and status
codes](https://www.cobo.com/developers/v2/api-references/error-codes)
for more details.
error_message:
type: string
description: The error description.
error_id:
type: string
description: >-
The error log ID. You can provide the error ID when submitting a
ticket to help Cobo to locate the issue.
example: 0b6ddf19083c4bd1a9ca01bec44b24dd
CustodialWalletInfo:
type: object
title: Custodial Wallets
description: The basic information of a wallet.
required:
- wallet_id
- wallet_type
- wallet_subtype
- name
- org_id
properties:
wallet_id:
type: string
format: uuid
example: f47ac10b-58cc-4372-a567-0e02b2c3d479
description: The wallet ID.
wallet_type:
$ref: '#/components/schemas/WalletType'
wallet_subtype:
$ref: '#/components/schemas/WalletSubtype'
name:
type: string
example: Example Wallet
description: The wallet name.
org_id:
type: string
description: The ID of the owning organization.
example: f47ac10b-58cc-4372-a567-0e02b2c3d479
enable_auto_sweep:
type: boolean
description: Enable the auto sweep feature for the wallet
MPCWalletInfo:
title: MPC Wallets
allOf:
- $ref: '#/components/schemas/CustodialWalletInfo'
- type: object
required:
- vault_id
properties:
project_id:
type: string
example: 0111039d-27fb-49ba-b172-6e0aa80e37ec
description: The project ID.
project_name:
type: string
example: Project name
description: The project name.
vault_id:
type: string
description: The ID of the owning vault.
vault_name:
type: string
example: Vault name
description: The vault name.
SmartContractWalletInfo:
title: Smart Contract Wallets
oneOf:
- $ref: '#/components/schemas/SafeWallet'
discriminator:
propertyName: smart_contract_wallet_type
mapping:
Safe{Wallet}:
$ref: '#/components/schemas/SafeWallet'
ExchangeWalletInfo:
title: Exchange Wallets
allOf:
- $ref: '#/components/schemas/CustodialWalletInfo'
- type: object
required:
- apikey
- exchange_id
properties:
apikey:
type: string
description: The API key of your exchange account.
example: d8f062da-39f4-4a11-8b9d-12595854237f
exchange_id:
$ref: '#/components/schemas/ExchangeId'
main_wallet_id:
type: string
description: >-
The wallet ID of the Main Account associated with the Sub
Account. This property is returned only if you are creating or
querying an Exchange Wallet (Sub Account).
format: uuid
example: f47ac10b-58cc-4372-a567-0e02b2c3d479
WalletType:
type: string
enum:
- Custodial
- MPC
- SmartContract
- Exchange
example: Custodial
description: >
The wallet type. Possible values include:
- `Custodial`: [Custodial
Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction)
- `MPC`: [MPC
Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction)
- `SmartContract`: [Smart Contract
Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction)
- `Exchange`: [Exchange
Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction)
WalletSubtype:
type: string
enum:
- Asset
- Web3
- Org-Controlled
- User-Controlled
- Safe{Wallet}
- Main
- Sub
example: Asset
description: >
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.
SafeWallet:
allOf:
- allOf:
- $ref: '#/components/schemas/CustodialWalletInfo'
- type: object
properties:
chain_id:
type: string
description: The ID of the chain on which the wallet operates.
example: ETH
- type: object
title: Safe Wallets
required:
- smart_contract_wallet_type
properties:
smart_contract_wallet_type:
$ref: '#/components/schemas/SmartContractWalletType'
safe_address:
type: string
format: address
pattern: ^0x[a-fA-F0-9]{40}$
example: '0x1234567890123456789012345678901234567890'
description: The Smart Contract Wallet address.
signers:
type: array
items:
type: string
format: address
pattern: ^0x[a-fA-F0-9]{40}$
example: '0x1234567890123456789012345678901234567890'
description: The signers of the Smart Contract Wallet.
threshold:
type: integer
minimum: 1
example: 2
description: >-
The minimum number of confirmations required for the Smart
Contract Wallet.
cobo_safe_address:
type: string
format: address
pattern: ^0x[a-fA-F0-9]{40}$
example: '0x1234567890123456789012345678901234567890'
description: The address of Cobo Safe.
initiator:
$ref: '#/components/schemas/SmartContractInitiator'
ExchangeId:
type: string
enum:
- binance
- okx
- deribit
- bybit
- gate
- bitget
- bitmart
- bitfinex
description: |
The ID of the exchange. Possible values include:
- `binance`: Binance.
- `okx`: OKX.
- `deribit`: Deribit.
- `bybit`: Bybit.
- `gate`: Gate.io
- `bitget`: Bitget
- `bitmart`: BitMart
- `bitfinex`: Bitfinex
example: binance
SmartContractWalletType:
type: string
enum:
- Safe{Wallet}
example: Safe{Wallet}
default: Safe{Wallet}
description: The Smart Contract Wallet type.
SmartContractInitiator:
title: Initiator Wallets
description: The information about the initiator.
type: object
required:
- wallet_id
- address
properties:
wallet_id:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426614174000
description: The initiator's wallet ID.
address:
type: string
example: '0x1234567890123456789012345678901234567890'
description: 'The initiator''s wallet address. '
securitySchemes:
CoboAuth:
type: apiKey
in: header
name: BIZ-API-KEY
description: >
The API key. For more details, refer to [API
key](https://www.cobo.com/developers/v2/guides/overview/cobo-auth#api-key).
In the API playground, enter your [API
secret](https://www.cobo.com/developers/v2/guides/overview/cobo-auth#api-secret),
and your API key will be accordingly calculated.
OAuth2:
type: oauth2
description: >-
The [Org Access
Token](https://www.cobo.com/developers/v2/apps/org-access-tokens). Use
this authorization method only if you are developing Cobo Portal Apps
for installation and use across different organizations.
flows:
authorizationCode:
authorizationUrl: https://auth.cobo.com/authorize
tokenUrl: https://auth.cobo.com/oauth/token
scopes:
address_book.read: Read address book
api_key.read: Read API key information
callback.read: Read callback message
callback.resend: Resend callback message
wallet.create: Create wallet
wallet.read: Read wallet information
wallet.update: Update wallet information
wallet.delete: Delete wallet information
wallet.create_address: Create wallet address
wallet.manage_utxo: Manage UTXO
mpc_project.create: Create MPC project
mpc_project.read: Read MPC project information
mpc_project.update: Update MPC project information
mpc_vault.create: Create MPC Vault
mpc_vault.read: Read MPC Vault information
mpc_vault.update: Update MPC Vault information
mpc_key_group.create: Create MPC key group
mpc_key_group.read: Read MPC key group information
mpc_key_group.update: Update MPC key group information
mpc_key_group.delete: Delete MPC key group information
transaction.read: Read transaction information
transaction.withdraw: Make withdrawals
transaction.estimate_fee: Estimate transaction fee
transaction.contract_call: Initiate contract calls
transaction.message_sign: Initiate message signings
transaction.stake: Stake assets
transaction.unstake: Unstake assets
transaction.unstake_withdraw: Withdraw unstaked assets
transaction.manage: Manage ongoing transactions
transaction.update: Update transaction notes
travel_rule.read: Read travel rule information
travel_rule.edit: Edit travel rule information
webhook.read: Read webhook URLs/events
webhook.edit: Edit webhook URLs
webhook.resend: Resend webhook events
payment_orders_payin.create: Create pay-in order
payment_orders_payin.read: Read pay-in order information
payment_orders_payin.update: Update pay-in order
payment_orders_refund.create: Create payment refund order
payment_orders_refund.read: Read payment refund order information
payment_settlement.create: Create payment settlement request
payment_settlement.read: Read payment settlement request information
payment_merchant.create: Create payment merchant
payment_merchant.read: Read payment merchant information
payment_merchant.update: Update payment merchant
payment_forced_sweep.create: Create payment force sweep request
payment_forced_sweep.read: Read payment force sweep request information
compliance_funds.refund: Refund compliance funds request
compliance_funds.isolate: Isolate compliance funds request
compliance_funds.unfreeze: Unfreeze compliance funds request
compliance_funds.read: Read compliance funds request information
compliance_kyt_review.update: Update KYT review status
compliance_kyt_decisions.update: Update KYT decision status
compliance_kyt_status.read: Read KYT screening status
compliance_kya_screenings.create: Create KYA address screening requests
compliance_kya_screenings.read: Read KYA address screening results
````