Get Address Information by List
For segregated warm wallet, code wallet and DeFi account wallet. For consolidation wallet, use 'coin_name' to filter address of the particular token.
Request
GET https://custody-example-url/custody/v1/api/projects/{b_id}/wallets/{wallet_code}/addressesParameters
| Field | Type | Description |
|---|---|---|
| b_id | String | Business line ID |
| wallet_code | String | Wallet ID |
coin_name Optional |
String | coin name Allowed Value: Refer to Cactus Symbol (For API) column in Supported Token |
hide_no_coin_address Optional |
String | If the response needs to hide address with zero balance Allowed values: true, false |
key_word Optional |
String | Description of the address |
offset Optional |
String | Query all results by default if left empty |
limit Optional |
String | Query all results by default if left empty |
sort_by_balance Optional |
String | Allowed Value: DESC, ASC |
min_balance Optional |
Integer | return addresses with balances equal or greater than it |
max_balance Optional |
Integer | return addresses with balances equal or smaller than it |
manage_wallet_address Optional |
Boolean | True - query cold wallet management address; False - query normal address; defaulf is false |
Response
| Field | Type | Description |
|---|---|---|
| code | Integer | Response code |
| message | String | Response message |
| successful | Boolean | If the request is successful |
| data | Object | Data object |
| offset | Integer | Offset |
| limit | Integer | Limit |
| list | Object[] | Address object list |
| domain_id | String | Enterprise ID |
| b_id | String | Business line ID |
| wallet_code | String | Wallet ID |
| wallet_type | String | Wallet type（MIXED_ADDRESS or SEGREGATED_ADDRESS） |
| address | String | Wallet name |
| address_type | String | Address Type (NORMAL_ADDRESS or CONSOLIDATED_ADDRESS) |
| address_storage | String | Address storage type (COLD/HOT) |
| coin_name | String | Asset name |
| bch_address_format | String | BCH address format (CashAdd/Legacy) |
| description | Decimal | Address description |
| freeze_amount | Decimal | Frozen asset amount (the smallest unit)(for segregated wallet) |
| total_amount | Decimal | Total asset amount (the smallest unit) |
Response Example
{
"code": 0,
"message": "",
"successful": true,
"data": {
"limit": 0,
"offset": 1,
"total": 1,
"list": [
{
"address": "mnVFMBnsMJ7goypJFS8A6nWgq4cN1TzxXb",
"address_storage": "COLD",
"address_type": "NORMAL_ADDRESS",
"available_amount": null,
"coin_name": "BTC",
"bch_address_format": null,
"b_id": "4a3e2fb40faa4b9d94480559ac01e8de",
"description": "test addressss",
"domain_id": "e4c9f9024bff472cba51cb2a9fe0f974",
"freeze_amount": null,
"total_amount": 0,
"wallet_code": "CHBTC2656037244",
"wallet_type": "MIXED_ADDRESS"
}
]
}
}