关于API新增全仓杠杆相关接口的公告

尊敬的用户:

自本通知生效之日起,火币Global将新增以下REST API节点 –
1)POST /v1/cross-margin/transfer-in 从现货账户划转至全仓杠杆账户
2)POST /v1/cross-margin/transfer-out 从全仓杠杆账户划转至现货账户
3)POST /v1/cross-margin/orders 全仓杠杆账户申请借贷
4)POST /v1/cross-margin/orders/{order-id}/repay 全仓杠杆账户归还借贷
5)GET /v1/cross-margin/loan-orders 查询全仓杠杆账户借贷订单
6)GET /v1/cross-margin/accounts/balance 查询全仓杠杆账户余额

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

火币全球站
2019年10月11日

以下为变更细节:

1、REST API – 现货账户与全仓杠杆账户资金划转

POST /v1/cross-margin/transfer-in (API key 权限:交易)
POST /v1/cross-margin/transfer-out (API key 权限:交易)

Request parameter(s)

Parameter

参数

Required

必需

Data Type

数据类型

Description

描述

Value Range

取值范围

Default Value

缺省值

currency truestringCurrency币种  
amounttruestringTransfer amount划转金额  

Response

Parameter

参数

Required

必需

Data Type

数据类型

Description

描述

Value Range

取值范围

statustruestringStatus状态"OK" or "Error"
datatrueintTransfer ID划转编号 

2、REST API – 全仓杠杆账户申请借贷

POST /v1/cross-margin/orders (API key 权限:交易)

Request parameter(s)

Parameter

参数

Required

必需

Data Type

数据类型

Description

描述

Value Range

取值范围

Default Value

缺省值

currencytruestringCurrency币种  
amounttruestringLoan amount借贷金额  

Response

Parameter

参数

Required

必需

Data Type

数据类型

Description

描述

Value Range

取值范围

statustruestringStatus状态"OK" or "Error"
datatrueintMargin order ID借贷订单编号 

3、REST API – 全仓杠杆账户归还借贷

POST /v1/cross-margin/orders/{order-id}/repay (API key 权限:交易)

Request parameter(s)

Parameter

参数

Required

必需

Data Type

数据类型

Description

描述

Value Range

取值范围

Default Value

缺省值

order-idtruestringMargin order ID借贷订单编号  
amounttruestringRepay amount还贷金额  

Response

Parameter

参数

Required

必需

Data Type

数据类型

Description

描述

Value Range

取值范围

statustruestringStatus状态"OK" or "Error"
datatrueintMargin order id借贷订单编号 

4、REST API – 查询全仓杠杆账户借贷订单

GET /v1/cross-margin/loan-orders (API key 权限:读取)

Request parameter(s)

Parameter

参数

Required

必需

Data Type

数据类型

Description

描述

Value Range

取值范围

Default Value

缺省值

start-date falsestringStart time (in format yyyy-mm-dd)查询开始日期, 日期格式yyyy-mm-dd  
end-datefalsestringEnd time (in format yyyy-mm-dd)查询结束日期, 日期格式yyyy-mm-dd  
currencyfalsestringCurrency币种  
statefalsestringOrder status订单状态created 未放款,accrual 已放款,cleared 已还清,invalid 异常all
fromfalsestringStart margin order ID查询起始借贷订单编号 0
directfalsestring prev 向前,时间(或 ID)正序;next 向后,时间(或 ID)倒序 
sizefalsestringNumber of items in each response每次返回条目数量[10,100]100

Response

Parameter

参数

Required

必需

Data Type

数据类型

Description

描述

Value Range

取值范围

statustruestringStatus状态"OK" or "Error"
datatrueobject  
{ idtruelongMargin order ID借贷订单编号 
user-idtruelongUser ID用户编号 
 account-idtruelongAccount ID账户编号 
currencytruestringCurrency币种 
loan-amounttruestringThe amount of origin loan借贷本金金额 
loan-balancetruestringThe amount of the loan left借贷本金金额 
interest-amounttruestringThe accumulated loan interest利息总额 
interest-balancetruestringThe amount of loan interest left未还利息 
filled-pointstruestringPoint deduction amount点卡抵扣数量 
filled-httruestringHT deduction amountht抵扣数量 
created-attruelongMargin order creation time借贷发起时间 
 accrued-attruelongLatest accrued time最近一次计息时间 
state }truestringOrder status订单状态created 未放款,accrual 已放款,cleared 已还清,invalid 异常

5、REST API – 查询全仓杠杆账户余额

GET /v1/cross-margin/accounts/balance (API key 权限:读取)

Request parameter(s)

Response

Parameter

参数

Required

必需

Data Type

数据类型

Description

描述

Value Range

取值范围

statustruestringStatus状态"OK" or "Error"
datatrueobject  
{ idtrueintAccount ID账户编号 
typetruestringAccount type (margin or cross-margin)账户类型 (margin or cross-margin)cross-margin
statetruestringAccount status账户状态working(正常),fl-sys(系统爆仓),fl-end(爆仓结束),fl-negative(穿仓)
risk-ratetruestringRisk rate风险率 
acct-balance-sumtruestringAccount balance totaled in USDT总持有usdt折合 
debt-balance-sumtruestringDebt balance totaled in USDT总负债usdt折合 
listtruearrayAccount layout by individual currency借贷账户详情列表 
{ currencytruestringCurrency币种 
typetruestringAccount type账户类型trade,frozen,loan,interest,transfer-out-available,loan-available
balance }}truestringBalance (note: while type=transfer-out-available, if balance=-1, it implicates that all balance can be transferred out.)余额(注:当type= transfer-out-available时,如果balance=-1,意味着该币种余额可全部转出)