跳到主要内容

获取子账户列表

API说明​

此接口支持主账户用户查询已创建的全部子账户列表，并返回子账户的 UID、及账户状态等信息。

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

注意事项​

  1. 仅限主账户：此接口仅支持使用主账户的 API Key，子账户的 API Key 无限权查询该列表。

认证​

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

请求方法​

POST

接口地址​

/api/v1/private?command=subAccount_list

频率限制​

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

请求参数​

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

响应参数​

参数类型描述
dataArray子账户信息数据列表
-spotUidLong子账户 UID
-userCodeString子账户编号
-nickNameString子账户昵称
-frozenFlagInteger子账户冻结状态
1: 冻结 Frozen
0: 未冻结（正常）
-spotTradeFlagInteger子账户现货交易限权
1: 已开启
0: 未开启
-contractTradeFlagInteger子账户合约交易限权
1: 已开启
0: 未开启

请求示例​

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

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

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

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

响应示例​

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

{
    "code": "200",
    "data": [
        {
            "spotUid": 123******,
            "userCode": "8638662******",
            "nickName": "************",
            "frozenFlag": 0,
            "spotTradeFlag": 1,
            "contractTradeFlag":1
        }
    ],
    "msg": "SUCCESS",
    "success": true,
    "failed": false
}