API Docs

API基本信息 Edit

本篇列出接口的 base URL 有：
- http base Url：https://api-mk.openex.xyz/
- wss base Url：wss://ws-mk.openex.xyz/
所有接口的响应都是 JSON 格式。
所有时间、时间戳均为UNIX时间，单位为毫秒。
如果API接口调用发生异常，API将返回错误码和错误信息。
- 错误码的定义参考 Error Codes

基本信息 Edit

請求頭
簽名

請求頭參數

參數名稱	描述
apiKey	api請求認證標識token
businessType	業務類型, `1` : U合約
signature	簽名， token所對應的`secretKey`與`timestamp`作為HMAC SHA256的密鑰，格式為`secretKey`+`timestamp`，其他所有參數作為HMAC SHA256的操作對象，得到的輸出即為簽名。

簽名加密

把請求參數使用HMAC SHA256算法secretKey+timestamp為鹽進行加密，加密後的數據放入header中的signature屬性中；

時間窗口

網絡狀況並不是可靠的，不可以完全依賴,所以添加recvWindow時間窗口，當進行高頻交易，對時效性的要求比較高，用戶根據需求設置recvWindow的值以達到要求。

{
 "apiKey": "f23f58c04ac5439d8406e2e9e3rcc26f",
 "businessType": 1,
 "signature": "a7c4a3e4224db9bc31da7bd1a0095cb8d1f07d2d1cf1460aa4f83e055892a07d"
}

 if (timestamp < (serverTime + 1000) && (serverTime - timestamp) <= recvWindow) {     //通過後的邏輯   } else {     // 沒通過的邏輯   }

劃轉賬戶列表 Edit

單一用戶賬戶列表

URL：/spot/v1/account/list
Method：GET
需要鑒權：是

請求參數

參數名稱	描述	類型	是否必需	約束
coin	幣種名稱	String	是	例如： `"USDT"`
recvWindow	時間翻轉滑窗口，時間翻轉前後多少秒請求有效	integer	否
timestamp	調用時間	Long	是

{
    "code": 1,
    "data": [
        {
            "type": "usdt", // 業務類型 usdt：U本位合約賬戶，spot：現貨賬戶，withdraw：充幣提幣賬戶
            "coin": "USDT", // 幣種
            "amount": "1330.3704832" // 可劃轉金額
        },
        {
            "type": "spot",
            "coin": "USDT",
            "amount": "998937.3452574978"
        }
    ]
}

{
 "code": 9999,
 "message": "异常信息"
}

賬戶劃轉 Edit

單一用戶賬戶之間的資金劃轉

URL：/spot/v1/account/transfer
Method：POST
需要鑒權：是

請求參數

參數名稱	描述	類型	是否必需	約束
type	转出账户	String	是	目前支持的type劃轉類型: `"usdt-to-withdraw"` : 從U本位合約賬戶到充幣提幣賬戶, `"withdraw-to-usdt"` : 從充幣提幣賬戶到U本位合約賬戶, `"spot-to-withdraw"` : 從現貨賬戶到充幣提幣賬戶, `"withdraw-to-spot"` : 從充幣提幣賬戶到現貨賬戶, `"usdt-to-spot"` : 從U本位到現貨賬戶, `"spot-to-usdt"` : 從現貨到U本位賬戶
coin	轉賬幣種	String	是	見幣種列表接口
amount	轉賬數量	Decimal	是	大於0的數字
recvWindow	時間戳滑動窗口，時間戳前後多少毫秒請求有效	integer	否
timestamp	調用時間	Long	是

{
  "type":"withdraw-to-usdt",
  "coin":"USDT",
  "amount":120
}

{
    "code": 1,
    "message": "",
    "data": true
}

{
 "code": 9998,
 "message": "参数错误:type"
}

劃轉記錄 Edit

單一用戶劃轉記錄

URL：/spot/v1/account/transfer/history
Method：GET
需要鑒權：是

請求參數

參數名稱	描述	類型	是否必需	約束
startTime	開始時間戳	Long	否	`1` : USDT合約， `3` : 現貨， `4` : 充提幣
endTime	結束時間戳	Long	否	`1` : USDT合約， `3` : 現貨， `4` : 充提幣
coin	轉賬幣種	String	是
fromId	上次列表的最後一條數據的id	Long	否	第一頁為空，其他頁必須有值
limit	每頁條數	Integer	是	大於0小於等於100的整數
signature	簽名	String	是
timestamp	調用時間	Long	是

{
    "code": 1,
    "data": [
        {
            "id": 1709,
            "type": "withdraw-to-usdt",
            "coin": "USDT",
            "amount": "120",
            "status": 1, // 1:成功 0：待處理
            "reason": "", // 失敗原因
            "createTime": 1657179001000
        },
        {
            "id": 1686,
            "type": "withdraw-to-spot",
            "coin": "USDT",
            "amount": "1000",
            "status": 1, // 1:成功 0：待處理
            "reason": "",  // 失敗原因
            "createTime": 1657173979000
        }
    ]
}

{
 "code": 9999,
 "message": "异常信息"
}

單業務賬戶資產 Edit

單一用戶單個業務賬戶資產

URL：/spot/v1/account/assets/detail
Method：GET
需要鑒權：是

請求參數

參數名稱	描述	类型	是否必须	約束
convertCoin	資產展示幣種	String	否	默認 `"USDT"`
type	賬戶類型	String	Yes	`"usdt"`：U本位合約賬戶， `"spot"`：現貨賬戶， `"withdraw"`：充幣提幣賬戶
recvWindow	時間戳滑動窗口，時間戳前後多少毫秒請求有效	integer	否
timestamp	調用時間	integer	是

{
    "code": 1,
    "data": {
        "type": "usdt", // 業務類型 usdt：U本位合約，spot：現貨
        "convertCoin": "BTC", // 展示幣種
        "assetsAsXXX": "0.065127782241623264", // 總資產（折算展示幣種）
        "assetsAsUSDT": "1330.3704832", // 總資產（折算USDT）
        "detailAssetsList": [
            {
                "coin": "USDT", // 幣種
                "assets": "1330.3704832", // 資產（未折算）
                "holdAssets": "0", // 凍結資產（未折算）
                "availableBalance": "1330.3704832", // 下單可用余額
                "maxWithdrawAmount": "1330.3704832", // 最大可提余額
                "convertCoin": "BTC",
                "assetsAsXXX": "0.065127782241623264", // 資產（折算展示幣種）
                "assetsAsUSDT": "1330.3704832", // 資產（折算USDT）
                "holdAssetsAsXXX": "0", // 凍結資產（折算展示幣種）
                "holdAssetsAsUSDT": "0" // 凍結資產（折算USDT）
            }
        ]
    }
}

單業務持倉信息 Edit

獲取單業務持倉信息

URL：/usdt/v1/trade/positions
Method：GET
需要鑒權：是

請求參數

參數名稱	描述	類型	是否必需	約束
symbol	交易對	String	否	例： `"BTC/USDT"`，USDT 合約可以為空
marginType	保證金模式	String	是	`"CROSSED"` : 全倉， `"ISOLATED"` : 逐倉
positionMode	倉位模式	String	是	`"MERGE"` : 合倉， `"PART"` : 分倉
positionSide	持倉方向	String	否	`"LONG"` : 多， `"SHORT"` : 空
recvWindow	時間戳滑動窗口，時間戳前後多少毫秒請求有效	integer	否
timestamp	調用時間	integer	是

{
    "code": 1,
    "data": [
        {
            "id": 1229568718259461, // 倉位id
            "type": "usdt", // 業務類型 usdt：U本位合約
            "symbol": "BTC/USDT", // 交易對
            "marginType": "CROSSED", // 保證金模式 CROSSED-全倉 ISOLATED-逐倉
            "positionSide": "LONG", // 持倉方向 LONG-多 SHORT-空
            "positionAmt": "2", // 倉位數量
            "availablePositionAmt": "2", // 可用倉位數量
            "entryPrice": "20402.15", // 開倉均價
            "leverage": "73", // 持倉杠桿
            "positionMargin": "1.117926027397260243", // 倉位保證金
            "closeCommission": "0.02448258", // 平倉傭金
            "positionValue": "81.6086", // 倉位價值
            "indexPrice": "20399.703", // 當前指數價
            "unrealizedProfit": "-0.009788", // 持倉未實現盈虧
            "positionMode": "PART" // MERGE-合倉 PART-分倉
        },
        {
            "id": 1229568766608645,
            "type": "usdt",
            "symbol": "BTC/USDT",
            "marginType": "CROSSED",
            "positionSide": "SHORT",
            "positionAmt": "2",
            "availablePositionAmt": "2",
            "entryPrice": "20401.51",
            "leverage": "73",
            "positionMargin": "1.117890958904109558",
            "closeCommission": "0.024481812",
            "positionValue": "81.60604",
            "indexPrice": "20399.703",
            "unrealizedProfit": "0.007228",
            "positionMode": "PART"
        }
    ]
}

下單 Edit

URL：/usdt/v1/trade/order
Method：POST
需要鑒權：是

備註：

positionId可以從調用單業務持倉信息的請求返回參數id獲取。
倉位模式可以調用變換合分倉配置來修改。

請求參數

參數名稱	類型	是否必需	描述
symbol	String	是	交易對
side	Enum	是	買賣方向: `"BUY"`,`"SELL"`
positionSide	Enum	是	持倉方向: `"LONG"`,`"SHORT"`
positionId	Long	否	倉位ID (只有當下倉位模式是分倉才可能需要傳入) 以下場景`positionId`必傳： 1. 為原本倉位追加倉位時 2. 平倉　i. 做多平倉 (`positionSide`為`LONG`，`side`為`SELL`) 　ii. 做空平倉 (`positionSide`為`SHORT`，`side`為`BUY`)
type	Enum	是	訂單類型: `"LIMIT"`,`"MARKET"`
quantity	BigDecimal	是	下單數量
price	BigDecimal	否	委托價格
clientOrderId	String	否	客户自定义订单ID 目前僅支持做市商帳號使用。必須是字母（区分大小写）与数字的组合，且长度要在1-32位之间。
recvWindow	Long	否	時間戳滑動窗口，單位為毫秒
timestamp	Long	是	調用時間

{
 "symbol": "BTC/USDT",
 "side": "BUY",
 "positionSide": "LONG",
 "positionId": "1229231381528580",
 "type": "LIMIT",
 "quantity": 10,
 "price": 100.01
 "recvWindow": 0,
 "timestamp": 0,
}

{
 "code": 1,
 "data": [
   {
     "orderId": 1229231381528581//订单id
   }
 ],
 "message": ""
}

{
 "code": 9999,
 "message": "异常信息"
}

批量下單 Edit

URL：/usdt/v1/trade/batchOrders
Method：POST
需要鑒權：是

請求參數

參數名称	類型	是否必需	描述
batchOrders	List<OrderRequest>	是	訂單列表，最多支持5個訂單
recvWindow	Long	否	時間戳滑動窗口，單位為毫秒
timestamp	Long	是	調用時間

OrderRequest

參數名称	類型	是否必需	描述
symbol	String	是	交易對
side	Enum	是	買賣方向: `"BUY"`,`"SELL"`
positionSide	Enum	是	持倉方向: `"LONG"`,`"SHORT"`
positionId	Long	否	倉位ID (只有當下倉位模式是分倉才可能需要傳入) 以下場景`positionId`必傳： 1. 為原本倉位追加倉位時 2. 平倉　i. 做多平倉 (`positionSide`為`LONG`，`side`為`SELL`) 　ii. 做空平倉 (`positionSide`為`SHORT`，`side`為`BUY`)
type	Enum	是	訂單類型: `"LIMIT"`,`"MARKET"`
quantity	BigDecimal	是	下單數量
price	BigDecimal	否	委托價格
clientOrderId	String	否	客户自定义订单ID 目前僅支持做市商帳號使用。必須是字母（区分大小写）与数字的组合，且长度要在1-32位之间。

{
 "batchOrders": [{
   "symbol": "BTC/USDT",
   "positionSide": "LONG",
   "positionId": "1229231381528580",
   "type": "LIMIT",
   "quantity": 10,
   "price": 100.01
  }],
 "recvWindow": 5000,
 "timestamp": 1657162729000
}

{
 "code": 1,
 "data": [
   {
     "orderId": 1229231381528581,
     "clientOrderId": "newClientOrderId0001"
   },
   {
     "orderId": 1229231381528582,
     "clientOrderId": "newClientOrderId0002"
   }
 ],
 "message": ""
}

{
 "code": 9999,
 "message": "异常信息"
}

撤消訂單 Edit

URL：/usdt/v1/trade/order
Method：DELETE
需要鑒權：是

備註：

對於請求參數orderId和clientOrderId必須傳其中一個。若都傳，則會使用orderId。

請求參數

參數名稱	類型	是否必需	描述
symbol	String	是	交易對
orderId	Long	可選	訂單號
clientOrderId	String	可選	客户自定义订单ID 目前僅支持做市商帳號使用。必須是字母（区分大小写）与数字的组合，且长度要在1-32位之间。
recvWindow	Long	否	時間戳滑動窗口，單位為毫秒
timestamp	Long	是	調用時間

{
 "symbol": "BTC/USDT",
 "orderId": 1229231391899653,
 "recvWindow": 5000,
 "timestamp": 1657162729000
}

{
 "code": 1,
 "data": true,
 "message": ""
}

{
 "code": 9999,
 "message": "异常信息"
}

批量撤消訂單 Edit

URL：/usdt/v1/trade/batchOrders
Method：DELETE
需要鑒權：是

備註：

對於請求參數orderIdList和clientOrderIdList必須傳其中一個。若都傳，則會使用orderIdList。

請求參數

參數名稱	類型	是否必需	描述
symbol	String	是	交易對
orderIdList	List<Long>	可選	訂單號集合
clientOrderIdList	List<String>	可選	客户自定义订单ID集合目前僅支持做市商帳號使用。每個`clientOrderId`都必須是字母（区分大小写）与数字的组合，且长度要在1-32位之间。
recvWindow	Long	否	時間戳滑動窗口，單位為毫秒
timestamp	Long	是	調用時間

/usdt/v1/trade/batchOrders?symbol=BTC/USDT&orderIdList=1229231391899653,1229231391899654&recvWindow=5000&timestamp=1657162729000

{
 "code": 1,
 "data": true,
 "message": ""
}

{
 "code": 9999,
 "message": "异常信息"
}

撤消全部訂單 Edit

URL：/usdt/v1/trade/allOpenOrders
Method：DELETE
需要鑒權：是

請求參數

參數名稱	類型	是否必需	描述
symbol	String	YES	交易對
recvWindow	Long	NO	時間戳滑動窗口，單位為毫秒
timestamp	Long	YES	調用時間

{
 "symbol": "BTC/USDT",
 "recvWindow": 5000,
 "timestamp": 1657162729000
}

{
 "code": 1,
 "data": true,
 "message": ""
}

{
 "code": 9999,
 "message": "异常信息"
}

創建止盈止損 Edit

URL：/usdt/v1/trade/planOrder
Method：POST
需要鑒權：是

請求參數

參數名稱	類型	是否必需	描述
symbol	String	YES	交易對
side	Enum	YES	買賣方向, `"BUY"` : 買, `"SELL"` : 賣
positionSide	Enum	YES	持倉方向, `"LONG"` : 多, `"SHORT"` : 空
type	Enum	YES	訂單類型, `"TAKE_PROFIT"` : 止盈限價單, `"TAKE_PROFIT_MARKET"` : 止盈市價單, `"STOP"` : 止損限價單, `"STOP_MARKET"` : 止損市價單
quantity	BigDecimal	YES	下單數量
workingType	Enum	YES	觸發類型, `"INDEX_PRICE"` : 指數價
stopPrice	BigDecimal	YES	觸發價
price	BigDecimal	NO	執行價格
sourceType	Enum	YES	來源, `"ORDER"` : 訂單, `"POSITION"` : 倉位
sourceId	Long	YES	來源id
recvWindow	Long	NO	時間戳滑動窗口，單位為毫秒
timestamp	Long	YES	調用時間

{
	"positionSide": "LONG",
	"price": 20000,
	"quantity": 1,
	"recvWindow": 5000,
	"side": "BUY",
	"sourceId": 1208218841498181,
	"sourceType": "POSITION",
	"stopPrice": 19500,
	"symbol": "ETH/USDT",
	"timestamp": 1656913877424,
	"type": "TAKE_PROFIT_MARKET",
	"workingType": "INDEX_PRICE"
}

{
  "code": 1,
  "data": {
    "orderId": 120821181//訂單id
  },
  "message": "SUCCESS"
}

{
  "code": 9999,
  "message": "異常信息"
}

撤消止盈止損 Edit

URL：/usdt/v1/trade/planOrder
Method：DELETE
需要鑒權：是

請求參數

參數名稱	類型	是否必需	描述
symbol	String	YES	交易對
orderId	Long	YES	訂單號
recvWindow	Long	NO	時間戳滑動窗口，單位為毫秒
timestamp	Long	YES	調用時間

{
  "code": 1,
  "data": {
   "symbol": "ETH/USDT",
   "orderId": 1208218841498181,
   "timestamp": 1656913877424,
   "recvWindow": 5000
  }
}

{
 "code": 1,
 "data": true
}

{
 "code": 9999,
 "message": "异常信息"
}

批量撤消止盈止損 Edit

URL：/usdt/v1/trade/planOrders
Method：DELETE
需要鑒權：是

請求參數

參數名稱	類型	是否必需	描述
symbol	String	YES	交易對
orderIds	List<Long>	YES	訂單號集合
recvWindow	Long	NO	時間戳滑動窗口，單位為毫秒
timestamp	Long	YES	調用時間

/usdt/v1/trade/planOrders?symbol=ETH/USDT&orderIds=1208218841498181,1208218841498182&recvWindow=5000&timestamp=1656913877424

{
 "code": 1,
 "data": true
}

{
 "code": 9999,
 "message": "异常信息"
}

修改用戶杠桿配置 Edit

URL：/usdt/v1/trade/leverage
Method：POST
需要鑒權：是

請求參數

參數名稱	類型	是否必需	描述
symbol	String	YES	交易對
leverage	Integer	YES	杠桿，用於U合約下單的時候
recvWindow	Long	NO	時間戳滑動窗口，單位為毫秒
timestamp	Long	YES	調用時間

{
 "symbol": "BTC/USDT",
 "leverage": 100,
 "recvWindow": 5000,
 "timestamp": 1657162729000
}

{
 "code": 1,
 "data": true,
 "message": ""
}

{
 "code": 9999,
 "message": "异常信息"
}

變換全逐倉配置 Edit

URL：/usdt/v1/trade/marginType
Method：POST
需要鑒權：是

請求參數

參數名稱	類型	是否必需	描述
symbol	String	NO	交易對
marginType	Enum	YES	保證金類型 `"CROSSED"`: 全倉, `"ISOLATED"`: 逐倉
recvWindow	Long	NO	時間戳滑動窗口，單位為毫秒
timestamp	Long	YES	調用時間

{
 "symbol": "BTC/USDT",
 "marginType": "CROSSED",
 "recvWindow": 5000,
 "timestamp": 1657162729000
}

{
 "code": 1,
 "data": true,
 "message": ""
}

{
 "code": 9999,
 "message": "異常信息"
}

變換合分倉配置 Edit

URL：/usdt/v1/trade/positionMode
Method：POST
需要鑒權：是

請求參數

參數名稱	類型	是否必需	描述
positionMode	Integer	YES	合分倉模式, `"MERGE"` : 合倉, `"PART"` : 分倉
recvWindow	Long	NO	時間戳滑動窗口，單位為毫秒
timestamp	Long	YES	調用時間

{
 "positionMode": "MERGE",
 "recvWindow": 5000,
 "timestamp": 1657180630329
}

{
 "code": 1,
 "data": true,
 "message": ""
}

{
 "code": 9999,
 "message": "异常信息"
}

調整逐倉保證金 Edit

URL：/usdt/v1/trade/positionMargin
Method：POST
需要鑒權：是

備註：

如果遇到錯誤碼9008, 代表當下不是逐倉設置。需要先調用变换全逐仓配置且把請求參數 marginType 設置為 ISOLATED。
如果遇到錯誤碼9009, 代表當下是分倉模式設置, 請求參數positionId需要傳入。或者需要改成合倉模式，也可以調用變換合分倉配置且把請求參數positionMode 設置為 MERGE。

請求參數

參數名稱	類型	是否必需	描述
symbol	String	YES	交易對
amount	BigDecimal	YES	保證金資金，必須大於0
type	Integer	YES	調整方向 `1` : 增加逐倉保證金， `2` : 減少逐倉保證金
positionId	Long	NO	倉位id，分倉必填
recvWindow	Long	NO	時間戳滑動窗口，單位為毫秒
timestamp	Long	YES	調用時間

{
 "symbol": "BTC/USDT",
 "amount": 100.55,
 "type": 1,
 "positionId": 1229231408676869,
 "recvWindow": 0500,
 "timestamp": 1657180630329
}

{
 "code": 1,
 "data": true,
 "message": ""
}

{
 "code": 9999,
 "message": "异常信息"
}

成交歷史 Edit

URL：/usdt/v1/trade/userTrades
Method：GET
需要鑒權：是

請求參數

參數名稱	類型	是否必需	描述
symbol	String	YES	交易對
fromId	Long	NO	返回該`fromId`及之後的成交，缺省返回最近的成交
limit	Integer	NO	返回的結果集數量，默認值 : 200，最大值 : 1000
startTime	Long	YES	起始時間
endTime	Long	YES	結束時間
recvWindow	Long	NO	時間戳滑動窗口，單位為毫秒
timestamp	Long	YES	調用時間

{
 "symbol": "ETH/USDT",
 "fromId": 1208218841498181,
 "limit": 200,
 "startTime": 1654840101939,
 "endTime": 1655099837239,
 "timestamp": 1655099837259,
 "recvWindow": 5000
}

{
 "code": 1,
 "data": [{
   "id": 1229231370945733, //交易id
   "orderId": 1229231370027013, //訂單編號
   "symbol": "ETH/USDT", //交易對
   "price": "1133.97", //成交價
   "qty": "1", //成交量
   "realizedPnl": "1.280800714285714285", //實現盈虧
   "commission": "0.01700955", //手續費
   "commissionAsset": "USDT", //手續費計價單位
   "side": "SELL", //買賣方向
   "positionSide": "LONG", //持倉方向
   "time": 1657162731000 //時間
  }],
 "message": ""
}

{
 "code": 9999,
 "message": "异常信息"
}

查詢委托訂單 Edit

URL：/usdt/v1/trade/openOrder
Method：GET
需要鑒權：是

備註：

對於請求參數orderId和clientOrderId必須傳其中一個。若都傳，則會使用orderId。

請求參數

參數名稱	類型	是否必需	描述
symbol	String	是	交易對
orderId	Long	可選	訂單號
clientOrderId	String	可選	客户自定义订单ID 目前僅支持做市商帳號使用。必須是字母（区分大小写）与数字的组合，且长度要在1-32位之间。
recvWindow	Long	否	時間戳滑動窗口，單位為毫秒
timestamp	Long	是	調用時間

{
 "symbol": "ETH/USDT",
 "orderId": 1208218841498181,
 "timestamp": 1655099837259,
 "recvWindow": 5000
}

{
 "code": 1,
 "data": {
   "orderId": 1229231334670341,//訂單號
   "symbol": "ETH/USDT",//交易對
   "type": "LIMIT",//訂單類型,LIMIT:限價單,MARKET:市價單
   "price": "1089.58",//用戶填寫的價格或者市價
   "avgPrice": "0",//平均成交價
   "side": "BUY",//買賣方向,BUY:買,SELL:賣
    "positionSide": "LONG",//持倉方向,LONG:多,SHORT:空
   "origQty": "1",//原始委托數量
   "executedQty": "0",//成交數量
   "status": "NEW",//訂單狀態,NEW:掛單,PARTIALLY_FILLED:部分成交,FILLED:完全成交,CANCELED:已撤銷
   "createTime": 1657162729000,//創建時間
   "updateTime": 1657162729000//更新時間
  }
}

{
 "code": 9999,
 "message": "异常信息"
}

查詢全部委托訂單 Edit

URL：/usdt/v1/trade/openOrders
Method：GET
需要鑒權：是

請求參數

參數名稱	類型	是否必需	描述
symbol	String	否	交易對
recvWindow	Long	否	時間戳滑動窗口，單位為毫秒
timestamp	Long	是	調用時間

{
 "symbol": "ETH/USDT",
 "timestamp": 1655099837259,
 "recvWindow": 5000
}

{
 "code": 1,
 "data": [{
   "orderId": 1229231334670341,//訂單號
   "symbol": "ETH/USDT",//交易對
   "type": "LIMIT",//訂單類型,LIMIT:限價單,MARKET:市價單
   "price": "1089.58",//用戶填寫的價格或者市價
   "avgPrice": "0",//平均成交價
   "side": "BUY",//買賣方向,BUY:買,SELL:賣
    "positionSide": "LONG",//持倉方向,LONG:多,SHORT:空
   "origQty": "1",//原始委托數量
   "executedQty": "0",//成交數量
   "status": "NEW",///訂單狀態,NEW:掛單,PARTIALLY_FILLED:部分成交,FILLED:完全成交,CANCELED:已撤銷
   "createTime": 1657162729000,//創建時間
   "updateTime": 1657162729000//更新時間
  }]
}

{
 "code": 9999,
 "message": "异常信息"
}

查詢止盈止損 Edit

URL：/usdt/v1/trade/planOrder
Method：GET
需要鑒權：是

請求參數

參數名稱	類型	是否必需	描述
symbol	String	YES	交易對
orderId	Long	YES	訂單號
recvWindow	Long	NO	時間戳滑動窗口，單位為毫秒
timestamp	Long	YES	調用時間

{
 "symbol": "ETH/USDT",
 "orderId": 1208218841498181,
 "timestamp": 1656913877424,
 "recvWindow": 5000
}

{
 "code": 1,
 "data": {
   "id": 1220933363843653,//訂單id
   "userId": 1119209245245445,//用戶id
   "tenantId": 0,//租戶id
   "symbol": "BTC/USDT",//幣對
   "businessType": 1,//業務類型,1:U合約
   "marginMode": 1,//保證金模式,1:全倉,2:逐倉
   "userType": 1,//用戶類型 1:做事賬戶,2:普通
   "sourceId": 1225311700583109,//來源id
   "sourceType": 1,//來源,1:訂單,2:倉位
   "type": "TAKE_PROFIT",//TAKE_PROFIT:止盈限價單,TAKE_PROFIT_MARKET:止盈市價單,STOP:止損限價單,STOP_MARKET:止損市價單
   "side": "BUY",//買賣方向,BUY:買,SELL:賣
   "positionSide": "LONG",//持倉方向,LONG:多,SHORT:空
   "workingType": 2,//觸發類型,2:指數價格
   "stopPrice": 19500.2,//觸發價格
   "positionMode": 1,//倉位模式,1:合倉,2:分倉
   "indexPrice": 19600.3,//觸發時指數價格
   "orderIndexPrice": 19400.3,//下單時指數價格
   "quantity": 10,//下單數量
   "status": 3,//狀態，1:未生效,2:已生效,3:已觸發,4:取消,5:爆倉撤單,6:平倉撤單,7:預設止盈止損失敗撤單
   "createTime": "2022-07-04 16:31:34",//創建時間
   "updateTime": "2022-07-04 16:50:21"//更新時間
   "triggeredDate": "2022-07-04 16:50:21"//觸發時間
  },
 "message": ""
}

{
 "code": 9999,
 "message": "异常信息"
}

批量查詢止盈止損 Edit

URL：/usdt/v1/trade/planOrders
Method：GET
需要鑒權：是

請求參數

參數名稱	類型	是否必需	描述
symbol	String	NO	交易對
fromId	Long	NO	返回該`fromId`及之後的成交，缺省返回最近的成交
limit	Integer	NO	返回的結果集數量，默認值 : 200，最大值 : 1000
recvWindow	Long	NO	時間戳滑動窗口，單位為毫秒
timestamp	Long	YES	調用時間

{
 "symbol": "ETH/USDT",
 "fromId": 1208218841498181,
 "limit": 200,
 "timestamp": 1656913877424,
 "recvWindow": 5000
}

{
 "code": 1,
 "data": [{
   "id": 1220933363843653,//訂單id
   "userId": 1119209245245445,//用戶id
   "tenantId": 0,//租戶id
   "symbol": "BTC/USDT",//幣對
   "businessType": 1,//業務類型,1:U合約
   "marginMode": 1,//保證金模式,1:全倉,2:逐倉
   "userType": 1,//用戶類型 1:做事賬戶,2:普通
   "sourceId": 1225311700583109,//來源id
   "sourceType": 1,//來源,1:訂單,2:倉位
   "type": "TAKE_PROFIT",//TTAKE_PROFIT:止盈限價單,TAKE_PROFIT_MARKET:止盈市價單,STOP:止損限價單,STOP_MARKET:止損市價單
   "side": "BUY",//買賣方向,BUY:買,SELL:賣
   "positionSide": "LONG",//持倉方向,LONG:多,SHORT:空
   "workingType": 2,//觸發類型,2:指數價格
   "stopPrice": 19500.2,//觸發價格
   "positionMode": 1,//倉位模式,1:合倉,2:分倉
   "indexPrice": 19600.3,//觸發時指數價格
   "orderIndexPrice": 19400.3,//下單時指數價格
   "quantity": 10,//下單數量
   "status": 3,//狀態，1:未生效,2:已生效,3:已觸發,4:取消,5:爆倉撤單,6:平倉撤單,7:預設止盈止損失敗撤單
   "createTime": "2022-07-04 16:31:34",//創建時間
   "updateTime": "2022-07-04 16:50:21"//更新時間
   "triggeredDate": "2022-07-04 16:50:21"//觸發時間
  }],
 "message": ""
}

{
 "code": 9999,
 "message": "异常信息"
}

歷史止盈止損 Edit

URL：/usdt/v1/trade/planOrdersHistory
Method：GET
需要鑒權：是

請求參數

參數名稱	類型	是否必需	描述
symbol	String	NO	交易對
fromId	Long	NO	返回該`fromId`及之後的成交，缺省返回最近的成交
limit	Integer	NO	返回的結果集數量，默認值 : 200，最大值 : 1000
recvWindow	Long	NO	時間戳滑動窗口，單位為毫秒
timestamp	Long	YES	調用時間

{
 "symbol": "ETH/USDT",
 "fromId": 1208218841498181,
 "limit": 200,
 "timestamp": 1656913877424,
 "recvWindow": 5000
}

{
 "code": 1,
 "data": [{
   "id": 1220933363843653,//訂單id
   "userId": 1119209245245445,//用戶id
   "tenantId": 0,//租戶id
   "symbol": "BTC/USDT",//幣對
   "businessType": 1,//業務類型,1:U合約
   "marginMode": 1,//保證金模式,1:全倉,2:逐倉
   "userType": 1,//用戶類型 1:做事賬戶,2:普通
   "sourceId": 1225311700583109,//來源id
   "sourceType": 1,//來源,1:訂單,2:倉位
   "type": "TAKE_PROFIT",//TAKE_PROFIT:止盈限價單,TAKE_PROFIT_MARKET:止盈市價單,STOP:止損限價單,STOP_MARKET:止損市價單
   "side": "BUY",//買賣方向,BUY:買,SELL:賣
   "positionSide": "LONG",//持倉方向,LONG:多,SHORT:空
   "workingType": 2,//觸發類型,2:指數價格
   "stopPrice": 19500.2,//觸發價格
   "positionMode": 1,//倉位模式,1:合倉,2:分倉
   "indexPrice": 19600.3,//觸發時指數價格
   "orderIndexPrice": 19400.3,//下單時指數價格
   "quantity": 10,//下單數量
   "status": 3,//狀態，1:未生效,2:已生效,3:已觸發,4:取消,5:爆倉撤單,6:平倉撤單,7:預設止盈止損失敗撤單
   "createTime": "2022-07-04 16:31:34",//創建時間
   "updateTime": "2022-07-04 16:50:21"//更新時間
  }],
 "message": ""
}

{
 "code": 9999,
 "message": "异常信息"
}

幣種列表 Edit

URL：/spot/v1/coins
Method：GET
需要鑒權：否

請求參數

無

{
 "code": 1,
 "data": [{
   "coin": ETH,//幣種
   "isDeposit": 1,//是否支持充幣,1是,0否
   "isWithdraw": 1,//是否支持提幣,1是,0否
   "status": 0//狀態,1:有效,0無效
  }],
 "message": ""
}

{
 "code": 9999,
 "message": "异常信息"
}

交易對列表 Edit

URL：/usdt/v1/trade/symbols
Method：GET
需要鑒權：否

請求參數

無

{
 "code": 1,
 "data": [{
   "symbol": "BTC/USDT",//交易對
   "coin": "BTC",//计量币
   "quoteCoin": "USDT",//計量幣
   "coinScale": 2,//計量幣小數位
   "quoteCoinScale": 2,//計價幣小數位
   "status": 1//狀態:1啟用,0停用
  }]
}

{
 "code": 9999,
 "message": "異常信息"
}

系統時間 Edit

URL：/spot/v1/time
Method：GET
需要鑒權：否

請求參數

無

{
 "code": 1,
 "data": {
    "serverTime": 1657173423730//系統時間
  }
}

{
 "code": 9999,
 "message": "异常信息"
}

指數價格 Edit

URL：/usdt/v1/market/index?symbol=ETH/USDT
Method：GET

請求參數

參數	類型	是否必填	描述
symbol	String	true	幣對

{
  "code": 1,
  "data": {
     "symbol": "EOS/USDT",
     "indexPrice": "2.445"
  },
  "message": "SUCCESS"
}

{
  "code": 0,
  "data": null,
  "message": "FAILURE"
}

指數價格(批量) Edit

URL： /usdt/v1/market/index/list
Method：POST

請求參數

參數	類型	是否必填	描述
symbolArray	String[]	true	幣對

{
	"symbolArray": ["BTC/USDT","EOS/USDT"]
}

{
  "code": 1,
  "data": [
    {
      "symbol": "BTC/USDT",
      "indexPrice": "40781.23"
    },
    {
      "symbol": "EOS/USDT",
      "indexPrice": "2.445"
    }
  ],
  "message": "SUCCESS"
}

{
  "code": 0,
  "data": null,
  "message": "FAILURE"
}

深度 Edit

URL：/usdt/v1/market/depth?symbol=EOS/USDT
Method：GET

請求參數

參數	類型	是否必填	描述
symbol	String	true	幣對

{
  "code": 1,
  "data": {
    "symbol": "EOS/USDT",//幣對
    "bids": [ //買單
      [
        "1.999",//價格
        "9592"//數量
      ]
    ],
    "asks": [//賣單
      [
        "2.6",
        "1"
      ],
      [
        "2.55",
        "4840"
      ]
      
    ]
  },
  "message": "SUCCESS"
}

{
  "code": 0,
  "data": null,
  "message": "FAILURE"
}

實時成交 Edit

URL：/usdt/v1/market/realTime?symbol=EOS/USDT
Method：GET

請求參數

參數	類型	是否必填	描述
symbol	String	true	幣對

{
  "code": 1,
  "data": [
    {
      "size": "1",//數量
      "price": "1.999",//價格
      "side": 2,//方向 1:買 2:賣
      "time": 1650274754613,//時間
      "symbol": "EOS/USDT"
    },
    {
      "size": 1,
      "price": 2.55,
      "side": 1,
      "time": 1650274751574,
      "symbol": "EOS/USDT"
    },
    {
      "size": 1,
      "price": 2.55,
      "side": 1,
      "time": 1650274719644,
      "symbol": "EOS/USDT"
    }
  ],
  "message": "SUCCESS"
}

{
  "code": 0,
  "data": null,
  "message": "FAILURE"
}

K線 Edit

URL：/usdt/v1/market/kline
Method：GET

請求參數

參數	类型	是否必填	描述
symbol	String	true	幣對
type	Integer	true	周期類型 : 0 : 1 min, 2 : 5 min, 3 : 15 min, 4 : 30 min, 5 : 1 hour, 7 : 4 hour, 10 : 1 day, 11 : 1 week, 12 : 1 month, 13 : 1 year
since	Long	true	k線開始時間戳精確到分鐘(1650016682000)
end	Long	true	k線結束時間戳精確到分鐘

{
  "code": 1,
  "data": [
    {
      "open": "40373.2",//开盘价
      "high": "40391.82",//最高价
      "low": "40372.84",//最低价格
      "close": "40391.72",//收盘价格
      "volume": "0.0522",//成交数
      "amount": "2107.840752",//成交额
      "type": 0,//周期类型
      "time": 1650096180000,//时间
      "symbol": "BTC/USDT"//币对
    }
  ]
  "message": "SUCCESS"
}

{
  "code": 0,
  "data": null,
  "message": "FAILURE"
}

24小時行情 Edit

URL：/usdt/v1/market/ticker?symbol=BTC/USDT
Method：GET

請求參數

參數	類型	是否必填	描述
symbol	String	true	幣對

{
  "code": 1,
  "data": {
    "time": "1650278049804",//時間
    "last": "39056.18",//價格
    "change": "-3.43",//漲跌幅
    "symbol": "BTC/USDT",//幣對
    "open": "40421.94",//開盤價格
    "high": "40593.22",//24小時最高價格
    "low": "38538.02",//24小時最低價格
    "volume": "182.40568",//成交量
    "amount": "7223419.4784845"//成交金額
  },
  "message": "SUCCESS"
}

{
  "code": 0,
  "data": null,
  "message": "FAILURE"
}

24小時行情(批量) Edit

URL：/usdt/v1/market/ticker/list
Method：POST

請求參數

參數	類型	是否必填	描述
symbolArray	String[]	true	幣對

{
	"symbolArray": ["BTC/USDT","EOS/USDT"]
}

{
  "code": 1,
  "data": [
    {
      "time": "1650269906549",//時間
      "last": "38989",//價格
      "change": "-3.56",//漲跌幅
      "symbol": "BTC/USDT"//幣對
    },
    {
      "time": "1650274754627",
      "last": "1.999",
      "change": "-21.61",
      "symbol": "EOS/USDT"
    }
  ],
  "message": "SUCCESS"
}

{
  "code": 0,
  "data": null,
  "message": "FAILURE"
}

基本信息 Edit

連接方式如下：
- Base Url：wss://ws-mk.openex.xyz
- URL格式為 /usdt

心跳規則：

心跳次數/30s
客戶端發送：{"event":"ping"}

服務端回執：{"event":"pong"}

公用code碼（type字段為訂閱類型）
成功訂閱	{"code":1,"desc":"success","type":"MARKET"}
事件類型不存在	{"code":10001,"desc":"不存在的事件類型","type":"MARKET"}
請求json格式錯誤	{"code":10000,"desc":"json格式錯誤","type":"MARKET"}

指數 Edit

{
	"event": "SUB",
	"type": "INDEX_PRICE",
	"symbol": "BTC/USDT"
}

{
	"event": "UNSUB",
	"type": "INDEX_PRICE",
	"symbol": "BTC/USDT"
}

{
  "symbol": "BTC/USDT",
  "type": "INDEX_PRICE",
  "data": "40658.981000000",
  "ts": 1650352557873
}

{
	"code": 1,
	"desc": "success",
	"topic": {
		"event": "SUB",
		"type": "INDEX_PRICE_ALL",
		"symbols": "BTC/USDT,ETH/USDT"
	}
}

指數(批量) Edit

{
	"event": "SUB",
	"type": "INDEX_PRICE_ALL",
	"symbols": "BTC/USDT,ETH/USDT"
}

{
	"event": "UNSUB",
	"type": "INDEX_PRICE_ALL"
}

{
	"type": "INDEX_PRICE_ALL",
	"data": [{
		"symbol": "BTC/USDT",
		"price": "20547.103000000"
	}, {
		"symbol": "ETH/USDT",
		"price": "1095.646000000"
	}],
	"ts": 1655971790464
}

{
	"code": 1,
	"desc": "success",
	"topic": {
		"event": "SUB",
		"type": "INDEX_PRICE_ALL",
		"symbols": "BTC/USDT,ETH/USDT"
	}
}

深度 Edit

{
	"event": "SUB",
	"type": "DEPTH",
	"symbol": "BTC/USDT"
}

{
	"event": "UNSUB",
	"type": "DEPTH",
	"symbol": "BTC/USDT"
}

{
	"symbol": "BTC/USDT",
	"type": "DEPTH",
	"data": {
		"asks": [//asks （升序）賣 下標0價格，1數量
			["40592", "1.33301"],
			["40593", "1.02589"],
			["40594", "0.17704"],
			["40595", "0.1593"],
			["40596", "1.15614"]
		],
		"bids": [//bids （降序）買
			["40497", "0.62148"],
			["40498", "0.47407"],
			["40499", "1.05067"],
			["40500", "0.26455"],
			["40501", "0.78471"],
			["40502", "0.44409"],
		]
	},
	"ts": 1650352632920
}

{
	"code": 1,
	"desc": "success",
	"topic": {
		"event": "SUB",
		"type": "DEPTH",
		"symbol": "BTC/USDT"
	}
}

24小時行情 Edit

{
	"event": "SUB",
	"type": "TICKER",
	"symbol": "BTC/USDT"
}

{
	"event": "UNSUB",
	"type": "MARKET",
	"symbol": "BTC/USDT"
}

{
	"symbol": "BTC/USDT",
	"type": "TICKER",
	"data": {
		"amount": "12041429.0669052",//成交量
		"change": "3.62",//漲跌幅
		"high": "41258.86",//高
		"last": "40680.6",//最新價
		"low": "38538.02",//低
		"open": "38821.7",//開盤價
		"time": "1650347625464",
		"volume": "301.7915"//成交數
	},
	"ts": 1650347625841
}

{
	"code": 1,
	"desc": "success",
	"topic": {
		"event": "SUB",
		"type": "TICKER",
		"symbol": "BTC/USDT"
	}
}

K線 Edit

periods:k线类型

"1min":0

"5min": 2

"15min":3

"30min":4

"1hour":5

"4hour":7

"1day":10

"1week":11

"1month":12

"1year":13

多个k线类型逗号分隔

{
	"event": "SUB",
	"type": "KLINE",
	"symbol": "BTC/USDT",
	"params": {
		"periods": "0,2"
	}
}

{
	"event": "UNSUB",
	"type": "KLINE",
	"symbol": "BTC/USDT"
}

{
	"symbol": "BTC/USDT",
	"type": "KLINE",
	"data": [{
		"open": "40716.4",
		"high": "40716.6",
		"low": "40702.8",
		"close": "40702.8",
		"volume": "0.00735",
		"amount": "299.24742",
		"type": 0,
		"time": 1650352200000
	}],
	"ts": 1650352218714
}

{
	"code": 1,
	"desc": "success",
	"topic": {
		"event": "SUB",
		"type": "KLINE",
		"params": {
			"periods": "0,2"
		},
		"symbol": "BTC/USDT"
	}
}

實時成交 Edit

{
	"event": "SUB",
	"type": "TRADE",
	"symbol": "BTC/USDT"
}

{
	"event": "UNSUB",
	"type": "TRADE",
	"symbol": "BTC/USDT"
}

{
	"symbol": "BTC/USDT",
	"type": "TRADE",
	"data": [{
		"size": "0.0003",//數量
		"price": "40711.4",//價格
		"side": 1,//方向 1:買 2：賣
		"time": 1650352384250
	}],
	"ts": 1650352384312
}

{
	"code": 1,
	"desc": "success",
	"topic": {
		"event": "SUB",
		"type": "TRADE",
		"symbol": "BTC/USDT"
	}
}

充值地址查詢 Edit

URL：/spot/v1/capital/deposit/address
Method：GET
需要鑒權：是

請求參數

參數名稱	類型	是否必需	描述
coin	String	YES	幣種
chain	String	NO	鏈名稱
signature	String	YES	簽名
timestamp	Long	YES	調用時間

{
    "coin": "USDT",
    "timestamp": 1656913877424,
    "recvWindow": 5000
}

{
    "code": 1,
    "data": [
        {
            "coin": "USDT",
            "chain": "BEP20",
            "address": "0x01feea3cbb1c12ff0357751b134e574x8d1b4x85",
            "addressTag": ""
        },
        {
            "coin": "USDT",
            "chain": "TRC20",
            "address": "T9yT4UUY3m2s182XwRwVYHckrR5Acxs6Fb",
            "addressTag": ""
        }
    ]
}

{
    "code": 9202,
    "message": "币种不能为空"
}

充值記錄 Edit

URL：/spot/v1/capital/deposit/history
Method：GET
需要鑒權：是

請求參數

參數名稱	類型	是否必需	描述
coin	String	YES	幣種
startTime	Long	NO	開始時間
endTime	Long	NO	結束時間
fromId	Long	NO	查詢起始ID
limit	Integer	NO	查詢記錄大小
signature	String	YES	簽名
timestamp	Long	YES	調用時間

{
    "coin": "USDT",
    "timestamp": 1656913877424,
    "recvWindow": 5000
}

{
    "code": 1,
    "data": [
        {
            "id": 1100828149039493,
            "coin": "USDT",
            "amount": "100",
            "address": "18600531753",
            "addressTag": "",
            "txId": "1100828109930501",
            "createTime": 1657188020000
        }
    ]
}

{
    "code": 9202,
    "message": "币种不能为空"
}

提幣記錄 Edit

URL：/spot/v1/capital/withdraw/history
Method：GET
需要鑒權：是

請求參數

參數名稱	類型	是否必需	描述
coin	String	YES	幣種
startTime	Long	NO	開始時間
endTime	Long	NO	結束時間
fromId	Long	NO	查詢起始ID
limit	Integer	NO	查詢記錄大小
signature	String	YES	簽名
timestamp	Long	YES	調用時間

提幣狀態

0 : 審核中
1 : 審核完成
2 : 提幣成功
3 : 審核失敗
4 : 提幣失敗
5 : 提幣取消
6 : 鏈上處理中
7 : 鏈上處理完成
8 : 鏈上處理失敗

{
    "coin": "USDT",
    "timestamp": 1656913877424,
    "recvWindow": 5000
}

{
    "code": 1,
    "data": [
        {
            "id": 1189938193498373,
            "coin": "USDT",
            "amount": "10",
            "address": "TA778a8koXvHPHmhM1rjwUd1rECFdT3LXX",
            "addressTag": "",
            "txId": "1234556",
            "createTime": 1654764465575,
            "status": 2
        },
        {
            "id": 1189935202320645,
            "coin": "USDT",
            "amount": "6",
            "address": "TA778a8koXvHPHmhM1rjwUd1rECFdT3LXX",
            "addressTag": "",
            "createTime": 1654764283009,
            "status": 4
        },
        {
            "id": 1189931341644037,
            "coin": "USDT",
            "amount": "5",
            "address": "TA778a8koXvHPHmhM1rjwUd1rECFdT3LXX",
            "addressTag": "",
            "createTime": 1654764047370,
            "status": 5
        }
    ]
}

{
    "code": 9201,
    "message": "时间间隔不能超过90天"
}

错误码 Edit

error code	message
287	RPC error
9001	业务类型无效
9002	交易对无效
9003	买卖方向无效
9004	持仓方向无效
9005	订单类型无效
9006	价格无效
9007	数量无效
9201	时间间隔不能超过90天
9202	币种不能为空
9984	请求时间戳验证失败
9985	apiKey无效
9986	操作频繁
9987	结束时间不能大于开始时间
9988	验签失败
9998	参数错误:{0}
9990	来源ip地址不在信任列表
9999	异常信息
10001	不存在的事件類型
10000	請求json格式錯誤
10024	无效token，请重新登录