Get Wallet Info by List
Request
GET https://custody-example-url/custody/v1/api/walletsParameters
| Field | Type | Description |
|---|---|---|
b_id Optional |
String | Business line ID. If this field is empty, all wallets will returned |
type Optional |
String | Wallet type, can be Hot or Cold. Both hot and cold wallets will be returned by default Allowed values: "HOT","COLD" |
hide_no_coin_wallet Optional |
Boolean | If the response needs to filter out zero-balance wallet. The value is True by default Allowed values: "true", "false" |
coin_names Optional |
String[] | Asset name. Allowed Value: Refer to Cactus Symbol (For API) column in Supported Token |
wallet_types Optional |
String[] | Wallet type Allowed values: MIXED_ADDRESS, SEGREGATED_ADDRESS, DAPP_ADDRESS, DAPP_CUSTOM_ADDRESS |
key_word Optional |
String | Wallet name, ID or key word |
defi_wallet_code Optional |
String | DeFi wallet ID，when only query DeFi wallet list |
main_wallet_code Optional |
String | Main wallet ID |
chain Optional |
String | Chain name, optional param when query DeFi wallet; The result will be all chain wallets by default Allowed values Refer to Cactus Network Name (For API) column in Supported Token |
total_market_order Optional |
Integer | Sort the wallet by market value, 0 means in descending order, 1 means in ascending order; The result will be sorted by wallet total market value by default Allowed values: "0", "1" |
create_time_order Optional |
Integer | Sort the wallet by wallet creation time, 0 means in descending order, 1 means in ascending order; The result will be sorted by wallet total market value by default Allowed values: "0", "1" |
offset Optional |
Integer | default 0 |
limit Optional |
Integer | default 10 |
Response
| Field | Type | Description |
|---|---|---|
| code | Integer | Response code |
| message | String | Response message |
| successful | Boolean | If the request is successful |
| data | Object | Wallet object list |
| offset | Integer | offset |
| limit | Integer | limit |
| list | Object[] | Wallet list |
| domain_id | String | Enterprise ID |
| b_id | String | Business line ID |
| wallet_code | String | Wallet ID |
| main_wallet_code | String | DeFi Main wallet ID, only DeFi wallet |
| wallet_name | String | Wallet name |
| coin_name | String | Asset name |
| chain | String | Chain name, only DeFi wallet |
| contract_address | String | Contract address |
| wallet_type | String | Wallet type（MIXED_ADDRESS or SEGREGATED_ADDRESS or DAPP_ADDRESS or DAPP_CUSTOM_ADDRESS） |
| storage_type | String | Storage type（PRIME_HOT or PRIME_COLD_LV1） |
| available_amount | Decimal | Available amount (the smallest unit) |
| freeze_amount | Decimal | Frozen amount (the smallest unit) |
| total_amount | Decimal | Total asset amount (the smallest unit) |
| usd_total_market | Decimal | Total market value (USD) |
| cny_total_market | Decimal | Total market value (CNY) |
| coin_status | String | Asset status(1:Normal. 2:Restricted Withdrawal, 3:Restricted Deposit, 4:Restricted Deposit & Withdrawal) |
| reason_of_status | String | Description of Asset Status |
| normal_address_limit | Integer | The upper limit of the number of address |
| normal_address_num | Integer | The number of address applied |
| create_time | Long | Wallet creation time (timestamp) |
Response Example
{
"code": 0,
"message": "",
"successful": true,
"data": {
"offset": 0,
"limit": 10,
"list": [
{
"domain_id": "a5b3f782c4e24c688eca60946442a75f",
"b_id": "ed70ff75b1fe4994a3bd836befe0e87f",
"wallet_code": "CCLTC1278870318",
"wallet_name": "test wallet",
"coin_name": "LTC",
"contract_address": null,
"wallet_type": "SEGREGATED_ADDRESS",
"storage_type": "PRIME_COLD",
"available_amount": 0,
"freeze_amount": 0,
"total_amount": 0,
"usd_total_market": 0.0,
"cny_total_market": 0.0,
"coin_status": "1",
"chinese_reason_of_status": "",
"english_reason_of_status": "",
"normal_address_limit": 10,
"normal_address_num": 2,
"create_time": 1577762589000
}
],
"total": 1
}
}