交易推播

客戶端可以透過交易長連接網關取得到交易和資產的變更通知。

範例

from time import sleep
from decimal import Decimal
from longbridge.openapi import TradeContext, Config, OrderSide, OrderType, TimeInForceType, PushOrderChanged, TopicType, OAuthBuilder

def on_order_changed(event: PushOrderChanged):
print(event)

oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url))
config = Config.from_oauth(oauth)
ctx = TradeContext(config)
ctx.set_on_order_changed(on_order_changed)
ctx.subscribe([TopicType.Private])

resp = ctx.submit_order(
side=OrderSide.Buy,
symbol="700.HK",
order_type=OrderType.LO,
submitted_price=Decimal(50),
submitted_quantity=Decimal(200),
time_in_force=TimeInForceType.Day,
remark="Hello from Python SDK",
)
print(resp)
sleep(5) # waiting for push event

# Finally, unsubscribe

ctx.unsubscribe([TopicType.Private])

訂閱

我們可以透過subscribe 方法訂閱交易推送，訂閱成功後，服務端會將對應的推播訊息推播給客戶端，SDK 的set_on_order_changed 可以設定推播訊息的回呼函數，當收到交易推播訊息時，會 呼叫該回調函數。

Protobuf definition:

// Sub is Sub command content, command is 16
message Sub {
  repeated string topics = 1;
}

// SubResponse is response of Sub Request
message SubResponse {
  message Fail {
    string topic = 1;
    string reason = 2;
  }
  repeated string success = 1; // success topics
  repeated Fail fail = 2; // failed topics
  repeated string current = 3;  // curent subscriptions after subscribe
}

目前支援的 topic：

• private - 交易和資產類的私有通知

取消訂閱

取消訂閱用於取消訂閱訊息，如前面 subscribe 訂閱成功後，可以透過 unsubscribe 函數來取消訂閱。

Protobuf 定義如下：

// Unsub is Unsub command content, command is 17
message Unsub {
   repeated string topics = 1;
}

// UnsubResponse is response of Unsub request
message UnsubResponse {
   repeated string current = 3; // 目前訂閱
}

註冊通知推播

我們可以透過 set_on_order_changed 方法（Go 裡面為 OnTrade）設定推播訊息的回呼函數，當收到交易推播訊息時，會呼叫該回呼函數。

Protobuf 定義如下：

// Dispatch type
enum DispatchType {
  DISPATCH_UNDEFINED = 0;
  DISPATCH_DIRECT = 1;
  DISPATCH_BROADCAST = 2;
}

enum ContentType {
  CONTENT_UNDEFINED = 0;
  CONTENT_JSON = 1;
  CONTENT_PROTO = 2;
}

// Notification is push message, command is 18
message Notification {
  string topic = 1;
  ContentType content_type = 2;
  DispatchType dispatch_type = 3;
  bytes data = 4;
}

網格訂單推送

網格主訂單的變更與普通訂單變更走同一個 private 主題。訂閱 private 主題後，當網格主訂單發生變更（建立、掛起、重啟、觸發、撤銷等）時，交易網關會推送 gridtrading_order 事件。設置網格訂單變更回調即可接收。

事件包含以下欄位：