关于API将支持子账号杠杆交易的公告

尊敬的用户:

当前火币Global支持子用户进行币币交易,但不支持子用户进行杠杆交易。自本通知生效之日起,子用户在被母用户授权后,可通过相关REST API节点,进行杠杆交易。

生效日期:2019年9月16日(GMT+8)
具体变更细节及参数要求,请参考【API文档】

火币全球站
2019年9月12日

以下为变更细节:
子用户在被母用户授权后,可通过以下现有REST API节点,进行杠杆交易 –

1) POST /v1/dw/transfer-in/margin
从子用户的币币交易账户划转至杠杆账户
2) POST /v1/dw/transfer-out/margin
从子用户的杠杆账户划转至币币交易账户
3) POST /v1/margin/orders
子用户申请借贷
4) POST /v1/margin/orders/{order-id}/repay
子用户归还借贷
5) GET /v1/margin/loan-orders
子用户查询自己的借贷记录
6) GET /v1/margin/accounts/balance
子用户查询自己杠杆账户余额










子用户币币账户之间的资金划转仍通过现有节点POST /v1/subuser/transfer完成,暂不支持母子用户杠杆账户之间的划转。

现有节点 – GET /v1/subuser/aggregate-balance,当前支持母用户查询其下所有子用户币币账户各币种汇总余额,自本通知生效之日起,将同时支持母用户查询其下所有子用户杠杆账户汇总余额(杠杆账户余额 = 用户资产 – 未还本金 – 未还利息)。返回字段type的可用枚举值将包含spot和margin。

现有母用户查询其下特定子用户币币账户余额的节点 – GET /v1/account/accounts/{sub-uid},将同时支持该子用户杠杆账户余额查询。返回消息中将新增一字段 – symbol。

现有借贷订单查询节点 – GET /v1/margin/loan-orders,除可用于母子用户查询各自的借贷订单以外,还可用于母用户查询特定子用户借贷订单。新增请求字段sub-uid用于指定该子用户,如不填,返回当前用户的借贷订单。

现有杠杆账户余额查询节点 – GET /v1/margin/accounts/balance,除可用于母子用户查询各自杠杆账户余额以外,还可用于母用户查寻特定子用户杠杆账户余额。新增请求字段sub-uid用于指定该子用户,如不填,返回当前用户的杠杆账户余额。

母用户为子用户开通杠杆交易权限,仅可在web端实现。已授权杠杆交易的子用户可交易所有杠杆交易对,且与其母用户共享借贷额度。

1、REST API version 1 – 母用户查询其下所有子用户的各币种汇总余额
GET /v1/subuser/aggregate-balance (API Key权限:读取)
Request parameter(s):无

Response:

Parameter

参数

Required

必需

Data Type

数据类型

Description

描述

Value Range

取值范围

status true   Status状态 "OK" or "Error"
data true list    
{ currency true string Currency币种  
type true string Account type账户类型 spot, margin
balance } true string Accumulated balance from all sub users各子用户汇总余额  

2、REST API version 1 – 母用户查询其下特定子用户的各币种账户余额
GET /v1/account/accounts/{sub-uid} (API Key权限:读取)
Request parameter(s):无

Response:

Parameter

参数

Required

必需

Data Type

数据类型

Description

描述

Value Range

取值范围

status true   Status状态 "OK" or "Error"
data true list    
{ id true string Sub user account ID子用户账户编号  
type true string Account type账户类型 spot, margin
symbol true string Trading symbol交易对  
state true string Account status账户状态 working, lock
list true object    
{ currency true string Currency币种  
type true string Type of balance余额类型 trade, frozen, loan, interest
Balance }} true decimal Balance余额  

3、REST API version 1 – 用户查询借贷订单
GET /v1/margin/loan-orders (API Key权限:读取)

Request parameter(s):

Parameter

参数

Required

必需

Data Type

数据类型

Description

描述

Default Value

缺省值

Value Range

取值范围

symbol true string Trading symbol交易代码 NA  
start-date false string Start date of the query in format yyyy-mm-dd查询起始日期, 日期格式yyyy-mm-dd -61d  
end-date false string End date of the query in format yyyy-mm-dd查询结束日期, 日期格式yyyy-mm-dd Today  
states false string Order status订单状态 all created 未放款,accrual 已放款,cleared 已还清,invalid 异常
from false string Start ID of the query查询起始ID NA  
direct false string Direction of the searchin检索方向 next prev - in ascending order from the start IDnext - in descending order from the start IDprev – 以起始ID升序检索next – 以起始ID降序检索
size false string Number of items in each response返回条目数量 100 [1,100]
sub-uid false int Sub user ID (mandatory field while parent user querying sub user’s orders)子用户编号(母用户查询子用户借贷订单时,此字段必填) If not entered, by default it returns margin orders of current user如不填,缺省查询当前用户借贷订单  

Response:

Parameter

参数

Required

必需

Data Type

数据类型

Description

描述

Value Range

取值范围

status true   Status状态 "OK" or "Error"
data true list    
{ id true long Order ID订单编号  
user-id true long User ID用户编号  
account-id true long Account ID账户编号  
symbol true string Trading symbol交易代码  
currency true string Currency币种  
loan-amount true string Debt amount借贷金额  
loan-balance true string Unpaid debt未还本金  
interest-rate true string Interest rate借贷利率  
interest-amount true string Interest amount利息总额  
interest-balance true string Unpaid interest未还利息  
created-at true long Order creation time借贷发起时间  
accrued-at true long Last counting time of interest最近计息时间  
state } true string Order status订单状态 created 未放款,accrual 已放款,cleared 已还清,invalid 异常

4、REST API version 1 – 用户查询杠杆账户余额
GET /v1/margin/accounts/balance (API Key权限:读取)
Request parameter(s):

Parameter

参数

Required

必需

Data Type

数据类型

Description

描述

Default Value

缺省值

Value Range

取值范围

symbol false string Trading symbol交易代码 all  
sub-uid false int Sub user ID (mandatory field while parent user querying sub user’s margin account details)子用户编号(母用户查询子用户借贷详情时,此字段必填) If not entered, by default it returns margin account details of current user如不填,缺省查询当前用户借贷详情  

Response:

Parameter

参数

Required

必需

Data Type

数据类型

Description

描述

Value Range

取值范围

status true   Status状态 "OK" or "Error"
data true list    
{ id true string Account ID账户编号  
symbol true string Trading symbol交易对  
state true string Account status账户状态 working,fl-sys,fl-mgt,fl-end
risk-rate true string Risk rate风险率  
fl-price true string Liquidation price爆仓价  
list true object    
{ currency true string Currency币种  
type true string Type of balance余额类型 trade, frozen, loan, interest
Balance }} true decimal Balance余额