概要(Overview)

API密钥生成(Generating API Key)

您必须先在BTSE平台上创建API密钥,然后才能使用经过认证的API。要创建API密钥,您可以按照以下步骤操作:

1. 使用您的用户名/电子邮件和密码登录BTSE网站

2. 点击右上角的“帐户”

3. 选择API标签

4. 单击“新建API”按钮以创建API密钥和密码短语。 (注意:密码短语只会出现一次)

5. 使用您的API密钥和密码短语来建立签名

基本网址:

认证(Authentication)

Signature=HMAC.Sha384 (secretkey, (urlpath + btse-nonce + bodyStr)) 注意: 当没有资料时,bodyStr = ''

认证端点(Authenticated Endpoints)

未完成订单(Open Orders)

GET /api/v2/user/open_orders

回传个人未完成订单

参数(Parameters)

名称

输入

型別

必要性

描述

symbol

query

string

代号(例如:BTCPFC, BTCZ19)

回应(Responses)

状态

意义

描述

结构

200

OK

Inline

400

Bad Request

错误请求

AppException

401

Unauthorized

未经授权

AppException

403

Forbidden

禁止

AppException

500

Internal Server Error

内部伺服器错误

AppException

503

Service Unavailable

暂停服务

AppException

回应结构(Response Schema)

狀态码 200

名称

型別

必要性

限制

描述

anonymous

[OpenOrderResp]

» orderType

integer(int32)

76:限价单, 77:市价单, 80:挂勾单

» price

number(double)

» size

integer(int32)

原始订单数量

» side

string

» filledSize

integer(int32)

已提交订单数量

» orderValue

number(double)

美元计价

» pegPriceMin

number(double)

» pegPriceMax

number(double)

» pegPriceDeviation

number(double)

c

» cancelDuration

integer(int64)

到期时间戳(0:取消前有效委托)

» timestamp

integer(int64)

» orderID

string

» stealth

number(double)

隐形订单百分比

» triggerOrder

boolean

假如订单尚未被触发,那么它会回传true

» triggerPrice

number(double)

» triggerOriginalPrice

number(double)

» triggerOrderType

integer(int32)

1001:触发止损单, 1002:触发止盈单

» triggerTrailingStopDeviation

number(double)

» triggerStopPrice

number(double)

» symbol

string

» trailValue

number(double)

» triggered

boolean

!要执行此操作,必须使用以下方法之一对您进行身份验证:btse-nonce,btse-api,btse-sign

包(Wallet)

GET /api/v2/user/wallet

回传個人钱包.

参数(Parameters)

名称

输入

型別

必要性

描述

wallet

query

string

钱包名称(例如:CROSS@, SPOT@, ISOLATED@, BTCPFC-USD)

回应(Responses)

狀態

意义

描述

结构

200

OK

Inline

400

Bad Request

错误请求

AppException

401

Unauthorized

未经授权

AppException

403

Forbidden

禁止

AppException

500

Internal Server Error

内部伺服器错误

AppException

503

Service Unavailable

暂停服务

AppException

回应结构(Response Schema)

狀态码 200

名称

型別

必要性

限制

描述

anonymous

[WalletResponse]

» trackingID

integer(int64)

» queryType

integer(int32)

» activeWalletName

string

» wallet

string

钱包名称

» username

string

» walletTotalValue

number(double)

» totalValue

number(double)

» marginBalance

number(double)

» availableBalance

number(double)

» unrealisedProfitLoss

number(double)

» maintenanceMargin

number(double)

» openMargin

number(double)

» assets

[CustomizeWalletObj]

»» memo

string

»» username

string

»» market

string

»» walletName

string

»» version

integer(int64)

»» timestamp

integer(int64)

»» snapshotID

integer(int64)

»» balance

number(double)

»» value

number(double)

»» assetPrice

number(double)

»» type

integer(int32)

»» total

number(double)

»» currency

string

»» fiat

boolean

»» haircutValueUSD

number(double)

»» softHaircutValueUSD        

number(double)

»» display

boolean

!要执行此操作,必须使用以下方法之一对您进行身份验证:btse-nonce,btse-api,btse-sign

转移钱包(Transfer Wallet)

POST /api/v2/user/wallet/transfer

从不同市场转移钱包.

参数(Parameters)

名称

输入

型別

必要性

描述

body

body

WalletTransferForm

回应(Responses)

狀態

意义

描述

结构

200

OK

Inline

400

Bad Request

错误请求

AppException

401

Unauthorized

