跳至主要内容

修改委託單

普通帳戶覆蓋範圍: 現貨 / USDT永續 / 反向合約

important

您只能修改那些未成交或者部分成交的訂單。

HTTP請求

POST /cloud/trade/v3/order/amend

請求參數

參數是否必需類型說明
categorytruestring產品類型
  • 普通帳戶: spot, linear, inverse. 這裡category字段不參與業務邏輯,僅做路由使用
symboltruestring合約名稱
orderIdfalsestring訂單Id. orderIdorderLinkId必傳其中一個
orderLinkIdfalsestring用戶自定義訂單Id. orderIdorderLinkId必傳其中一個
orderIvfalsestring隱含波動率.
triggerPricefalsestring
  • 觸發價格. 若希望市場趨勢是上漲至觸發條件單, 則確保:
    觸發價格 > 市場價格
    否則,觸發價格 < 市場價格
  • 對於現貨, 這是下止盈止損單的觸發價格參數
qtyfalsestring修改後的訂單數量. 若不修改,請不要傳該字段
pricefalsestring修改後的訂單價格. 若不修改,請不要傳該字段
tpslModefalsestring止盈止損模式
  • Full: 全部倉位止盈止損. 此時, tpOrderType或者slOrderType必須傳Market
  • Partial: 部分倉位止盈止損. 支持創建限價止盈止損. 注意: 創建限價止盈止損時, tpslMode必傳且為Partial
僅對linearinverse有效
takeProfitfalsestring修改後的止盈價格. 當傳"0"時, 表示取消當前訂單上設置的止盈. 若不修改,請不要傳該字段
stopLossfalsestring修改後的止損價格. 當傳"0"時, 表示取消當前訂單上設置的止損. 若不修改,請不要傳該字段
tpTriggerByfalsestring止盈價格觸發類型. 若下單時未設置該值,則調用該接口修改止盈價格時,該字段必傳
slTriggerByfalsestring止損價格觸發類型. 若下單時未設置該值,則調用該接口修改止損價格時,該字段必傳
triggerByfalsestring觸發價格的觸發類型
僅對linear和inverse有效
tpLimitPricefalsestring*觸發止盈後轉換為限價單的價格. 當且僅當原始訂單下單時創建的是部分止盈止損限價單, 本字段才有效
slLimitPricefalsestring*觸發止損後轉換為限價單的價格. 當且僅當原始訂單下單時創建的是部分止盈止損限價單, 本字段才有效

響應參數

參數類型說明
orderIdstring訂單Id
orderLinkIdstring用戶自定義訂單Id

請求示例

POST /cloud/trade/v3/order/amend HTTP/1.1
Host: openapi-testnet.zoomex.com
X-BAPI-SIGN: XXXXX
X-BAPI-API-KEY: XXXXX
X-BAPI-TIMESTAMP: 1672217108106
X-BAPI-RECV-WINDOW: 5000
Content-Type: application/json

{
"category": "linear",
"symbol": "ETHUSDT",
"orderLinkId": "linear-004",
"triggerPrice": "1145",
"qty": "0.15",
"price": "1050",
"takeProfit": "0",
"stopLoss": "0"
}

響應示例

{
"retCode": 0,
"retMsg": "OK",
"result": {
"orderId": "c6f055d9-7f21-4079-913d-e6523a9cfffa",
"orderLinkId": "linear-004"
},
"retExtInfo": {},
"time": 1672217093461
}