查詢實時和終態委託單

主要用於實時查詢未成交或部分成交的訂單信息, 但結合入参openOnly能夠查詢到最近500條到達終態的訂單. 若需要查詢更久的訂單紀錄，請使用查詢歷史訂單接口.

提示

支持查詢已成交, 取消和拒絕類型的最近500條訂單信息對於spot, linear, inverse和option類別.
您可以通過指定symbol, baseCoin, orderId 和 orderLinkId字段來查詢. 如果您使用多字段組合，系統的查詢優先級如下: orderId > orderLinkId > symbol > baseCoin.
返回的結果將以createdTime從新到舊排序.

信息

服務器重啓或發佈後請使用查詢歷史訂單接口去查詢已成交，取消和拒絕類型的訂單信息
在極端市場波動期間, 此介面可能會出現延遲增加或資料傳遞暫時延遲的情況

HTTP請求

GET /v5/order/realtime

請求參數

參數	是否必需	類型	說明
category	true	string	產品類型 `spot`, `linear`, `inverse`, `option`
symbol	false	string	合約名稱當category=linear, `symbol`, `baseCoin` 和 `settleCoin`必傳其中一個
baseCoin	false	string	交易幣種支持`linear`, `inverse`和`option` 對於category=option, 若不傳baseCoin, 則返回期權下所有活動委託單
settleCoin	false	string	結算幣種 linear: `symbol` 和 `settleCoin`必傳其中一個 `spot`: 該字段無效 `option`: USDT 或 USDC
orderId	false	string	訂單Id
orderLinkId	false	string	用戶自定義訂單Id
openOnly	false	integer	`0`(默認): 僅查詢活動委託訂單, 比如New, PartiallyFilled訂單 `1`: 返回僅終態（已取消/拒絕/完全成交）的訂單數據, 每個帳戶每個category下最多保留500條紀錄. 如果因Bybit服務更新重啟則該部分數據會情況並重新累計, 但是訂單紀錄仍然可以從歷史訂單中查詢到當查詢是按照orderId 或者 orderLinkId時, `openOnly`入参將會被忽略
orderFilter	false	string	`Order`: 活動單 `StopOrder`: 條件單, 支持現貨和期貨 `tpslOrder`: 止盈止損單, 僅現貨有效 `OcoOrder`: OCO訂單 `BidirectionalTpslOrder`: 現貨雙向止盈止損訂單默認返回全部類型訂單
limit	false	integer	每頁數量限制. [`1`, `50`]. 默認: `20`
cursor	false	string	游標，用於翻頁

響應參數

參數	類型	說明
category	string	產品類型
nextPageCursor	string	游標，用於翻頁
list	array	Object
> orderId	string	訂單Id
> orderLinkId	string	用戶自定義Id
> parentOrderLinkId	string	表示關聯到的母訂單, 用於關聯附帶的止盈(Take Profit)與止損(Stop Loss)訂單. 支援期貨與期權. 對止盈或止損訂單進行修改不會改變parentOrderLinkId 期貨: 使用設置止盈止損修改從原始訂單更新附帶的TP/SL, 不會改變 parentOrderLinkId 期權: 使用設置止盈止損修改從原始訂單更新附帶的TP/SL, 會改變 parentOrderLinkId 期貨與期權: 若對原本沒有附帶 TP/SL 的倉位，透過設置止盈止損設定 TP/SL, 則parentOrderLinkId沒有實際意義
> blockTradeId	string	Paradigm大宗交易Id
> symbol	string	合約名稱
> price	string	訂單價格
> qty	string	訂單數量
> side	string	方向. `Buy`,`Sell`
> isLeverage	string	是否借貸. 僅`spot`有效 `0`: 否 `1`: 是
> positionIdx	integer	倉位標識。用戶不同倉位模式
> orderStatus	string	訂單狀態
> createType	string	訂單創建類型現貨不返回該字段
> cancelType	string	訂單被取消類型
> rejectReason	string	拒絕原因
> avgPrice	string	訂單平均成交價格不存在avg price場景的訂單將會返回`""`
> leavesQty	string	訂單剩餘未成交的數量
> leavesValue	string	訂單剩餘未成交的價值
> cumExecQty	string	訂單累計成交數量
> cumExecValue	string	訂單累計成交價值
> cumExecFee	string	`inverse`, `option`: 訂單累計成交的手續費. `linear`, `spot`: 已棄用. 用`cumFeeDetail`替代.
> timeInForce	string	執行策略
> orderType	string	訂單類型. `Market`,`Limit`. 對於止盈止損單, 則表示為觸發後的訂單類型
> stopOrderType	string	條件單類型
> orderIv	string	隱含波動率
> marketUnit	string	現貨交易時給入參`qty`選擇的單位. `baseCoin`, `quoteCoin`
> triggerPrice	string	觸發價格. 若`stopOrderType`=TrailingStop, 則這是激活價格. 否則, 它是觸發價格
> takeProfit	string	止盈價格
> stopLoss	string	止損價格
> tpslMode	string	止盈止損模式 `Full`: 全部倉位止盈止損, `Partial`: 部分倉位止盈止損現貨不返回該字段, 期權總是返回""
> ocoTriggerBy	string	現貨OCO訂單的觸發類型.`OcoTriggerByUnknown`, `OcoTriggerByTp`, `OcoTriggerBySl`
> tpLimitPrice	string	觸發止盈後轉換為限價單的價格
> slLimitPrice	string	觸發止損後轉換為限價單的價格
> tpTriggerBy	string	觸發止盈的價格類型
> slTriggerBy	string	觸發止損的價格類型
> triggerDirection	integer	觸發方向. `1`: 上漲, `2`: 下跌
> triggerBy	string	觸發價格的觸發類型
> lastPriceOnCreated	string	下單時的市場價格, 現貨不適用
> basePrice	string	下單時的市場價格, 僅現貨有這個字段
> reduceOnly	boolean	只減倉. `true`表明這是只減倉單
> closeOnTrigger	boolean	觸發後平倉委託. 什麼是觸發後平倉委託?
> placeType	string	下單類型, 僅期權使用. `iv`, `price`
> smpType	string	SMP執行類型
> smpGroup	integer	所屬Smp組ID. 如果uid不屬於任何組, 則默認為`0`
> smpOrderId	string	觸發此SMP執行的交易對手的 orderID
> createdTime	string	創建訂單的時間戳 (毫秒)
> updatedTime	string	訂單更新的時間戳 (毫秒)
> cumFeeDetail	json	`linear`, `spot`: 累積交易費詳情, 替代`cumExecFee`