未经授权

AppException

403

Forbidden

禁止

AppException

500

Internal Server Error

内部伺服器错误

AppException

503

Service Unavailable

暂停服务

AppException

回应结构(Response Schema)

狀态码 200

名称

型別

必要性

限制

描述

anonymous

[WalletResponse]

» trackingID

integer(int64)

» queryType

integer(int32)

» activeWalletName

string

» wallet

string

钱包名称

» username

string

» walletTotalValue

number(double)

» totalValue

number(double)

» marginBalance

number(double)

» availableBalance

number(double)

» unrealisedProfitLoss

number(double)

» maintenanceMargin

number(double)

» openMargin

number(double)

» assets

[CustomizeWalletObj]

»» memo

string

»» username

string

»» market

string

»» walletName

string

»» version

integer(int64)

»» timestamp

integer(int64)

»» snapshotID

integer(int64)

»» balance

number(double)

»» value

number(double)

»» assetPrice

number(double)

»» type

integer(int32)

»» total

number(double)

»» currency

string

»» fiat

boolean

»» haircutValueUSD

number(double)

»» softHaircutValueUSD        

number(double)

»» display

boolean

!要执行此操作,必须使用以下方法之一对您进行身份验证:btse-nonce,btse-api,btse-sign

限价/市价订单(Limit/Market Order)

POST /api/v2/order

委托一限价或市价订单

参数(Parameters)

名称

输入

型別

必要性

描述

body

body

OrderFormV2

回应(Responses)

狀態

意义

描述

结构

200

OK

Inline

400

Bad Request

错误请求

AppException

401

Unauthorized

未经授权

AppException

403

Forbidden

禁止

AppException

500

Internal Server Error

内部伺服器错误

AppException

503

Service Unavailable

暂停服务

AppException

回应结构(Response Schema)

狀态码 200

名称

型別

必要性

限制

描述

anonymous

[OrderResp]

» status

integer(int32)

6:订单已取消, 9:觸发已插入

» symbol

string

» orderType

integer(int32)

76:限价单, 77:市价单, 80:掛勾单

» price

number(double)

» side

string

» size

integer(int32)

» orderID

string

» timestamp

integer(int64)

» triggerPrice

number(double)

» trigger

boolean

» deviation

number(double)

只有用在掛勾单

» stealth

number(double)

» message

string

!要执行此操作,必须使用以下方法之一对您进行身份验证:btse-nonce,btse-api,btse-sign

取消订单(Cancel Orders)

DELETE /api/v2/order

orderID是指定哪個订单要被取消. 如果订单不被提交,市场上的所有订单將被取消.

参数(Parameters)

名称

输入

型別

必要性

描述

symbol

query

string

代号代表市场名称

orderID

query

string

当没有指定orderID的时候,市场上的所有订单将被取消

回应(Responses)

狀態

意义

描述

结构

200

OK

Inline

400

Bad Request

错误请求

AppException

401

Unauthorized

未经授权

AppException

403

Forbidden

禁止

AppException

500

Internal Server Error

内部伺服器错误

AppException

503

Service Unavailable

暂停服务

AppException

回应结构(Response Schema)

狀态码 200

名称

型別

必要性

限制

描述

anonymous

[OrderResp]

» status

integer(int32)

6:订单已取消, 9:觸发已插入

» symbol

string

» orderType

integer(int32)

76:限价单, 77:市价单, 80:掛勾单

» price

number(double)

» side

string

» size

integer(int32)

» orderID

string

» timestamp

integer(int64)

» triggerPrice

number(double)

» trigger

boolean

» deviation

number(double)

只有用在掛勾单

» stealth

number(double)

» message

string

!要执行此操作,必须使用以下方法之一对您进行身份验证:btse-nonce,btse-api,btse-sign

定杠杆(Set leverage)

POST /api/v2/leverage

改变杠杆

参数(Parameters)

名称

输入

型別

必要性

描述

body

body

LeverageForm

回应(Responses)

狀態

意义

描述

结构

200

OK

Inline

400

Bad Request

错误请求

AppException

401

Unauthorized

未经授权

AppException

403

Forbidden

禁止

AppException

500

Internal Server Error

内部伺服器错误

AppException

503

Service Unavailable

暂停服务

AppException

回应结构(Response Schema)

狀态码 200

名称

型別

必要性

限制

描述

anonymous

[NotificationResp]

» symbol

string

代号

» timestamp

integer(int64)

» status

integer(int32)

20:成功, 16:订单未找到

» type

