关于API新增母用户获取子用户列表及其账户信息接口的公告

尊敬的用户:

自本通知生效之日起,火币Global将新增以下REST API节点 -

GET /v2/sub-user/user-list       获取所有子用户的UID列表及各用户状态

GET /v2/sub-user/user-state    获取特定子用户的用户状态

GET /v2/sub-user/account-list 获取特定子用户的账户列表及账户状态

 

生效日期:2020年6月16日(GMT+8)

具体变更细节及参数要求,请参考API文档:https://huobiapi.github.io/docs/spot/v1/cn/

火币全球站
2020年6月16日

 

GET /v2/sub-user/user-list

获取所有子用户的UID列表及各用户状态

API Key权限:读取

请求参数

参数名称数据类型是否必需描述
fromIdlongFALSE查询起始编号(仅对翻页查询有效)

返回数据

名称类型是否必需描述有效值
codeintegerTRUE状态码 
messagestringFALSE错误描述(如有) 
dataobjectTRUE按子用户uid正序排列,每次最多返回100个uid 
{ uidintegerTRUE子用户编号 
userState }stringTRUE子用户状态枚举lock,normal
nextIdintegerFALSE下页查询起始编号(仅在存在下页数据时返回) 

示例

 

{

    "code": 200,

    "data": [

        {

            "uid": 63628520,

            "userState": "normal"

        },

        {

            "uid": 132208121,

            "userState": "normal"

        }

    ]

}

 

GET /v2/sub-user/user-state

获取特定子用户的用户状态

API Key权限:读取

请求参数

参数名称数据类型是否必需描述
subUidlongTRUE子用户UID

返回数据

名称类型是否必需备注有效值
codeintegerTRUE状态码 
messagestringFALSE错误描述(如有) 
dataobjectTRUE  
{ uidintegerTRUE子用户编号 
userState }stringTRUE子用户状态枚举: lock,normal

示例

 

{

    "code": 200,

    "data": {

        "uid": 132208121,

        "userState": "normal"

    }

}

 

GET /v2/sub-user/account-list

获取特定子用户的账户列表及账户状态

 

API Key权限:读取

 

请求参数

参数名称数据类型是否必需描述
subUidlongTRUE子用户UID

返回数据

名称类型是否必需描述有效值
codeintegerTRUE状态码 
messagestringTRUE错误描述(如有) 
dataobjectTRUE  
{ accountTypestringTRUE账户类型枚举: spot,isolated-margin,cross-margin,futures,swap
activationstringTRUE账户激活状态枚举: activated,deactivated
transferrableboolFALSE可划转权限(仅对accountType=spot有效)枚举: true,false
accountIdsobjectFALSE  
{ accountIdstringTRUE账户编号 
subTypestringFALSE账户子类型(仅对逐仓杠杆账户有效) 
accountStatus }stringTRUE账户状态normal,locked
Uid }longTRUE子用户编号 

示例

 

{

    "code": 200,

    "data": {

        "uid": 132208121,

        "list": [

            {

                "accountType": "isolated-margin",

                "activation": "activated"

            },

            {

                "accountType": "cross-margin",

                "activation": "deactivated"

            },

            {

                "accountType": "spot",

                "activation": "activated",

                "transferrable": true,

                "accountIds": [

                    {

                        "accountId": 12255180,

                        "accountStatus": "normal"

                    }

                ]

            }

        ]

    }

}

 

API用户需自行评估以上新接口上线对用户自身业务的适配,必要时更新相关应用。

所有变更将自本通知生效之日起更新至 Huobi API Docs