Skip to content

Get Address Information (v2)

This is the V2 address detail endpoint. Unlike V1, the coin_name parameter is optional. When omitted, the endpoint returns balances for all assets held at the address. We recommend using V2 for all new integrations.

Endpoint

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

Request

Path Parameters

FieldTypeDescription
b_id
Required
StringBusiness line ID
wallet_code
Required
StringWallet ID
address
Required
StringOn-chain address to query

Query Parameters

FieldTypeDescription
coin_name
Optional
StringFilter by specific coin or token. If omitted, returns all assets held at the address.
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
dataArrayList of asset balances at the address (see details below)

data (array of objects)

Each item in data:

FieldTypeDescription
chainStringBlockchain network (e.g. TRON, SOL, ETH)
coin_nameStringAsset name
addressStringOn-chain address
address_typeStringAddress type. Values: NORMAL_ADDRESS, CONSOLIDATED_ADDRESS
address_storageStringStorage type. Values: HOT, COLD
descriptionStringAddress description
total_amountDecimalTotal balance (in smallest unit)
total_amount_strStringTotal balance in string format (in smallest unit)
freeze_amountDecimalFrozen/locked amount (in smallest unit)
freeze_amount_strStringFrozen/locked amount in string format (in smallest unit)
available_amountDecimalWithdrawable balance (in smallest unit)
available_amount_strStringWithdrawable balance in string format (in smallest unit)

Response Example

{
    "code": 0,
    "message": "",
    "successful": true,
    "data": [
        {
            "chain": "TRON",
            "coin_name": "USDTTRC",
            "address": "TJDaZuYJKdSSmDcz5wxifsVjrQsGNLk8bm",
            "address_type": "NORMAL_ADDRESS",
            "address_storage": "HOT",
            "description": "",
            "total_amount": 87500000,
            "total_amount_str": "87500000",
            "freeze_amount": 0,
            "freeze_amount_str": "0",
            "available_amount": 87500000,
            "available_amount_str": "87500000"
        },
        {
            "chain": "TRON",
            "coin_name": "TRX",
            "address": "TJDaZuYJKdSSmDcz5wxifsVjrQsGNLk8bm",
            "address_type": "NORMAL_ADDRESS",
            "address_storage": "HOT",
            "description": "",
            "total_amount": 62370,
            "total_amount_str": "62370",
            "freeze_amount": 0,
            "freeze_amount_str": "0",
            "available_amount": 62370,
            "available_amount_str": "62370"
        },
        {
            "chain": "TRON",
            "coin_name": "USDC_TRC",
            "address": "TJDaZuYJKdSSmDcz5wxifsVjrQsGNLk8bm",
            "address_type": "NORMAL_ADDRESS",
            "address_storage": "HOT",
            "description": "",
            "total_amount": 0,
            "total_amount_str": "0",
            "freeze_amount": 0,
            "freeze_amount_str": "0",
            "available_amount": 0,
            "available_amount_str": "0"
        }
    ]
}