integer(int32)

93:杠杆, 94:风险限额

» message

string

!要执行此操作,必须使用以下方法之一对您进行身份验证:btse-nonce,btse-api,btse-sign

设定风险限额(Set risk limit)

POST /api/v2/risk_limit

改变风险限额

参数(Parameters)

名称

输入

型別

必要性

描述

body

body

RiskLimitForm

回应(Responses)

狀態

意义

描述

结构

200

OK

Inline

400

Bad Request

错误请求

AppException

401

Unauthorized

未经授权

AppException

403

Forbidden

禁止

AppException

500

Internal Server Error

内部伺服器错误

AppException

503

Service Unavailable

暂停服务

AppException

回应结构(Response Schema)

狀态码 200

名称

型別

必要性

限制

描述

anonymous

[NotificationResp]

» symbol

string

代号

» timestamp

integer(int64)

» status

integer(int32)

20:成功, 16:订单未找到

» type

integer(int32)

93:杠杆, 94:风险限额

» message

string

!要执行此操作,必须使用以下方法之一对您进行身份验证:btse-nonce,btse-api,btse-sign

位(Position)

Get /api/v2/positions

回传個人仓位

参数(Parameters)

名称

输入

型別

必要性

描述

symbol

query

string

代号(例如:BTCPFC, BTCZ19)

回应(Responses)

狀態

意义

描述

结构

200

OK

Inline

400

Bad Request

错误请求

AppException

401

Unauthorized

未经授权

AppException

403

Forbidden

禁止

AppException

500

Internal Server Error

内部伺服器错误

AppException

503

Service Unavailable

暂停服务

AppException

回应结构(Response Schema)

狀态码 200

名称

型別

必要性

限制

描述

anonymous

[PositionResp]

» marginType

integer(int32)

91: 全仓钱包, 92: 逐仓钱包

» entryPrice

number(double)

進场价格

» markPrice

number(double)

標记价格

» symbol

string

標记价格

» side

string

» orderValue

number(double)

美元计价

» settleWithAsset

string

资产结算

» unrealizedProfitLoss

number(double)

» totalMaintenanceMargin

number(double)

» size

integer(int32)

» liquidationPrice

number(double)

» isolatedLeverage

number(double)

» adlScoreBucket

number(double)

» liquidationInProgress

boolean

» timestamp

integer(int64)

!要执行此操作,必须使用以下方法之一对您进行身份验证:btse-nonce,btse-api,btse-sign

提交历史(Fill history)

Get /api/v2/user/trade_history

回传個人提交历史. 每次API最多回传500笔记录,且只会回传造市商方面有记录的交易历史. 如果要显示超過500笔记录的分页,您將需要指定startTime, endTime, beforeSerialId及afterSerialId参数等. 此API每秒钟只能查询2次. 另外,数据集从2019年10月开始开放.

参数(Parameters)

名称

输入

型別

必要性

描述

symbol

query

string

代号代表市场名称(例如:BTCPFC, ETHPFC)

startTime

query

string

回传结果

中最早的时间戳

endTime

query

string

回传结果

中最新的时间戳

beforeSerialId

query

string

查询編号前的项目

afterSerialId

query

string

查询編号後的项目

count

query

string

查询的项目数量, 预设是10笔,而最大是500笔

includeOld

query

string

包含七天以前的资料,预设是否

回应(Responses)

狀態

意义

描述

结构

200

OK

Inline

400

Bad Request

错误请求

AppException

401

Unauthorized

未经授权

AppException

403

Forbidden

禁止

AppException

500

Internal Server Error

内部伺服器错误

AppException

503

Service Unavailable

暂停服务

AppException

回应结构(Response Schema)

狀态码 200

名称

型別

必要性

限制

描述

anonymous

[FillsResp]

» tradeId

string

交易Id可以映射到钱包历史

» orderId

string

» username

string

» side

string

订单买或卖

» orderType

integer(int32)

76:限价单, 77:市价单,80:掛勾单,1004:自動減仓单

» triggerType

integer(int32)

» price

number(double)

原始订单价格

» size

integer(int32)

原始订单数量

» filledPrice

number(double)

交易价格

» filledSize

integer(int32)

交易数量

» triggerPrice

number(double)

» base

string

» quote

string

» symbol

string

» feeCurrency

string

» feeAmount

number(double)

您所支付的费用

» wallet

string

» realizePnl

number(double)

» total

number(double)

正值表示賺钱,負值则表示赔钱

» serialId

integer(int32)

