跳到主要内容

获取子账户 API Key 列表

API说明​

此接口支持主账户用户查询子账户的API Key信息列表，并返回权限设置、IP 白名单状态以及 API Key 创建时间等信息。

注意：子账户 API Key 列表数据只能通过 RESTful API 获取。

注意事项​

  1. 仅限主账户：此接口仅支持使用主账户的 API Key，子账户的API Key 无限权查询该列表。
  2. 安全：出于安全考虑，接口响应仅返回 API Key（公钥）数据，不会返回 Secret Key（私钥）数据。Secret Key（私钥）仅在创建时展示一小时，请务必妥善保管。

认证​

这是一个私有接口，需要认证。有关使用 RESTful API 的详细信息，请参考简介 > 认证和代码示例 > 现货 > RESTful 私有接口。

请求方法​

POST

接口地址​

/api/v1/private?command=subAccount_apikey

频率限制​

该接口的调用频率限制为：每个用户 ID 每秒最多请求3次。 此外，该接口还受到全局频率限制的约束。 有关"全局速率限制"和"API限频策略"的详细信息，请参阅“频率限制”部分，跳转

请求参数​

此接口不需要任何请求参数。

响应参数​

参数类型描述
dataArray子账户 API Key 信息数据列表
-userCodeString子账户编号
-nickNameString子账户昵称
-apiRemarkStringAPI Key 备注
-apiKeyStringAPI Key（公钥字符串）
-createdAtLongAPI Key 创建时间戳（Unix 时间戳，毫秒）
-spotTradeFlagInteger子账户现货交易限权
1: 已开启
0: 未开启
-contractTradeFlagInteger子账户合约交易限权
1: 已开启
0: 未开启
-readonlyFlagInteger只读权限状态。
1: 只读（启用）
0: 读写（禁用只读）
-apiWhiteListFlagIntegerIP 白名单开关状态。
1: 启用
0: 禁用
-apiWhiteListString绑定的 IP 地址白名单列表 (* 表示允许所有 IP 地址)

请求示例​

以下Python代码展示了如何获取子账户 API Key 列表。

注意：完整代码示例请参考简介 > 认证和代码示例 > 现货 > RESTful私有接口。

api_url = "/api/v1/private?command=subAccount_apikey"
method = "POST"
params = {}

SpotRestfulPrivate(host, api_url, method, api_key, params, secret_key) # 函数SpotRestfulPrivate()函数定义于(简介 > 认证和代码示例 > 现货 > RESTful私有接口)章节

响应示例​

以下是上述Python请求返回的示例响应：

{
    "code": "200",
    "data": [
        {
            "userCode": "4230051652",
            "nickName": "SubAccount01",
            "apiRemark": "01",
            "createdAt": 1753774404000,
            "apiKey": "43******************ad3da4403869",
            "spotTradeFlag": 0,
            "contractTradeFlag": 0,
            "readonlyFlag": 1,
            "apiWhiteListFlag": 0,
            "apiWhiteList": "*"
        }
    ],
    "msg": "SUCCESS",
    "success": true,
    "failed": false
}