跳转至

查询钱包列表 (v1)

该接口已提供 V2 版本,具备更精简的响应结构和更优的性能表现。我们建议所有新的集成使用 V2 版本。请参考查询钱包列表 (v2)接口。

如果未提供 b_id,API 将检查用户是否具有 公司级查询员 权限。如果用户仅拥有特定业务线的查看权限,但没有 公司级查询员 权限,则不会返回任何数据。

要授予此权限,管理员可前往 用户配置,勾选 公司级查询员 复选框。

请求

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

参数

查询参数

字段类型描述
b_id
可选
String业务线 ID, 如果不传表示查询公司下所有钱包
type
可选
String冷热钱包类型:HOT 或者 COLD,如果不传表示不区分冷热钱包
允许值: HOT, COLD
hide_no_coin_wallet
可选
Boolean是否隐藏无币钱包,如果不传表示不进行无币钱包过滤。
允许值: true, false
coin_names
可选
String[]币种名称,如果不传表示不进行币种过滤
允许值: 参考 币种列表 的 Coin Name (API)
wallet_types
可选
String[]钱包类型列表,如果不传表示不进行钱包类型过滤。
允许值: MIXED_ADDRESS, SEGREGATED_ADDRESS, DAPP_ADDRESS, DAPP_CUSTOM_ADDRESS
key_word
可选
String钱包名称、钱包编号关键字
defi_wallet_code
可选
StringDeFi 钱包编号,查询 DeFi 钱包列表
main_wallet_code
可选
String托管账户查询归一钱包
chain
可选
String链信息,查询 DeFi 钱包时可选参数,查询 DeFi 钱包对应链的所有钱包,如果不传表示查询所有链
允许值: 参考 支持的代币 中的网络缩写列
total_market_order
可选
Integer总市值排序:0 表示降序,1 表示升序,总市值排序和创建时间排序二选一,如果都不传默认按照市值降序排序
允许值: 0, 1
create_time_order
可选
Integer创建时间排序:0 表示降序,1 表示升序,总市值排序和创建时间排序二选一,如果都不传默认按照市值降序排序
允许值: 0, 1
offset
可选
Integer如果不传,默认 0
limit
可选
Integer如果不传,默认 10

响应

响应体

字段 类型 描述
code Integer 响应状态码 (0 = 成功)
message String 响应信息
successful Boolean 请求是否成功
data Object 钱包列表数据

data (object)

字段 类型 描述
offset Integer 分页偏移量
limit Integer 分页限制
total Integer 钱包总数
list Array 钱包列表 (参考以下 list 中各项的详细说明)

list (array of objects)

列表中的每一项:

字段类型描述
domain_idString企业 ID
bidString业务线 ID
business_nameString业务线名称
wallet_codeString钱包编号
main_wallet_codeStringDeFi 主钱包编号,仅DeFi钱包
main_walletBoolean是否为主钱包
manage_walletBoolean是否为管理钱包。适用于 ETH 多签冷钱包,该类钱包区分冷地址和管理地址。True 表示管理地址,False 表示普通冷地址。
wallet_nameString钱包名称
coin_nameString币种名称
chainString链信息,仅DeFi钱包
contract_addressString合约地址
wallet_typeString钱包类型。
允许值: MIXED_ADDRESS - 地址混用, SEGREGATED_ADDRESS - 地址隔离, DAPP_ADDRESS - DeFi合约钱包, DAPP_CUSTOM_ADDRESS - DeFi自定义钱包
storage_typeString存储类型。
允许值: PRIME_HOT, PRIME_COLD_LV1
available_amountDecimal可用数币数量(最小单位)
available_amount_strString可用数币数量(最小单位)(字符串格式)
freeze_amountDecimal冻结数币数量(最小单位)
freeze_amount_strString冻结数币数量(最小单位)(字符串格式)
total_amountDecimal总的数币数量(最小单位)
total_amount_strString总的数币数量(最小单位)(字符串格式)
usd_total_marketDecimal总市值(美元)
usd_total_market_strString总市值(美元)(字符串格式)
cny_total_marketDecimal总市值(人民币)
cny_total_market_strString总市值(人民币)(字符串格式)
coin_statusString币种状态。
1: Normal - 正常
2: Restricted Withdrawal - 仅限制提币
3: Restricted Deposit - 仅限制存币
4: Restricted Deposit & Withdrawal - 限制存币提币
reason_of_statusString币种状态说明
is_consolidatedBoolean是否为归集钱包
normal_address_limitInteger该钱包可申请普通地址上限
normal_address_numInteger该钱包已申请普通地址数量
consolidated_address_limitInteger该钱包可申请归集地址上限
consolidated_address_numInteger该钱包已申请归集地址数量
create_timeLong钱包创建时间(毫秒时间戳)
fingerprintString用于唯一标识 Cardano (ADA) 区块链上原生代币的用户友好型资产标识符。

响应示例

{
  "code": 0,
  "message": "",
  "successful": true,
  "data": {
    "offset": 0,
    "limit": 10,
    "list": [
      {
        "domain_id": "1e2fa188f5d44faca64c45485062e829",
        "bid": "b4a25892d06542ba8fedb40e99d0c659",
        "business_name": "FOR API TEST",
        "wallet_code": "DeFiSOL0276728321",
        "main_wallet_code": null,
        "main_wallet": true,
        "manage_wallet": false,
        "wallet_name": "",
        "coin_name": "SOL",
        "chain": "SOLANA",
        "contract_address": null,
        "wallet_type": "DAPP_ADDRESS",
        "storage_type": "PRIME_HOT",
        "available_amount": 2999990000,
        "available_amount_str": "2999990000",
        "freeze_amount": 0,
        "freeze_amount_str": "0",
        "total_amount": 2999990000,
        "total_amount_str": "2999990000",
        "usd_total_market": 255.96,
        "usd_total_market_str": "255.96",
        "cny_total_market": 1748.56,
        "cny_total_market_str": "1748.56",
        "coin_status": "1",
        "reason_of_status": "",
        "is_consolidated": false,
        "normal_address_limit": 1,
        "normal_address_num": 1,
        "consolidated_address_limit": null,
        "consolidated_address_num": null,
        "create_time": 1768294669000,
        "fingerprint": null
      }
    ],
    "total": 1
  }
}