» timestamp

integer(int64)

列举值(Enumerated Values)

属性

数值

side

BUY/SELL(买/卖)

!要执行此操作,必须使用以下方法之一对您进行身份验证:btse-nonce,btse-api,btse-sign

费用(Fees)

Get /api/v2/user/fees

回传個人支付费用

参数(Parameters)

名称

输入

型別

必要性

描述

symbol

query

string

代号代表市场名称(例如:BTCPFC, ETHPFC)

回应(Responses)

狀態

意义

描述

结构

200

OK

Inline

400

Bad Request

错误请求

AppException

401

Unauthorized

未经授权

AppException

403

Forbidden

禁止

AppException

500

Internal Server Error

内部伺服器错误

AppException

503

Service Unavailable

暂停服务

AppException

回应结构(Response Schema)

狀态码 200

名称

型別

必要性

限制

描述

anonymous

[FeesResp]

» symbol

string

代号

» makerFee

number(double)

掛单手续费百分比/美元(比例:10)

» takerFee

number(double)

吃单手续费百分比/美元(比例:10)

!要执行此操作,必须使用以下方法之一对您进行身份验证:btse-nonce,btse-api,btse-sign

钱包历史(Wallet history)

Get /api/v2/user/wallet_history

回传個人钱包历史记录.  API每次最多回传500笔记录.

参数(Parameters)

名称

输入

型別

必要性

描述

wallet

query

string

钱包名称(例如:SPOT@, CROSS@, ISOLATED@BTCPFC-USD )

startTime

query

string

回传结果

中最早的时间戳

endTime

query

string

回传结果

中最新的时间戳

count

query

string

查询的项目数量, 预设是10笔,而最大是500笔

回应(Responses)

狀態

意义

描述

结构

200

OK

Inline

400

Bad Request

错误请求

AppException

401

Unauthorized

未经授权

AppException

403

Forbidden

禁止

AppException

500

Internal Server Error

内部伺服器错误

AppException

503

Service Unavailable

暂停服务

AppException

回应结构(Response Schema)

狀态码 200

名称

型別

必要性

限制

描述

anonymous

[WalletHistoryResp]

» username

string

» orderId

string

» wallet

string

» currency

string

» type

integer(int32)

118:已实现盈亏, 121:资产转换,

110: 资金

» amount

number(double)

» fees

number(double)

» description

string

» timestamp

integer(int64)

!要执行此操作,必须使用以下方法之一对您进行身份验证:btse-nonce,btse-api,btse-sign

取得钱包保证金讯息(Gets wallet margin information)

Get /api/v2/user/margin

取得指定钱包的保证金信息,以便用戶可以知道他們在市场上使用哪個钱包.

参数(Parameters)

名称

输入

型別

必要性

描述

symbol

query

string

true

回应(Responses)

狀態

意义

描述

结构

200

OK

Inline

400

Bad Request

错误请求

AppException

401

Unauthorized

未经授权

AppException

403

Forbidden

禁止

AppException

500

Internal Server Error

内部伺服器错误

AppException

503

Service Unavailable

暂停服务

AppException

回应结构(Response Schema)

狀态码 200

名称

型別

必要性

限制

描述

anonymous

[WalletResponse]

» trackingID

integer(int64)

» queryType

integer(int32)

» activeWalletName

string

» wallet

string

钱包名称

» username

string

» walletTotalValue

number(double)

» totalValue

number(double)

» marginBalance

number(double)

» availableBalance

number(double)

» unrealisedProfitLoss

number(double)

» maintenanceMargin

number(double)

» openMargin

number(double)

» assets

[CustomizeWalletObj]

»» memo

string

»» username

string

»» market

string

»» walletName

string

»» version

integer(int64)

»» timestamp

integer(int64)

»» snapshotID

integer(int64)

»» balance

number(double)

»» value

number(double)

»» assetPrice

number(double)

»» type

integer(int32)

»» total

number(double)

»» currency

string

»» fiat

boolean

»» haircutValueUSD

number(double)

»» softHaircutValueUSD

number(double)

»» display

boolean

!要执行此操作,必须使用以下方法之一对您进行身份验证:btse-nonce,btse-api,btse-sign

公开端點(Public Endpoints)

取得订单簿(Gets orderbook)

GET /api/v2/orderbook/L2

取得已知市场名称的订单簿

参数格式(Parameters)

名称

输入

型別

必要性

描述

symbol

query

string

代号代表市场名称(例如:BTCPFC, ETHPFC)

