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

火币 2020-6-16 15:44
share to
Scan QR code with WeChat

尊敬的用户:

自本通知生效之日起,火币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权限:读取

请求参数

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

返回数据

名称 类型 是否必需 描述 有效值
code integer TRUE 状态码
message string FALSE 错误描述(如有)
data object TRUE 按子用户uid正序排列,每次最多返回100个uid
{ uid integer TRUE 子用户编号
userState } string TRUE 子用户状态 枚举: lock,normal
nextId integer FALSE 下页查询起始编号(仅在存在下页数据时返回)

示例

{

"code": 200,

"data": [

{

"uid": 63628520,

"userState": "normal"

},

{

"uid": 132208121,

"userState": "normal"

}

]

}

GET /v2/sub-user/user-state

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

API Key权限:读取

请求参数

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

返回数据

名称 类型 是否必需 备注 有效值
code integer TRUE 状态码
message string FALSE 错误描述(如有)
data object TRUE
{ uid integer TRUE 子用户编号
userState } string TRUE 子用户状态 枚举: lock,normal

示例

{

"code": 200,

"data": {

"uid": 132208121,

"userState": "normal"

}

}

GET /v2/sub-user/account-list

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

API Key权限:读取

请求参数

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

返回数据

名称 类型 是否必需 描述 有效值
code integer TRUE 状态码
message string TRUE 错误描述(如有)
data object TRUE
{ accountType string TRUE 账户类型 枚举: spot,isolated-margin,cross-margin,futures,swap
activation string TRUE 账户激活状态 枚举: activated,deactivated
transferrable bool FALSE 可划转权限(仅对accountType=spot有效) 枚举: true,false
accountIds object FALSE
{ accountId string TRUE 账户编号
subType string FALSE 账户子类型(仅对逐仓杠杆账户有效)
accountStatus } string TRUE 账户状态 normal,locked
Uid } long TRUE 子用户编号

示例

{

"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用户需自行评估以上新接口上线对用户自身业务的适配,必要时更新相关应用。

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

btcfans公众号

Scan QR code with WeChat

Link: 火币
Tags: 重要公告
Previous: 【API 公告】关于API将在现有成交明细接口中返回交易手续费币种以及交易手续费返佣币种的通知 Next: OKEx Jumpstart质押挖矿项目Woo Network简介