Skip to content

Get Wallet Information

Endpoint

GET https://api.mycactus.dev/custody/v1/api/projects/{b_id}/wallets/{wallet_code}
GET https://api.mycactus.com/custody/v1/api/projects/{b_id}/wallets/{wallet_code}

Request

Path Parameters

FieldTypeDescription
b_id
Required
StringBusiness line ID.
wallet_code
Required
StringWallet ID

Query Parameters

FieldTypeDescription
coin_name
Optional
StringAsset name
Allowed values: Refer to Coin Name (API) column in Supported Token

Response

Response Body

FieldTypeDescription
codeIntegerResponse code (0 = success)
messageStringResponse message
successfulBooleanWhether the request was successful
dataObjectBelow is a list of items inside the data object

data (object)

FieldTypeDescription
domain_idStringDomain ID
bidStringBusiness line ID
business_nameStringBusiness line name
wallet_codeStringWallet ID
main_wallet_codeStringMain wallet ID
main_walletBooleanWhether this wallet is a main wallet
manage_walletBooleanIndicates whether the wallet is a management wallet. Applicable to ETH multi-signature cold wallets.
wallet_nameStringWallet name
coin_nameStringAsset name
chainStringChain name
contract_addressStringContract address
wallet_typeString

Wallet type
Allowed values:

  • SEGREGATED_ADDRESS
  • DAPP_ADDRESS
  • DAPP_CUSTOM_ADDRESS
  • MIXED_ADDRESS
storage_typeString

Storage type
Allowed values:

  • PRIME_HOT
  • PRIME_COLD_LV1
available_amountDecimalAvailable amount (in smallest unit)
available_amount_strStringAvailable amount in string format (in smallest unit)
freeze_amountDecimalFrozen amount (in smallest unit)
freeze_amount_strStringFrozen amount in string format (in smallest unit)
total_amountDecimalTotal asset amount (in smallest unit)
total_amount_strStringTotal asset amount in string format (in smallest unit)
usd_total_marketDecimalTotal market value in USD
usd_total_market_strStringTotal market value in USD in string format
cny_total_marketDecimalTotal market value in CNY
cny_total_market_strStringTotal market value in CNY in string format
coin_statusString

Asset status
Allowed values:

  • 1 (Normal)
  • 2 (Restricted Withdrawal)
  • 3 (Restricted Deposit)
  • 4 (Restricted Deposit & Withdrawal)
reason_of_statusStringDescription of asset status
normal_address_limitIntegerUpper limit of the number of addresses
normal_address_numIntegerNumber of addresses applied
create_timeLongWallet creation time (timestamp in milliseconds)
fingerprintStringA user-friendly asset identifier used to uniquely identify native tokens on the Cardano (ADA) blockchain
max_withdraw_amountDecimalMaximum amount withdrawable from the wallet.
max_withdraw_amount_strStringMaximum amount withdrawable from the wallet in string format.

Response Example

{
  "code": 0,
  "message": "",
  "successful": true,
  "data": {
    "domain_id": "1e2fa188f5d44faca64c45485062e829",
    "bid": "b4a25892d06542ba8fedb40e99d0c659",
    "business_name": "FOR API TEST",
    "wallet_code": "CHEVMS5368231134",
    "main_wallet_code": "CHEVMS5368231134",
    "main_wallet": true,
    "manage_wallet": false,
    "wallet_name": "",
    "coin_name": "USDC",
    "chain": "ETH",
    "contract_address": "0x43c7181e745be7265eb103c5d69f1b7b4ef8763f",
    "wallet_type": "MIXED_ADDRESS",
    "storage_type": "PRIME_HOT",
    "available_amount": 0,
    "available_amount_str": "0",
    "freeze_amount": 0,
    "freeze_amount_str": "0",
    "total_amount": 0,
    "total_amount_str": "0",
    "usd_total_market": 0,
    "usd_total_market_str": "0.0000",
    "cny_total_market": 0,
    "cny_total_market_str": "0.0000",
    "coin_status": "1",
    "reason_of_status": "",
    "normal_address_limit": 30,
    "normal_address_num": 10,
    "create_time": 1757494284000,
    "fingerprint": null,
    "max_withdraw_amount": 0,
    "max_withdraw_amount_str": "0"
  }
}