depth

query

string

订单簿深度

回应(Responses)

狀態

意义

描述

结构

200

OK

取得订单簿清单

OrderbookResp

400

Bad Request

错误请求

AppException

401

Unauthorized

未经授权

AppException

403

Forbidden

禁止

AppException

404

Not Found

未找到

AppException

500

Internal Server Error

内部伺服器错误

AppException

503

Service Unavailable

暂停服务

AppException

!此操作不需要身份验证

美國线(OHLCV)

GET /api/v2/ohlcv

为市场提供美國线(Open High Low Close Volume). API每次最多提供300個数据點. 此API限制每秒只能查询2次. 数据集从2019年10月开始开放.

参数格式(Parameters)

名称

输入

型別

必要性

描述

symbol

query

string

代号代表市场名称(例如:BTCPFC, ETHPFC)

resolution

query

integer(int64)

提供分钟为单位的分辨率, 支持的分辨率有[1,5,15,30,60,360,1440](1分,5分,15分,30分,60分,...)

start

query

integer(int64)

查询的起始时间(秒数为单位). 若end为空的話,会查询start时间後300個时间點

end

query

integer(int64)

查询的終止时间(秒数为单位). 若start为空的話,会查询end时间點前的300個时间點

回应(Responses)

狀態

意义

描述

结构

200

OK

取得美國线

400

Bad Request

错误请求

AppException

401

Unauthorized

未经授权

AppException

403

Forbidden

禁止

AppException

404

Not Found

未找到

AppException

500

Internal Server Error

内部伺服器错误

AppException

503

Service Unavailable

暂停服务

AppException

!此操作不需要身份验证

股价指数(Market price index)

GET /api/v2/price

此API提供股价指数,最新价格,及標记价格.

参数格式(Parameters)

名称

输入

型別

必要性

描述

symbol

query

string

代号代表市场名称(例如:BTCPFC, ETHPFC)

回应(Responses)

狀態

意义

描述

结构

200

OK

none

inline

400

Bad Request

错误请求

AppException

401

Unauthorized

未经授权

AppException

403

Forbidden

禁止

AppException

404

Not Found

未找到

AppException

500

Internal Server Error

内部伺服器错误

AppException

503

Service Unavailable

暂停服务

AppException

回应结构(Response Schema)

狀态码 200

名称

型別

必要性

限制

描述

anonymous

[PriceResp]

» symbol

string

» indexPrice

number(double)

股价指数

» lastPrice

number(double)

最新价格

» markPrice

number(double)

標记价格

!此操作不需要身份验证

高層次市场概況(High level market overview)

GET /api/v2/market_summary

此API提供了市场的高層次概況. 为您提供讯息,例如最佳买/卖,最新一天的价格走勢和成交量资讯.

参数格式(Parameters)

名称

输入

型別

必要性

描述

symbol

query

string

代号代表市场名称(例如:BTCPFC, ETHPFC)

回应(Responses)

狀態

意义

描述

结构

200

OK

none

inline

400

Bad Request

错误请求

AppException

401

Unauthorized

未经授权

AppException

403

Forbidden

禁止

AppException

404

Not Found

未找到

AppException

500

Internal Server Error

内部伺服器错误

AppException

503

Service Unavailable

暂停服务

AppException

回应结构(Response Schema)

狀态码 200

名称

型別

必要性

限制

描述

anonymous

[MarketSummaryResp]

» symbol

string

代号

» last

number(double)

最新价格

» lowestAsk

number(double)

最低卖出价

» highestBid

number(double)

最高买入价

» openInterest

number(double)

未平仓量

» openInterestUSD

number(double)

美元计价未平仓量

» percentageChange

number(double)

» volume

number(double)

» high24Hr

number(double)

» low24Hr

number(double)

» base

string

» quote

string

» contractStart

integer(int64)

» contractEnd

integer(int64)

» active

boolean

是否市场可用?

» timeBasedContract

boolean

是否是时间合約?

» openTime

integer(int64)

市场开放时间(毫秒)

» closeTime

integer(int64)

市场结束时间(毫秒)

» startMatching

integer(int64)

市场撮合始时间(毫秒)

» inactiveTime

integer(int64)

撮合停止时间(毫秒)

» fundingRate

number(double)

» contractSize

number(double)

contractSize = 0.001意味著當您买一单位的合約的時候,它实际上等于在市场上1 * 0.001的大小

» maxPosition

integer(int64)

» minValidPrice

number(double)

最低有效价格

» minPriceIncrement

