Books

接收訂閱期權商品最新最佳五檔委買委賣資訊

Parameters

Name	Type	Description
channel*	string	訂閱頻道：trades, books, aggregates, candles
symbol*	string	契約代碼
afterHours	boolean	訂閱夜盤行情 true : 夜盤行情 false : 日盤行情 default : false

Response

Name	Type	Description
symbol*	string	期權代碼
type*	string	Ticker 類型
exchange*	string	交易所
time*	number	時間
bids	object[]	最佳五檔委買
>> price	number	最佳五檔委買價格
>> size	number	最佳五檔委買數量
asks	object[]	最佳五檔委賣
>> price	number	最佳五檔委賣價格
>> size	number	最佳五檔委賣數量
derivedBid	object	衍生最佳一檔委買（延伸一檔；無衍生檔位時 price／size 為 0）
>> price	number	衍生委買價格
>> size	number	衍生委買數量
derivedAsk	object	衍生最佳一檔委賣（延伸一檔；無衍生檔位時 price／size 為 0）
>> price	number	衍生委賣價格
>> size	number	衍生委賣數量
isTrial	boolean	試撮階段為 true（僅試撮階段出現）

info

'*' 表示必揭示欄位。

衍生一檔與試撮欄位

• derivedBid／derivedAsk（延伸一檔）主要出現於價差合約之衍生報價，一般期貨通常為 price=0／size=0。
• isTrial 於商品處於試撮階段時可能為 true，包含開盤前試撮與盤中緩撮／試撮；正常連續撮合時，欄位可能為 false 或不出現。isTrial: true 時 bids／asks 為試撮後的剩餘委託簿，不是正式盤中委託簿。
• 此頻道的試撮訊息僅 v1.1 連線推送，aggregates 頻道在 v1.0 也會推送試撮期間的更新；連線版本設定見 開始使用。
• 上述期權進階行情欄位 v2.2.9 起提供。

Example

Subscribe channel

Python

from fubon_neo.sdk import FubonSDK, Order

def handle_message(message):
    print(f'market data message: {message}')

sdk = FubonSDK()
accounts = sdk.login("Your ID", "Your password", "Your cert path", "Your cert password")  # 需登入後，才能取得行情權限

sdk.init_realtime() # 建立行情連線

futopt = sdk.marketdata.websocket_client.futopt
futopt.on('message', handle_message)
futopt.connect()
futopt.subscribe({ 
    'channel': 'books', 
    'symbol': 'TXFA4'
    #'afterHours' : True   # 夜盤行情
})

Node.js

const { FubonSDK } = require('fubon-neo');

const sdk = new FubonSDK();

const accounts = sdk.login("Your ID", "Your password", "Your cert path", "Your cert password");

sdk.initRealtime(); // 建立行情連線

const futopt = sdk.marketdata.webSocketClient.futopt;

futopt.connect().then(() => {
  futopt.subscribe({ 
                     channel: "books", 
                     symbol: "TXFA4" 
                     // afterHours: true    //夜盤行情 
                   });
});

futopt.on("message", (message) => {
  const data = JSON.parse(message);
  console.log(data);
});

C#

using FubonNeo.Sdk;

var sdk = new FubonSDK();

var result = sdk.Login("Your ID", "Your password", "Your cert path", "Your cert password");

sdk.InitRealtime();  // 建立行情連線

var futopt = sdk.MarketData.WebSocketClient.FutureOption;

futopt.OnMessage += (msg) => Console.WriteLine($"receive: { msg }");

await futopt.Connect();

await futopt.Subscribe(FugleMarketData.WebsocketModels.FutureOptionChannel.Books, "TXFA4");

// await futopt.Subscribe(FugleMarketData.WebsocketModels.FutureOptionChannel.Books,  new FutureOptionParams { Symbol = "TXFC4", AfterHours = true });  // 夜盤行情

訂閱多檔商品

同時訂閱多檔商品方式，請參考 訂閱頻道

Receive data

{
    "event": "data",
    "data": {
        "symbol": "TXFA4",
        "type": "FUTURE",
        "exchange": "TAIFEX",
        "bids": [
          {
            "price": 17539,
            "size": 2
          }, 
          {
            "price": 17538,
            "size": 4
          }, 
          {
            "price": 17537,
            "size": 3
          }, 
          {
            "price": 17536,
            "size": 10
          }, 
          {
            "price": 17535,
            "size": 10
          }
        ],
        "asks": [
          {
            "price": 17541,
            "size": 2
          }, 
          {
            "price": 17542,
            "size": 15
          }, 
          {
            "price": 17543,
            "size": 3
          }, 
          {
            "price": 17544,
            "size": 5
          }, 
          {
            "price": 17545,
            "size": 4
          }
        ],
        "derivedBid": {
          "price": 17540,
          "size": 1
        },
        "derivedAsk": {
          "price": 0,
          "size": 0
        },
        "time": 1702956500113000
    },
    "id": "<CHANNEL_ID>",
    "channel": "books"
}