請求示例

HTTP
Python
Java
Node.js

GET /v5/order/realtime?symbol=ETHUSDT&category=linear&openOnly=0&limit=1  HTTP/1.1
Host: api-testnet.bybit.com
X-BAPI-SIGN: XXXXX
X-BAPI-API-KEY: xxxxxxxxxxxxxxxxxx
X-BAPI-TIMESTAMP: 1672219525810
X-BAPI-RECV-WINDOW: 5000
Content-Type: application/json

from pybit.unified_trading import HTTP
session = HTTP(
    testnet=True,
    api_key="xxxxxxxxxxxxxxxxxx",
    api_secret="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
)
print(session.get_open_orders(
    category="linear",
    symbol="ETHUSDT",
    openOnly=0,
    limit=1,
))

import com.bybit.api.client.config.BybitApiConfig;
import com.bybit.api.client.domain.trade.request.TradeOrderRequest;
import com.bybit.api.client.domain.*;
import com.bybit.api.client.domain.trade.*;
import com.bybit.api.client.service.BybitApiClientFactory;
var client = BybitApiClientFactory.newInstance("YOUR_API_KEY", "YOUR_API_SECRET", BybitApiConfig.TESTNET_DOMAIN).newTradeRestClient();
var openLinearOrdersResult = client.getOpenOrders(openOrderRequest.category(CategoryType.LINEAR).openOnly(1).build());
System.out.println(openLinearOrdersResult);

const { RestClientV5 } = require('bybit-api');

const client = new RestClientV5({
    testnet: true,
    key: 'xxxxxxxxxxxxxxxxxx',
    secret: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
});

client
    .getActiveOrders({
        category: 'linear',
        symbol: 'ETHUSDT',
        openOnly: 0,
        limit: 1,
    })
    .then((response) => {
        console.log(response);
    })
    .catch((error) => {
        console.error(error);
    });

響應示例

{
    "retCode": 0,
    "retMsg": "OK",
    "result": {
        "list": [
            {
                "orderId": "fd4300ae-7847-404e-b947-b46980a4d140",
                "orderLinkId": "test-000005",
                "blockTradeId": "",
                "symbol": "ETHUSDT",
                "price": "1600.00",
                "qty": "0.10",
                "side": "Buy",
                "isLeverage": "",
                "positionIdx": 1,
                "orderStatus": "New",
                "cancelType": "UNKNOWN",
                "rejectReason": "EC_NoError",
                "avgPrice": "0",
                "leavesQty": "0.10",
                "leavesValue": "160",
                "cumExecQty": "0.00",
                "cumExecValue": "0",
                "cumExecFee": "0",
                "timeInForce": "GTC",
                "orderType": "Limit",
                "stopOrderType": "UNKNOWN",
                "orderIv": "",
                "triggerPrice": "0.00",
                "takeProfit": "2500.00",
                "stopLoss": "1500.00",
                "tpTriggerBy": "LastPrice",
                "slTriggerBy": "LastPrice",
                "triggerDirection": 0,
                "triggerBy": "UNKNOWN",
                "lastPriceOnCreated": "",
                "reduceOnly": false,
                "closeOnTrigger": false,
                "smpType": "None",
                "smpGroup": 0,
                "smpOrderId": "",
                "tpslMode": "Full",
                "tpLimitPrice": "",
                "slLimitPrice": "",
                "placeType": "",
                "createdTime": "1684738540559",
                "updatedTime": "1684738540561",
                "cumFeeDetail": {
                    "MNT": "0.00242968"
                }
            }
        ],
        "nextPageCursor": "page_args%3Dfd4300ae-7847-404e-b947-b46980a4d140%26symbol%3D6%26",
        "category": "linear"
    },
    "retExtInfo": {},
    "time": 1684765770483
}

HTTP請求​

請求參數​

響應參數​

請求示例​

響應示例​

HTTP請求

請求參數

響應參數

請求示例

響應示例