number(double)

» minOrderSize

integer(int32)

» maxOrderSize

integer(int32)

» minRiskLimit

integer(int32)

» maxRiskLimit

integer(int32)

» minSizeIncrement

number(double)

» availableSettlement

[string]

哪些资产可以结算

» marketSettingsData

MarketSummaryResp

» marketDetail

MarketSummaryResp

!此操作不需要身份验证

交易历史(Trade history)

GET /api/v2/trades

回传個人提交历史. 每次API最多回传500笔记录,且只会回传造市商方面有记录的交易历史. 如果要显示超過500笔记录的分页,您將需要指定startTime, endTime, beforeSerialId及afterSerialId参数等. 此API每秒钟只能查询2次. 另外,数据集从2019年10月开始开放.

参数(Parameters)

名称

输入

型別

必要性

描述

symbol

query

string

代号代表市场名称(例如:BTCPFC, ETHPFC)

startTime

query

string

回传结果

中最早的时间戳

endTime

query

string

回传结果

中最新的时间戳

beforeSerialId

query

string

查询編号前的项目

afterSerialId

query

string

查询編号後的项目

count

query

string

查询的项目数量, 预设是10笔,而最大是500笔

includeOld

query

string

包含七天以前的资料,预设是否

回应(Responses)

狀態

意义

描述

结构

200

OK

Inline

400

Bad Request

错误请求

AppException

401

Unauthorized

未经授权

AppException

403

Forbidden

禁止

AppException

500

Internal Server Error

内部伺服器错误

AppException

503

Service Unavailable

暂停服务

AppException

回应结构(Response Schema)

狀态码 200

名称

型別

必要性

限制

描述

anonymous

[RecentTradeResp]

» price

number(double)

» size

        integer(int32)

» side

string

订单买或卖

» symbol

string

市场代号

» serialId

integer(int64)

» timestamp

integer(int64)

列举值(Enumerated Values)

属性

数值

side

BUY/SELL(买/卖)

symbol

BTCPFC/ETHPFC/...

!此操作不需要身份验证

Websocket讯息(Websocket Messages)

本节所提及的主题是提供给订阅用. WebSocket是持久连接的. 讯息是采用非同步地发送和接收. 为了正确处理WebSocket讯息,需要建立一个收听器(listener)以针对连接去执行适当动作.

每个WebSocket session保持活动60秒. 如果闲置60秒后,您将断开连线. 为确保session保持活动状态,请在达到60秒超时之前发送Ping帧.

订单簿(Orderbook)

为了订阅特定市场的订单簿摘要(feed), 需要经由订阅orderBookApi主题,并附加交易市场名称和订单簿等级的设定. 其中,交易市场名称可以从市场概况API取得,而订单簿摘要(feed)为每60毫秒更新一次.

交易(Trades)

为了订阅最近交易摘要(feed), 需要经由订阅tradeHistory主题,并附加交易市场名称的设定. 其中,交易市场名称可以从市场概况API取得. 而Websocket摘要(feed)将可发送50笔最近交易的快照(snapshot),并更新随后的交易资料.

身份認证(Authentication)

某些Websocket主题需要通过身份认证. 因此,假如您订阅了需要认证的主题,那么您在没通过认证下将不会收到任何讯息. 而为了要进行身份认证,必须在连接Websocket之后发送authKeyExpires讯息. 如同JS程式码范例,它提供了一段身分认证的代码.

通知(Notifications)

经由订阅notificationApi主题可以接收到近来的交易通知. Websocket摘要(feed)会将交易等级通知推送给订户. 如果订阅了主题但未通过身份验证,则不会发送任何讯息.

!此操作需要身份验证

结构(Schemas)

FeesResp

属性(Properties)

名称

型別

必要性

限制

描述

symbol

string

代号

makerFee

number(double)

掛单手续费百分比/美元(比例:10)

takerFee

number(double)

吃单手续费百分比/美元(比例:10)

AppException

属性(Properties)

名称

型別

必要性

限制

描述

status

integer(int32)

errorCode

integer(int32)

message

string

ApiWallet

钱包转移至例如現货,全仓,及逐仓等

属性(Properties)

名称

型別

必要性

限制

描述

currency

string

balance

number(double)

allBalance

boolean

转移所有余额

WalletTransferForm

属性(Properties)

名称

型別

必要性

限制

描述

walletSrc

string

當walletSrcType不等于全仓或現货時

walletSrcType

string

例如从現货,全仓,或逐仓转移來

walletDest

