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

火币 2019-10-16 09:41

尊敬的用户：

自本通知生效之日起，火币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//repay 全仓杠杆账户归还借贷
5）GET /v1/cross-margin/loan-orders 查询全仓杠杆账户借贷订单
6）GET /v1/cross-margin/accounts/balance 查询全仓杠杆账户余额

生效日期：2019年10月11日（GMT+8）
具体变更细节及参数要求，请参考

火币全球站
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

true

string

Currency币种

amount

true

string

Transfer amount划转金额

Response

Parameter

参数

Required

必需

Data Type

数据类型

Description

描述

Value Range

取值范围

status

true

string

Status状态

"OK" or "Error"

data

true

int

Transfer ID划转编号

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

POST /v1/cross-margin/orders （API key 权限：交易）

Request parameter(s)

Parameter

参数

Required

必需

Data Type

数据类型

Description

描述

Value Range

取值范围

Default Value

缺省值

currency

true

string

Currency币种

amount

true

string

Loan amount借贷金额

Response

Parameter

参数

Required

必需

Data Type

数据类型

Description

描述

Value Range

取值范围

status

true

string

Status状态

"OK" or "Error"

data

true

int

Margin order ID借贷订单编号

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

POST /v1/cross-margin/orders//repay （API key 权限：交易）

Request parameter(s)

Parameter

参数

Required

必需

Data Type

数据类型

Description

描述

Value Range

取值范围

Default Value

缺省值

order-id

true

string

Margin order ID借贷订单编号

amount

true

string

Repay amount还贷金额

Response

Parameter

参数

Required

必需

Data Type

数据类型

Description

描述

Value Range

取值范围

status

true

string

Status状态

"OK" or "Error"

data

true

int

Margin 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	false	string	Start time (in format yyyy-mm-dd)查询开始日期, 日期格式yyyy-mm-dd
end-date	false	string	End time (in format yyyy-mm-dd)查询结束日期, 日期格式yyyy-mm-dd
currency	false	string	Currency币种
state	false	string	Order status订单状态	created 未放款，accrual 已放款，cleared 已还清，invalid 异常	all
from	false	string	Start margin order ID查询起始借贷订单编号		0
direct	false	string		prev 向前，时间（或 ID）正序；next 向后，时间（或 ID）倒序
size	false	string	Number of items in each response每次返回条目数量	[10,100]	100

Response

Parameter 参数	Required 必需	Data Type 数据类型	Description 描述	Value Range 取值范围
status	true	string	Status状态	"OK" or "Error"
data	true	object
{ id	true	long	Margin order ID借贷订单编号
user-id	true	long	User ID用户编号
account-id	true	long	Account ID账户编号
currency	true	string	Currency币种
loan-amount	true	string	The amount of origin loan借贷本金金额
loan-balance	true	string	The amount of the loan left借贷本金金额
interest-amount	true	string	The accumulated loan interest利息总额
interest-balance	true	string	The amount of loan interest left未还利息
filled-points	true	string	Point deduction amount点卡抵扣数量
filled-ht	true	string	HT deduction amountht抵扣数量
created-at	true	long	Margin order creation time借贷发起时间
accrued-at	true	long	Latest accrued time最近一次计息时间
state }	true	string	Order 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 取值范围
status	true	string	Status状态	"OK" or "Error"
data	true	object
{ id	true	int	Account ID账户编号
type	true	string	Account type (margin or cross-margin)账户类型 (margin or cross-margin)	cross-margin
state	true	string	Account status账户状态	working(正常),fl-sys(系统爆仓),fl-end(爆仓结束),fl-negative(穿仓)
risk-rate	true	string	Risk rate风险率
acct-balance-sum	true	string	Account balance totaled in USDT总持有usdt折合
debt-balance-sum	true	string	Debt balance totaled in USDT总负债usdt折合
list	true	array	Account layout by individual currency借贷账户详情列表
{ currency	true	string	Currency币种
type	true	string	Account type账户类型	trade,frozen,loan,interest,transfer-out-available,loan-available
balance }}	true	string	Balance (note: while type=transfer-out-available, if balance=-1, it implicates that all balance can be transferred out.)余额（注：当type= transfer-out-available时，如果balance=-1，意味着该币种余额可全部转出）

Scan QR code with WeChat

Link: 火币

Tags: 重要公告