概要(Overview)
您必须先在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)
GET /api/v2/user/open_orders
回传个人未完成订单
名称 | 输入 | 型別 | 必要性 | 描述 |
symbol | query | string | 否 | 代号(例如:BTCPFC, BTCZ19) |
状态 | 意义 | 描述 | 结构 |
200 | OK | 无 | Inline |
400 | Bad Request | 错误请求 | |
401 | Unauthorized | 未经授权 | |
403 | Forbidden | 禁止 | |
500 | Internal Server Error | 内部伺服器错误 | |
503 | Service Unavailable | 暂停服务 |
狀态码 200
名称 | 型別 | 必要性 | 限制 | 描述 |
anonymous | 否 | 无 | 无 | |
» 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
GET /api/v2/user/wallet
回传個人钱包.
名称 | 输入 | 型別 | 必要性 | 描述 |
wallet | query | string | 否 | 钱包名称(例如:CROSS@, SPOT@, ISOLATED@, BTCPFC-USD) |
狀態 | 意义 | 描述 | 结构 |
200 | OK | 无 | Inline |
400 | Bad Request | 错误请求 | |
401 | Unauthorized | 未经授权 | |
403 | Forbidden | 禁止 | |
500 | Internal Server Error | 内部伺服器错误 | |
503 | Service Unavailable | 暂停服务 |
狀态码 200
名称 | 型別 | 必要性 | 限制 | 描述 |
anonymous | 否 | 无 | 无 | |
» 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 | 是 | 无 | 无 | |
»» 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
POST /api/v2/user/wallet/transfer
从不同市场转移钱包.
名称 | 输入 | 型別 | 必要性 | 描述 |
body | body | 否 | 无 |
狀態 | 意义 | 描述 | 结构 |
200 | OK | 无 | Inline |
400 | Bad Request | 错误请求 | |
401 | Unauthorized | 未经授权 | |
403 | Forbidden | 禁止 | |
500 | Internal Server Error | 内部伺服器错误 | |
503 | Service Unavailable | 暂停服务 |
狀态码 200
名称 | 型別 | 必要性 | 限制 | 描述 |
anonymous | 否 | 无 | 无 | |
» 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 | 是 | 无 | 无 | |
»» 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
POST /api/v2/order
委托一限价或市价订单
名称 | 输入 | 型別 | 必要性 | 描述 |
body | body | 否 | 无 |
狀態 | 意义 | 描述 | 结构 |
200 | OK | 无 | Inline |
400 | Bad Request | 错误请求 | |
401 | Unauthorized | 未经授权 | |
403 | Forbidden | 禁止 | |
500 | Internal Server Error | 内部伺服器错误 | |
503 | Service Unavailable | 暂停服务 |
狀态码 200
名称 | 型別 | 必要性 | 限制 | 描述 |
anonymous | 否 | 无 | 无 | |
» 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
DELETE /api/v2/order
orderID是指定哪個订单要被取消. 如果订单不被提交,市场上的所有订单將被取消.
名称 | 输入 | 型別 | 必要性 | 描述 |
symbol | query | string | 是 | 代号代表市场名称 |
orderID | query | string | 否 | 当没有指定orderID的时候,市场上的所有订单将被取消 |
狀態 | 意义 | 描述 | 结构 |
200 | OK | 无 | Inline |
400 | Bad Request | 错误请求 | |
401 | Unauthorized | 未经授权 | |
403 | Forbidden | 禁止 | |
500 | Internal Server Error | 内部伺服器错误 | |
503 | Service Unavailable | 暂停服务 |
狀态码 200
名称 | 型別 | 必要性 | 限制 | 描述 |
anonymous | 否 | 无 | 无 | |
» 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
POST /api/v2/leverage
改变杠杆
名称 | 输入 | 型別 | 必要性 | 描述 |
body | body | 否 | 无 |
狀態 | 意义 | 描述 | 结构 |
200 | OK | 无 | Inline |
400 | Bad Request | 错误请求 | |
401 | Unauthorized | 未经授权 | |
403 | Forbidden | 禁止 | |
500 | Internal Server Error | 内部伺服器错误 | |
503 | Service Unavailable | 暂停服务 |
狀态码 200
名称 | 型別 | 必要性 | 限制 | 描述 |
anonymous | 否 | 无 | 无 | |
» symbol | string | 是 | 无 | 代号 |
» timestamp | integer(int64) | 是 | 无 | 无 |
» status | integer(int32) | 是 | 无 | 20:成功, 16:订单未找到 |
» type | integer(int32) | 是 | 无 | 93:杠杆, 94:风险限额 |
» message | string | 是 | 无 | 无 |
!要执行此操作,必须使用以下方法之一对您进行身份验证:btse-nonce,btse-api,btse-sign
POST /api/v2/risk_limit
改变风险限额
名称 | 输入 | 型別 | 必要性 | 描述 |
body | body | 否 | 无 |
狀態 | 意义 | 描述 | 结构 |
200 | OK | 无 | Inline |
400 | Bad Request | 错误请求 | |
401 | Unauthorized | 未经授权 | |
403 | Forbidden | 禁止 | |
500 | Internal Server Error | 内部伺服器错误 | |
503 | Service Unavailable | 暂停服务 |
狀态码 200
名称 | 型別 | 必要性 | 限制 | 描述 |
anonymous | 否 | 无 | 无 | |
» symbol | string | 是 | 无 | 代号 |
» timestamp | integer(int64) | 是 | 无 | 无 |
» status | integer(int32) | 是 | 无 | 20:成功, 16:订单未找到 |
» type | integer(int32) | 是 | 无 | 93:杠杆, 94:风险限额 |
» message | string | 是 | 无 | 无 |
!要执行此操作,必须使用以下方法之一对您进行身份验证:btse-nonce,btse-api,btse-sign
Get /api/v2/positions
回传個人仓位
名称 | 输入 | 型別 | 必要性 | 描述 |
symbol | query | string | 否 | 代号(例如:BTCPFC, BTCZ19) |
狀態 | 意义 | 描述 | 结构 |
200 | OK | 无 | Inline |
400 | Bad Request | 错误请求 | |
401 | Unauthorized | 未经授权 | |
403 | Forbidden | 禁止 | |
500 | Internal Server Error | 内部伺服器错误 | |
503 | Service Unavailable | 暂停服务 |
狀态码 200
名称 | 型別 | 必要性 | 限制 | 描述 |
anonymous | 否 | 无 | 无 | |
» 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
Get /api/v2/user/trade_history
回传個人提交历史. 每次API最多回传500笔记录,且只会回传造市商方面有记录的交易历史. 如果要显示超過500笔记录的分页,您將需要指定startTime, endTime, beforeSerialId及afterSerialId参数等. 此API每秒钟只能查询2次. 另外,数据集从2019年10月开始开放.
名称 | 输入 | 型別 | 必要性 | 描述 |
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 | 否 | 包含七天以前的资料,预设是否 |
狀態 | 意义 | 描述 | 结构 |
200 | OK | 无 | Inline |
400 | Bad Request | 错误请求 | |
401 | Unauthorized | 未经授权 | |
403 | Forbidden | 禁止 | |
500 | Internal Server Error | 内部伺服器错误 | |
503 | Service Unavailable | 暂停服务 |
狀态码 200
名称 | 型別 | 必要性 | 限制 | 描述 |
anonymous | 否 | 无 | 无 | |
» 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) | 是 | 无 | 无 |
属性 | 数值 |
side | BUY/SELL(买/卖) |
!要执行此操作,必须使用以下方法之一对您进行身份验证:btse-nonce,btse-api,btse-sign
Get /api/v2/user/fees
回传個人支付费用
名称 | 输入 | 型別 | 必要性 | 描述 |
symbol | query | string | 否 | 代号代表市场名称(例如:BTCPFC, ETHPFC) |
狀態 | 意义 | 描述 | 结构 |
200 | OK | 无 | Inline |
400 | Bad Request | 错误请求 | |
401 | Unauthorized | 未经授权 | |
403 | Forbidden | 禁止 | |
500 | Internal Server Error | 内部伺服器错误 | |
503 | Service Unavailable | 暂停服务 |
狀态码 200
名称 | 型別 | 必要性 | 限制 | 描述 |
anonymous | [FeesResp] | 否 | 无 | 无 |
» symbol | string | 是 | 无 | 代号 |
» makerFee | number(double) | 是 | 无 | 掛单手续费百分比/美元(比例:10) |
» takerFee | number(double) | 是 | 无 | 吃单手续费百分比/美元(比例:10) |
!要执行此操作,必须使用以下方法之一对您进行身份验证:btse-nonce,btse-api,btse-sign
Get /api/v2/user/wallet_history
回传個人钱包历史记录. API每次最多回传500笔记录.
名称 | 输入 | 型別 | 必要性 | 描述 |
wallet | query | string | 否 | 钱包名称(例如:SPOT@, CROSS@, ISOLATED@BTCPFC-USD ) |
startTime | query | string | 否 | 回传结果 中最早的时间戳 |
endTime | query | string | 否 | 回传结果 中最新的时间戳 |
count | query | string | 否 | 查询的项目数量, 预设是10笔,而最大是500笔 |
狀態 | 意义 | 描述 | 结构 |
200 | OK | 无 | Inline |
400 | Bad Request | 错误请求 | |
401 | Unauthorized | 未经授权 | |
403 | Forbidden | 禁止 | |
500 | Internal Server Error | 内部伺服器错误 | |
503 | Service Unavailable | 暂停服务 |
狀态码 200
名称 | 型別 | 必要性 | 限制 | 描述 |
anonymous | 否 | 无 | 无 | |
» 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
Get /api/v2/user/margin
取得指定钱包的保证金信息,以便用戶可以知道他們在市场上使用哪個钱包.
名称 | 输入 | 型別 | 必要性 | 描述 |
symbol | query | string | true | 无 |
狀態 | 意义 | 描述 | 结构 |
200 | OK | 无 | Inline |
400 | Bad Request | 错误请求 | |
401 | Unauthorized | 未经授权 | |
403 | Forbidden | 禁止 | |
500 | Internal Server Error | 内部伺服器错误 | |
503 | Service Unavailable | 暂停服务 |
狀态码 200
名称 | 型別 | 必要性 | 限制 | 描述 |
anonymous | 否 | 无 | 无 | |
» 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 | 是 | 无 | 无 | |
»» 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)
GET /api/v2/orderbook/L2
取得已知市场名称的订单簿
名称 | 输入 | 型別 | 必要性 | 描述 |
symbol | query | string | 是 | 代号代表市场名称(例如:BTCPFC, ETHPFC) |
depth | query | string | 否 | 订单簿深度 |
狀態 | 意义 | 描述 | 结构 |
200 | 取得订单簿清单 | ||
400 | 错误请求 | ||
401 | 未经授权 | ||
403 | 禁止 | ||
404 | 未找到 | ||
500 | 内部伺服器错误 | ||
503 | 暂停服务 |
!此操作不需要身份验证
GET /api/v2/ohlcv
为市场提供美國线(Open High Low Close Volume). API每次最多提供300個数据點. 此API限制每秒只能查询2次. 数据集从2019年10月开始开放.
名称 | 输入 | 型別 | 必要性 | 描述 |
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個时间點 |
狀態 | 意义 | 描述 | 结构 |
200 | 取得美國线 | 无 | |
400 | 错误请求 | ||
401 | 未经授权 | ||
403 | 禁止 | ||
404 | 未找到 | ||
500 | 内部伺服器错误 | ||
503 | 暂停服务 |
!此操作不需要身份验证
GET /api/v2/price
此API提供股价指数,最新价格,及標记价格.
名称 | 输入 | 型別 | 必要性 | 描述 |
symbol | query | string | 否 | 代号代表市场名称(例如:BTCPFC, ETHPFC) |
狀態 | 意义 | 描述 | 结构 |
200 | none | inline | |
400 | 错误请求 | ||
401 | 未经授权 | ||
403 | 禁止 | ||
404 | 未找到 | ||
500 | 内部伺服器错误 | ||
503 | 暂停服务 |
狀态码 200
名称 | 型別 | 必要性 | 限制 | 描述 |
anonymous | 否 | 无 | 无 | |
» symbol | string | 是 | 无 | 无 |
» indexPrice | number(double) | 是 | 无 | 股价指数 |
» lastPrice | number(double) | 是 | 无 | 最新价格 |
» markPrice | number(double) | 是 | 无 | 標记价格 |
!此操作不需要身份验证
GET /api/v2/market_summary
此API提供了市场的高層次概況. 为您提供讯息,例如最佳买/卖,最新一天的价格走勢和成交量资讯.
名称 | 输入 | 型別 | 必要性 | 描述 |
symbol | query | string | 否 | 代号代表市场名称(例如:BTCPFC, ETHPFC) |
狀態 | 意义 | 描述 | 结构 |
200 | none | inline | |
400 | 错误请求 | ||
401 | 未经授权 | ||
403 | 禁止 | ||
404 | 未找到 | ||
500 | 内部伺服器错误 | ||
503 | 暂停服务 |
狀态码 200
名称 | 型別 | 必要性 | 限制 | 描述 |
anonymous | 否 | 无 | 无 | |
» 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 | 否 | 无 | 无 | |
» marketDetail | 否 | 无 | 无 |
!此操作不需要身份验证
GET /api/v2/trades
回传個人提交历史. 每次API最多回传500笔记录,且只会回传造市商方面有记录的交易历史. 如果要显示超過500笔记录的分页,您將需要指定startTime, endTime, beforeSerialId及afterSerialId参数等. 此API每秒钟只能查询2次. 另外,数据集从2019年10月开始开放.
名称 | 输入 | 型別 | 必要性 | 描述 |
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 | 否 | 包含七天以前的资料,预设是否 |
狀態 | 意义 | 描述 | 结构 |
200 | OK | 无 | Inline |
400 | Bad Request | 错误请求 | |
401 | Unauthorized | 未经授权 | |
403 | Forbidden | 禁止 | |
500 | Internal Server Error | 内部伺服器错误 | |
503 | Service Unavailable | 暂停服务 |
狀态码 200
名称 | 型別 | 必要性 | 限制 | 描述 |
anonymous | 否 | 无 | 无 | |
» price | number(double) | 是 | 无 | 无 |
» size | integer(int32) | 是 | 无 | 无 |
» side | string | 是 | 无 | 订单买或卖 |
» symbol | string | 是 | 无 | 市场代号 |
» serialId | integer(int64) | 是 | 无 | 无 |
» timestamp | integer(int64) | 是 | 无 | 无 |
属性 | 数值 |
side | BUY/SELL(买/卖) |
symbol | BTCPFC/ETHPFC/... |
!此操作不需要身份验证
Websocket讯息(Websocket Messages)
本节所提及的主题是提供给订阅用. WebSocket是持久连接的. 讯息是采用非同步地发送和接收. 为了正确处理WebSocket讯息,需要建立一个收听器(listener)以针对连接去执行适当动作.
每个WebSocket session保持活动60秒. 如果闲置60秒后,您将断开连线. 为确保session保持活动状态,请在达到60秒超时之前发送Ping帧.
为了订阅特定市场的订单簿摘要(feed), 需要经由订阅orderBookApi主题,并附加交易市场名称和订单簿等级的设定. 其中,交易市场名称可以从市场概况API取得,而订单簿摘要(feed)为每60毫秒更新一次.
为了订阅最近交易摘要(feed), 需要经由订阅tradeHistory主题,并附加交易市场名称的设定. 其中,交易市场名称可以从市场概况API取得. 而Websocket摘要(feed)将可发送50笔最近交易的快照(snapshot),并更新随后的交易资料.
某些Websocket主题需要通过身份认证. 因此,假如您订阅了需要认证的主题,那么您在没通过认证下将不会收到任何讯息. 而为了要进行身份认证,必须在连接Websocket之后发送authKeyExpires讯息. 如同JS程式码范例,它提供了一段身分认证的代码.
经由订阅notificationApi主题可以接收到近来的交易通知. Websocket摘要(feed)会将交易等级通知推送给订户. 如果订阅了主题但未通过身份验证,则不会发送任何讯息.
!此操作需要身份验证
结构(Schemas)
名称 | 型別 | 必要性 | 限制 | 描述 |
symbol | string | 是 | 无 | 代号 |
makerFee | number(double) | 是 | 无 | 掛单手续费百分比/美元(比例:10) |
takerFee | number(double) | 是 | 无 | 吃单手续费百分比/美元(比例:10) |
名称 | 型別 | 必要性 | 限制 | 描述 |
status | integer(int32) | 否 | 无 | 无 |
errorCode | integer(int32) | 否 | 无 | 无 |
message | string | 否 | 无 | 无 |
钱包转移至例如現货,全仓,及逐仓等
名称 | 型別 | 必要性 | 限制 | 描述 |
currency | string | 是 | 无 | 无 |
balance | number(double) | 否 | 无 | 无 |
allBalance | boolean | 否 | 无 | 转移所有余额 |
名称 | 型別 | 必要性 | 限制 | 描述 |
walletSrc | string | 否 | 无 | 當walletSrcType不等于全仓或現货時 |
walletSrcType | string | 是 | 无 | 例如从現货,全仓,或逐仓转移來 |
walletDest | string | 否 | 无 | 當walletDestType不等于全仓或現货時 |
walletDestType | string | 是 | 无 | 转移至例如現货,全仓,及逐仓等 |
apiWallets | 是 | 无 | 转移至例如現货,全仓,及逐仓等 |
属性 | 数值 |
walletSrcType | CROSS(全仓) |
walletSrcType | SPOT(現货) |
walletSrcType | ISOLATED(逐仓) |
walletSrcType | ALL(全部) |
walletDestType | CROSS(全仓) |
walletDestType | SPOT(現货) |
walletDestType | ISOLATED(逐仓) |
walletDestType | ALL(全部) |
名称 | 型別 | 必要性 | 限制 | 描述 |
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 | 是 | 无 | 无 |
名称 | 型別 | 必要性 | 限制 | 描述 |
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 | 是 | 无 | 无 |
名称 | 型別 | 必要性 | 限制 | 描述 |
symbol | string | 是 | 无 | 无 |
indexPrice | number(double) | 是 | 无 | 指数价格 |
lastPrice | number(double) | 是 | 无 | 最新价格 |
markPrice | number(double) | 是 | 无 | 標记价格 |
名称 | 型別 | 必要性 | 限制 | 描述 |
buyQuote | 是 | 无 | 订单簿的买入清单 | |
sellQuote | 是 | 无 | 订单簿的卖出清单 | |
timestamp | integer(int64) | 是 | 无 | 无 |
symbol | string | 是 | 无 | 无 |
名称 | 型別 | 必要性 | 限制 | 描述 |
symbol | string | 是 | 无 | 代号 |
timestamp | integer(int64) | 是 | 无 | 无 |
status | integer(int32) | 是 | 无 | 20:成功, 16:订单未找到 |
type | integer(int32) | 是 | 无 | 93: 杠杆 94:风险限额 |
message | string | 是 | 无 | 无 |
名称 | 型別 | 必要性 | 限制 | 描述 |
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)時,此参数不能为空 |
属性 | 数值 |
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 |
名称 | 型別 | 必要性 | 限制 | 描述 |
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 | 否 | 无 | 无 |
名称 | 型別 | 必要性 | 限制 | 描述 |
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) | 是 | 无 | 无 |
名称 | 型別 | 必要性 | 限制 | 描述 |
symbol | string | 是 | 无 | 无 |
riskLimit | integer(int32) | 是 | 无 | 观看market_info api |
名称 | 型別 | 必要性 | 限制 | 描述 |
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) | 是 | 无 | 无 |
属性 | 数值 |
side | BUY(买)/SELL(卖) |
订单簿的卖出清单
名称 | 型別 | 必要性 | 限制 | 描述 |
price | string | 否 | 无 | 无 |
size | string | 否 | 无 | 无 |
culmulativeTotal | string | 否 | 无 | 无 |
名称 | 型別 | 必要性 | 限制 | 描述 |
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 | 否 | 无 | 无 |
名称 | 型別 | 必要性 | 限制 | 描述 |
symbol | string | 是 | 无 | 无 |
leverage | number | 是 | 无 | 0:全仓钱包 |
名称 | 型別 | 必要性 | 限制 | 描述 |
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 | 否 | 无 | 无 | |
marketDetail | 否 | 无 | 无 |
名称 | 型別 | 必要性 | 限制 | 描述 |
price | number(double) | 是 | 无 | 无 |
size | integer(int32) | 是 | 无 | 无 |
side | string | 是 | 无 | 订单买或卖 |
symbol | string | 是 | 无 | 市场代号 |
serialId | integer(int64) | 是 | 无 | 无 |
timestamp | integer(int64) | 是 | 无 | 无 |
属性 | 数值 |
side | BUY/SELL(买/卖) |
symbol | BTCPFC/ETHPFC/... |
名称 | 型別 | 必要性 | 限制 | 描述 |
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) | 是 | 无 | 无 |