string

當walletDestType不等于全仓或現货時

walletDestType

string

移至例如現货,全仓,及逐仓等

apiWallets

[ApiWallet]

移至例如現货,全仓,及逐仓等

列举值(Enumerated Values)

属性

数值

walletSrcType

CROSS(全仓)

walletSrcType

SPOT(現货)

walletSrcType

ISOLATED(逐仓)

walletSrcType

ALL(全部)

walletDestType

CROSS(全仓)

walletDestType

SPOT(現货)

walletDestType

ISOLATED(逐仓)

walletDestType

ALL(全部)

OrderResp

属性(Properties)

名称

型別

必要性

限制

描述

status

integer(int32)

6: 订单已取消, 9: 觸发已插入

symbol

string

orderType

string

76:限价单, 77:市价单, 80:掛勾单

price

string

side

string

size

        integer(int32)

orderID

string

timestamp

integer(int64)

triggerPrice

number(double)

trigger

boolean

deviation

number(double)

只有用在掛勾单

stealth

number(double)

message

string

WalletResponse

属性(Properties)

名称

型別

必要性

限制

描述

trackingID

integer(int64)

queryType

integer(int32)

activeWalletName

string

wallet

string

钱包名称

username

string

walletTotalValue

number(double)

totalValue

number(double)

marginBalance

number(double)

availableBalance

number(double)

unrealisedProfitLoss

number(double)

maintenanceMargin

number(double)

openMargin

number(double)

assets

[CustomizeWalletObj]

PriceResp

属性(Properties)

名称

型別

必要性

限制

描述

symbol

string

indexPrice

number(double)

指数价格

lastPrice

number(double)

最新价格

markPrice

number(double)

標记价格

OrderbookResp

属性(Properties)

名称

型別

必要性

限制

描述

buyQuote

[CustomQuote]

订单簿的买入清单

sellQuote

[CustomQuote]

订单簿的卖出清单

timestamp

integer(int64)

symbol

string

NotificationResp

属性(Properties)

名称

型別

必要性

限制

描述

symbol

string

代号

timestamp

integer(int64)

status

integer(int32)

20:成功, 16:订单未找到

type

integer(int32)

93: 杠杆 94:风险限额

message

string

OrderFormV2

属性(Properties)

名称

型別

必要性

限制

描述

size

integer(int32)

price

number(double)

side

string

买或卖

time_in_force

string

GTC, IOC, FIVEMIN, HOUR, TWELVEHOUR, DAY, WEEK, MONTH

type

string

限价单, 市价单, 选择性委托单

symbol

string

BTCPFC

txType

string

LIMIT, STOP, TRIGGER

postOnly

boolean

是或否

reduceOnly

boolean

是或否

triggerPrice

number(double)

當使用选择性委托单(OCO)時,此参数不能为空

列举值(Enumerated Values)

属性

数值

side

BUY(买)

side

SELL(卖)

side

buy

side

sell

time_in_force

GTC(取消前皆有效订单)

time_in_force

IOC(立即或取消订单)

time_in_force

FIVEMIN(五分钟)

time_in_force

HOUR(一小時)

time_in_force

TWELVEHOUR(12小時)

time_in_force

DAY(一天)

time_in_force

WEEK(一星期)

time_in_force

MONTH(一個月)

type

LIMIT(限价单)

type

MARKET(市价单)

type

OCO(选择性委托单)

type

limit

type

market

type

oco

txType

LIMIT

txType

STOP

txType

TRIGGER

CustomizeWalletObj

属性(Properties)

名称

型別

必要性

限制

描述

memo

string

username

string

market

string

walletName

string

version

integer(int64)

timestamp

integer(int64)

snapshotID

integer(int64)

balance

number(double)

value

number(double)

assetPrice

number(double)

type

integer(int32)

total

number(double)

currency

string

fiat

boolean

haircutValueUSD

number(double)

softHaircutValueUSD

number(double)

display

boolean

PositionResp

属性(Properties)

名称

型別

必要性

限制

描述

marginType

integer(int32)

91:全仓钱包, 92:逐仓钱包

entryPrice

number(double)

進场价格

markPrice

number(double)

標记价格

symbol

string

代号

side

string

orderValue

number(double)

美元计价

settleWithAsset

string

资产结算

unrealizedProfitLoss

number(double)

totalMaintenanceMargin

number(double)

size

integer(int32)

liquidationPrice

number(double)

isolatedLeverage

number(double)

adlScoreBucket

number(double)

