Skip to content

Get List Of Wallet (v2)

Get List Of Wallet V2 returns a streamlined response optimized for performance, returning wallet-level summary data. We recommend using V2 for all new integrations.

Endpoint

GET https://api.mycactus.dev/custody/v2/api/wallets
GET https://api.mycactus.com/custody/v2/api/wallets

Request

Query Parameters

FieldTypeDescription
b_id
Optional
StringBusiness line ID. If empty, all wallets are returned.
type
Optional
StringFilter by wallet storage type. If omitted, both hot and cold wallets are returned. Allowed values: HOT, COLD
hide_no_coin_wallet
Optional
BooleanWhen true, excludes wallets with zero balance from results. Default: false Allowed values: true, false
key_word
Optional
StringSearch filter. Matches against wallet name or wallet code.
total_market_order
Optional
IntegerSort by total USD market value. Mutually exclusive with createTimeOrder. If neither sort parameter is provided, results default to creation time descending. Allowed values: 0 (descending), 1 (ascending)
create_time_order
Optional
IntegerSort by wallet creation time. Mutually exclusive with totalMarketOrder. Default: 0 (descending) Allowed values: 0 (descending), 1 (ascending)
offset
Optional
IntegerPagination offset. Default: 0
limit
Optional
IntegerNumber of results per page. Default: 10

Response

Response Body

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

data (object)

FieldTypeDescription
offsetIntegerPagination offset
limitIntegerPagination limit
totalIntegerTotal number of wallets
listArrayList of wallet(s) (see list array details below)

list (array of objects)

Each item in list:

FieldTypeDescription
wallet_codeStringWallet ID
wallet_nameStringWallet name
wallet_typeStringWallet type. Values: MIXED_ADDRESS, SEGREGATED_ADDRESS, DAPP_ADDRESS, DAPP_CUSTOM_ADDRESS
storage_typeStringStorage type. Values: PRIME_HOT, PRIME_COLD_LV1
address_countIntegerNumber of addresses currently in the wallet
address_limitIntegerMaximum number of addresses allowed in the wallet
usd_total_marketDecimalTotal market value in USD
usd_total_market_strStringTotal market value in USD in string format
create_time_stampLongWallet creation time (timestamp in milliseconds)
bidStringBusiness line ID

Response Example

{
    "code": 0,
    "message": "",
    "successful": true,
    "data": {
        "offset": 0,
        "limit": 2,
        "list": [
            {
                "wallet_code": "CHSOL5020680207",
                "wallet_name": "",
                "wallet_type": "MIXED_ADDRESS",
                "storage_type": "PRIME_HOT",
                "address_count": 1,
                "address_limit": 99999,
                "usd_total_market": 0,
                "usd_total_market_str": "0",
                "create_time_stamp": 1768812797000,
                "bid": "af6fcbc38b4d48cf99a23d68ed609b05"
            },
            {
                "wallet_code": "CHSOL0074341064",
                "wallet_name": "",
                "wallet_type": "MIXED_ADDRESS",
                "storage_type": "PRIME_HOT",
                "address_count": 10,
                "address_limit": 100,
                "usd_total_market": 0,
                "usd_total_market_str": "0",
                "create_time_stamp": 1768812772000,
                "bid": "91726a4a8f8a408880e55bd14688c087"
            }
        ],
        "total": 97,
        "metadata": null
    }
}