liquidationInProgress

boolean

timestamp

integer(int64)

RiskLimitForm

属性(Properties)

名称

型別

必要性

限制

描述

symbol

string

riskLimit

integer(int32)

观看market_info api

FillsResp

属性(Properties)

名称

型別

必要性

限制

描述

tradeId

string

交易Id可以映射至钱包历史

orderId

string

username

string

side

string

订单买或卖

orderType

integer(int32)

76:限价单, 77:市价单,80:掛勾单,1004:自動減仓单

triggerType

integer(int32)

price

number(double)

原始订单价格

size

integer(int32)

原始订单数量

filledPrice

number(double)

交易价格

filledSize

integer(int32)

交易数量

triggerPrice

number(double)

base

string

quote

string

symbol

string

feeCurrency

string

feeAmount

number(double)

您所支付的费用

wallet

string

realizedPnl

number(double)

total

number(double)

正值表示賺钱,負值则表示赔钱

serialId

integer(int32)

timestamp

integer(int64)

列举值(Enumerated Values)

属性

数值

side

BUY(买)/SELL(卖)

CustomQuote

订单簿的卖出清单

属性(Properties)

名称

型別

必要性

限制

描述

price

string

size

string

culmulativeTotal

string

OpenOrderResp

属性(Properties)

名称

型別

必要性

限制

描述

orderType

integer(int32)

76:限价单, 77:市价单,80:掛勾单

price

number(double)

size

integer(int32)

原始订单数量

side

string

filledSize

integer(int32)

已提交的订单数量

orderValue

number(double)

美元计价

pegPriceMin

number(double)

pegPriceMax

number(double)

pegPriceDeviation

number(double)

cancelDuration

integer(int64)

到期时间戳(0:取消前有效委托)

timestamp

integer(int64)

orderID

string

stealth

number(double)

隐形订单百分比

triggerOrder

boolean

假如订单尚未被触发,那么它会回传true

triggerPrice

number(double)

triggerOrignalPrice

number(double)

triggerOrderType

integer(int32)

1001:触发止损单, 1002:触发止盈单

triggerTrailingStopDeviation

number(double)

triggerStopPrice

number(double)

symbol

string

trailValue

number(double)

triggered

boolean

LeverageForm

属性(Properties)

名称

型別

必要性

限制

描述

symbol

string

leverage

number

0:全仓钱包

MarketSummaryResp

属性(Properties)

名称

型別

必要性

限制

描述

symbol

string

代号

last

number(double)

最新价格

lowestAsk

number(double)

最低卖出价

highestBid

number(double)

最高买入价

openInterest

number(double)

未平仓量

openInterestUSD

number(double)

美元计价未平仓量

percentageChange

number(double)

volume

number(double)

high24Hr

number(double)

low24Hr

number(double)

base

string

quote

string

contractStart

integer(int64)

contractEnd

integer(int64)

active

boolean

是否市场可用?

timeBaseContract

boolean

是否是时间合約?

openTime

integer(int64)

市场开放时间(毫秒)

closeTime

integer(int64)

市场结束时间(毫秒)

startMatching

integer(int64)

市场撮合始时间(毫秒)

inactiveTime

integer(int64)

撮合停止时间(毫秒)

fundingRate

number(double)

contractSize

number(double)

contractSize = 0.001意味著當您买一单位的合約的時候,它实际上等于在市场上1 * 0.001的大小

maxPosition

integer(int64)

minValidPrice

number(double)

最低有效价

minPriceIncrement

number(double)

minOrderSize

integer(int32)

maxOrderSize

integer(int32)

minRiskLimit

integer(int32)

maxRiskLimit

integer(int32)

minSizeIncrement

number(double)

availableSettlement

[string]

哪些资产可以结算

marketSettingsData

MarketSummaryResp

marketDetail

MarketSummaryResp

RecentTradeResp

属性(Properties)

名称

型別

必要性

限制

描述

price

number(double)

size

integer(int32)

side

string

订单买或卖

symbol

string

市场代号

serialId

integer(int64)

timestamp

integer(int64)

列举值(Enumerated Values)

属性

数值

side

BUY/SELL(买/卖)

symbol

BTCPFC/ETHPFC/...

WalletHistoryResp

属性(Properties)

名称

型別

必要性

限制

描述

username

string

orderId

string

wallet

string

currency

string

type

integer(int32)

118:已实现盈亏, 121:资产转换,

110: 资金

amount

number(double)

fees

number(double)

description

string

timestamp

integer(int64)