# 取消訂閲
- Python
- Proto
- C#
- Java
- C++
- JavaScript
# 訂閲
subscribe(code_list, subtype_list, is_first_push=True, subscribe_push=True, is_detailed_orderbook=False, extended_time=False, session=Session.NONE)
介紹
訂閲註冊需要的實時資訊，指定股票和訂閲的數據類型即可。
香港市場（含正股、窩輪、牛熊、期權、期貨）訂閲，需要 LV1 及以上的權限，BMP 權限下不支援訂閲。
美股市場（含正股、ETFs）夜盤行情訂閲，需要 LV1 及以上的權限，BMP 權限下不支援訂閲。參數
參數 類型 説明 code_list list 需要訂閲的股票代碼列表 list 中元素類型是 strsubtype_list list 需要訂閲的數據類型列表 list 中元素類型是 SubTypeis_first_push bool 訂閲成功之後是否立即推送一次快取數據 - True：推送快取
當腳本和 OpenD 之間出現斷線重連，重新訂閲時若設定為 True，會再次推送斷線前的最後一條數據 - False：不推送快取。等待伺服器的最新推送
subscribe_push bool 訂閲後是否推送 訂閲後，OpenD 提供了兩種取數據的方式，如果您僅使用 獲取實時數據 的方式，選擇 False 可以節省一部分效能消耗- True：推送。如果使用 實時數據回調 的方式，則必須設定為 True
- False：不推送。如果僅使用 獲取實時數據 的方式，則建議設定為 False
is_detailed_orderbook bool 是否訂閲詳細的擺盤訂單明細 - 僅用於港股 SF 行情權限下訂閲港股 ORDER_BOOK 類型
- 美股美期 LV2 權限下不提供詳細擺盤訂單明細
extended_time bool 是否允許美股盤前盤後數據 僅用於訂閲美股實時 K 線、實時分時、實時逐筆session Session 美股訂閲時段 - 僅用於訂閲美股實時 K 線、實時分時、實時逐筆
- 訂閲美股行情不支援入參OVERNIGHT
- 最低OpenD版本：9.2.4207
- True：推送快取
返回
參數 類型 説明 ret RET_CODE 介面呼叫結果 err_message NoneType 當 ret == RET_OK 時，返回 None str 當 ret != RET_OK 時，返回錯誤描述 Example
import time
from futu import *
class OrderBookTest(OrderBookHandlerBase):
def on_recv_rsp(self, rsp_pb):
ret_code, data = super(OrderBookTest,self).on_recv_rsp(rsp_pb)
if ret_code != RET_OK:
print("OrderBookTest: error, msg: %s" % data)
return RET_ERROR, data
print("OrderBookTest ", data) # OrderBookTest 自己的處理邏輯
return RET_OK, data
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
handler = OrderBookTest()
quote_ctx.set_handler(handler) # 設定實時擺盤迴調
quote_ctx.subscribe(['US.AAPL'], [SubType.ORDER_BOOK]) # 訂閲買賣擺盤類型，OpenD 開始持續收到伺服器的推送
time.sleep(15) # 設定腳本接收 OpenD 的推送持續時間為15秒
quote_ctx.close() # 關閉當條連線，OpenD 會在1分鐘後自動取消相應股票相應類型的訂閲
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
- Output
OrderBookTest {'code': 'US.AAPL', 'name': '蘋果', 'svr_recv_time_bid': '2025-04-07 05:00:52.266', 'svr_recv_time_ask': '2025-04-07 05:00:53.973', 'Bid': [(180.2, 15, 3, {}), (180.19, 1, 1, {}), (180.18, 11, 2, {}), (180.14, 200, 1, {}), (180.13, 3, 2, {}), (180.1, 99, 3, {}), (180.05, 3, 1, {}), (180.03, 400, 1, {}), (180.02, 10, 1, {}), (180.01, 100, 1, {}), (180.0, 441, 24, {})], 'Ask': [(180.3, 100, 1, {}), (180.38, 4, 2, {}), (180.4, 100, 1, {}), (180.42, 200, 1, {}), (180.46, 29, 1, {}), (180.5, 1019, 2, {}), (180.6, 1000, 1, {}), (180.8, 2001, 3, {}), (180.84, 15, 2, {}), (181.0, 2036, 4, {}), (181.2, 2000, 2, {}), (181.3, 3, 1, {}), (181.4, 2021, 3, {}), (181.5, 59, 2, {}), (181.79, 9, 1, {}), (181.8, 20, 1, {}), (181.9, 94, 4, {}), (181.98, 20, 1, {}), (182.0, 150, 7, {})]}
1
2
2
# 取消訂閲
unsubscribe(code_list, subtype_list, unsubscribe_all=False)
介紹
取消訂閲
參數
參數 類型 説明 code_list list 取消訂閲的股票代碼列表 list 中元素類型是 strsubtype_list list 需要訂閲的數據類型列表 list 中元素類型是 SubTypeunsubscribe_all bool 取消所有訂閲 為 True 時忽略其他參數
Return
參數 類型 説明 ret RET_CODE 介面呼叫結果 err_message NoneType 當 ret == RET_OK, 返回 None str 當 ret != RET_OK, 返回錯誤描述 Example
from futu import *
import time
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
print('current subscription status :', quote_ctx.query_subscription()) # 查詢初始訂閲狀態
ret_sub, err_message = quote_ctx.subscribe(['US.AAPL'], [SubType.QUOTE, SubType.TICKER], subscribe_push=False, session=Session.ALL)
# 先訂閲了AAPL全時段 QUOTE 和 TICKER 兩個類型。訂閲成功後 OpenD 將持續收到伺服器的推送，False 代表暫時不需要推送給腳本
if ret_sub == RET_OK: # 訂閲成功
print('subscribe successfully！current subscription status :', quote_ctx.query_subscription()) # 訂閲成功後查詢訂閲狀態
time.sleep(60) # 訂閲之後至少1分鐘才能取消訂閲
ret_unsub, err_message_unsub = quote_ctx.unsubscribe(['US.AAPL'], [SubType.QUOTE])
if ret_unsub == RET_OK:
print('unsubscribe successfully！current subscription status:', quote_ctx.query_subscription()) # 取消訂閲後查詢訂閲狀態
else:
print('unsubscription failed！', err_message_unsub)
else:
print('subscription failed', err_message)
quote_ctx.close() # 結束後記得關閉當條連線，防止連線條數用盡
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
- Output
current subscription status : (0, {'total_used': 0, 'remain': 1000, 'own_used': 0, 'sub_list': {}})
subscribe successfully！current subscription status : (0, {'total_used': 2, 'remain': 998, 'own_used': 2, 'sub_list': {'QUOTE': ['US.AAPL'], 'TICKER': ['US.AAPL']}})
unsubscribe successfully！current subscription status: (0, {'total_used': 1, 'remain': 999, 'own_used': 1, 'sub_list': {'TICKER': ['US.AAPL']}})
1
2
3
2
3
# 取消所有訂閲
unsubscribe_all()
- 介紹
取消所有訂閲
返回
參數 類型 説明 ret RET_CODE 介面呼叫結果 err_message NoneType 當 ret == RET_OK, 返回 None str 當 ret != RET_OK, 返回錯誤描述 Example
from futu import *
import time
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
print('current subscription status :', quote_ctx.query_subscription()) # 查詢初始訂閲狀態
ret_sub, err_message = quote_ctx.subscribe(['US.AAPL'], [SubType.QUOTE, SubType.TICKER], subscribe_push=False, session=Session.None)
# 先訂閲了AAPL全時段 QUOTE 和 TICKER 兩個類型。訂閲成功後 OpenD 將持續收到伺服器的推送，False 代表暫時不需要推送給腳本
if ret_sub == RET_OK: # 訂閲成功
print('subscribe successfully！current subscription status :', quote_ctx.query_subscription()) # 訂閲成功後查詢訂閲狀態
time.sleep(60) # 訂閲之後至少1分鐘才能取消訂閲
ret_unsub, err_message_unsub = quote_ctx.unsubscribe_all() # 取消所有訂閲
if ret_unsub == RET_OK:
print('unsubscribe all successfully！current subscription status:', quote_ctx.query_subscription()) # 取消訂閲後查詢訂閲狀態
else:
print('Failed to cancel all subscriptions！', err_message_unsub)
else:
print('subscription failed', err_message)
quote_ctx.close() # 結束後記得關閉當條連線，防止連線條數用盡
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
- Output
current subscription status : (0, {'total_used': 0, 'remain': 1000, 'own_used': 0, 'sub_list': {}})
subscribe successfully！current subscription status : (0, {'total_used': 2, 'remain': 998, 'own_used': 2, 'sub_list': {'QUOTE': ['US.AAPL'], 'TICKER': ['US.AAPL']}})
unsubscribe all successfully！current subscription status: (0, {'total_used': 0, 'remain': 1000, 'own_used': 0, 'sub_list': {}})
1
2
3
2
3
# Qot_Sub.proto
介紹
訂閲註冊需要的實時資訊，指定股票和訂閲的數據類型即可。
香港市場（含正股、窩輪、牛熊、期權、期貨）訂閲，需要 LV1 及以上的權限，BMP 權限下不支援訂閲。
美股市場（含正股、ETFs）夜盤行情訂閲，需要 LV1 及以上的權限，BMP 權限下不支援訂閲。參數
message C2S
{
repeated Qot_Common.Security securityList = 1; //股票陣列
repeated int32 subTypeList = 2; //Qot_Common.SubType，訂閲數據類型陣列
required bool isSubOrUnSub = 3; //true 表示訂閲，false 表示反訂閲
optional bool isRegOrUnRegPush = 4; //是否註冊或反註冊該連線上面行情的推送，該參數不指定不做註冊反註冊操作
repeated int32 regPushRehabTypeList = 5; //Qot_Common.RehabType，復權類型，註冊推送並且是 K 線類型才生效，其他訂閲類型忽略該參數，註冊 K 線推送時該參數不指定預設前復權
optional bool isFirstPush = 6; //註冊後如果本地已有數據是否首推一次已存在數據，該參數不指定則預設 true
optional bool isUnsubAll = 7; //一鍵取消當前連線的所有訂閲，當被設定為 True 時忽略其他參數。
optional bool isSubOrderBookDetail = 8; //訂閲擺盤可用，是否訂閲擺盤明細，僅支援 SF 行情，該參數不指定則預設 false
optional bool extendedTime = 9; // 是否允許美股盤前盤後數據（僅用於訂閲美股的實時 K 線、實時分時、實時逐筆）
optional int32 session = 10; // 是否允許美股盤前盤後以及夜盤數據（僅用於訂閲美股的實時 K 線、實時分時、實時逐筆）,該參數指定後忽略 extendedTime
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
- 返回
message S2C
{
}
message Response
{
required int32 retType = 1 [default = -400]; //RetType,返回結果
optional string retMsg = 2;
optional int32 errCode = 3;
optional S2C s2c = 4;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
- 介面呼叫結果，結構參見 RetType
協議 ID
3001
# Sub
uint Sub(QotSub.Request req);
virtual void OnReply_Sub(FTAPI_Conn client, uint nSerialNo, QotSub.Response rsp);
- 介紹
訂閲註冊需要的實時資訊，指定股票和訂閲的數據類型即可。
香港市場（含正股、窩輪、牛熊、期權、期貨）訂閲，需要 LV1 及以上的權限，BMP 權限下不支援訂閲。
美股市場（含正股、ETFs）夜盤行情訂閲，需要 LV1 及以上的權限，BMP 權限下不支援訂閲。
- 參數
message C2S
{
repeated Qot_Common.Security securityList = 1; //股票陣列
repeated int32 subTypeList = 2; //Qot_Common.SubType，訂閲數據類型陣列
required bool isSubOrUnSub = 3; //true 表示訂閲，false 表示反訂閲
optional bool isRegOrUnRegPush = 4; //是否註冊或反註冊該連線上面行情的推送，該參數不指定不做註冊反註冊操作
repeated int32 regPushRehabTypeList = 5; //Qot_Common.RehabType，復權類型，註冊推送並且是 K 線類型才生效，其他訂閲類型忽略該參數，註冊 K 線推送時該參數不指定預設前復權
optional bool isFirstPush = 6; //註冊後如果本地已有數據是否首推一次已存在數據，該參數不指定則預設 true
optional bool isUnsubAll = 7; //一鍵取消當前連線的所有訂閲，當被設定為 True 時忽略其他參數。
optional bool isSubOrderBookDetail = 8; //訂閲擺盤可用，是否訂閲擺盤明細，僅支援 SF 行情，該參數不指定則預設 false
optional bool extendedTime = 9; // 是否允許美股盤前盤後數據（僅用於訂閲美股的實時 K 線、實時分時、實時逐筆）
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
- 返回
message S2C
{
}
message Response
{
required int32 retType = 1 [default = -400]; //RetType,返回結果
optional string retMsg = 2;
optional int32 errCode = 3;
optional S2C s2c = 4;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
- 介面呼叫結果，結構參見 RetType
- Example
public class Program : FTSPI_Qot, FTSPI_Conn {
FTAPI_Qot qot = new FTAPI_Qot();
public Program() {
qot.SetClientInfo("csharp", 1); //設定用戶端資訊
qot.SetConnCallback(this); //設定連線回調
qot.SetQotCallback(this); //設定交易回調
}
public void Start() {
qot.InitConnect("127.0.0.1", (ushort)11111, false);
}
public void OnInitConnect(FTAPI_Conn client, long errCode, String desc)
{
Console.Write("Qot onInitConnect: ret={0} desc={1} connID={2}\n", errCode, desc, client.GetConnectID());
if (errCode != 0)
return;
QotCommon.Security sec = QotCommon.Security.CreateBuilder()
.SetMarket((int)QotCommon.QotMarket.QotMarket_HK_Security)
.SetCode("00700")
.Build();
QotSub.C2S c2s = QotSub.C2S.CreateBuilder()
.AddSecurityList(sec)
.AddSubTypeList((int)QotCommon.SubType.SubType_Basic)
.SetIsSubOrUnSub(true)
.Build();
QotSub.Request req = QotSub.Request.CreateBuilder().SetC2S(c2s).Build();
uint seqNo = qot.Sub(req);
Console.Write("Send QotSub: {0}\n", seqNo);
}
public void OnDisconnect(FTAPI_Conn client, long errCode) {
Console.Write("Qot onDisConnect: {0}\n", errCode);
}
public void OnReply_Sub(FTAPI_Conn client, uint nSerialNo, QotSub.Response rsp) {
Console.Write("Reply: QotSub: {0} {1}\n", nSerialNo, rsp.ToString());
}
public static void Main(String[] args) {
FTAPI.Init();
Program qot = new Program();
qot.Start();
while (true)
Thread.Sleep(1000 * 600);
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
- Output
Qot onInitConnect: ret=0 desc= connID=6819171983431767818
Send QotSub: 3
Reply: QotSub: 3 retType: 0
retMsg: ""
errCode: 0
1
2
3
4
5
2
3
4
5
# sub
int sub(QotSub.Request req);
void onReply_Sub(FTAPI_Conn client, int nSerialNo, QotSub.Response rsp);
- 介紹
訂閲註冊需要的實時資訊，指定股票和訂閲的數據類型即可。
香港市場（含正股、窩輪、牛熊、期權、期貨）訂閲，需要 LV1 及以上的權限，BMP 權限下不支援訂閲。
美股市場（含正股、ETFs）夜盤行情訂閲，需要 LV1 及以上的權限，BMP 權限下不支援訂閲。
- 參數
message C2S
{
repeated Qot_Common.Security securityList = 1; //股票陣列
repeated int32 subTypeList = 2; //Qot_Common.SubType，訂閲數據類型陣列
required bool isSubOrUnSub = 3; //true 表示訂閲，false 表示反訂閲
optional bool isRegOrUnRegPush = 4; //是否註冊或反註冊該連線上面行情的推送，該參數不指定不做註冊反註冊操作
repeated int32 regPushRehabTypeList = 5; //Qot_Common.RehabType，復權類型，註冊推送並且是 K 線類型才生效，其他訂閲類型忽略該參數，註冊 K 線推送時該參數不指定預設前復權
optional bool isFirstPush = 6; //註冊後如果本地已有數據是否首推一次已存在數據，該參數不指定則預設 true
optional bool isUnsubAll = 7; //一鍵取消當前連線的所有訂閲，當被設定為 True 時忽略其他參數。
optional bool isSubOrderBookDetail = 8; //訂閲擺盤可用，是否訂閲擺盤明細，僅支援 SF 行情，該參數不指定則預設 false
optional bool extendedTime = 9; // 是否允許美股盤前盤後數據（僅用於訂閲美股的實時 K 線、實時分時、實時逐筆）
optional int32 session = 10; // 是否允許美股盤前盤後以及夜盤數據（僅用於訂閲美股的實時 K 線、實時分時、實時逐筆）,該參數指定後忽略 extendedTime
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
- 返回
message S2C
{
}
message Response
{
required int32 retType = 1 [default = -400]; //RetType,返回結果
optional string retMsg = 2;
optional int32 errCode = 3;
optional S2C s2c = 4;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
- 介面呼叫結果，結構參見 RetType
- Example
public class QotDemo implements FTSPI_Qot, FTSPI_Conn {
FTAPI_Conn_Qot qot = new FTAPI_Conn_Qot();
public QotDemo() {
qot.setClientInfo("javaclient", 1); //設定用戶端資訊
qot.setConnSpi(this); //設定連線回調
qot.setQotSpi(this); //設定交易回調
}
public void start() {
qot.initConnect("127.0.0.1", (short)11111, false);
}
@Override
public void onInitConnect(FTAPI_Conn client, long errCode, String desc)
{
System.out.printf("Qot onInitConnect: ret=%b desc=%s connID=%d\n", errCode, desc, client.getConnectID());
if (errCode != 0)
return;
QotCommon.Security sec = QotCommon.Security.newBuilder()
.setMarket(QotCommon.QotMarket.QotMarket_HK_Security_VALUE)
.setCode("00700")
.build();
QotSub.C2S c2s = QotSub.C2S.newBuilder()
.addSecurityList(sec)
.addSubTypeList(QotCommon.SubType.SubType_Basic_VALUE)
.setIsSubOrUnSub(true)
.build();
QotSub.Request req = QotSub.Request.newBuilder().setC2S(c2s).build();
int seqNo = qot.sub(req);
System.out.printf("Send QotSub: %d\n", seqNo);
}
@Override
public void onDisconnect(FTAPI_Conn client, long errCode) {
System.out.printf("Qot onDisConnect: %d\n", errCode);
}
@Override
public void onReply_Sub(FTAPI_Conn client, int nSerialNo, QotSub.Response rsp) {
if (rsp.getRetType() != 0) {
System.out.printf("QotSub failed: %s\n", rsp.getRetMsg());
}
else {
try {
String json = JsonFormat.printer().print(rsp);
System.out.printf("Receive QotSub: %s\n", json);
} catch (InvalidProtocolBufferException e) {
e.printStackTrace();
}
}
}
public static void main(String[] args) {
FTAPI.init();
QotDemo qot = new QotDemo();
qot.start();
while (true) {
try {
Thread.sleep(1000 * 600);
} catch (InterruptedException exc) {
}
}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
- Output
Send QotSub: 2
Receive QotSub: {
"retType": 0,
"retMsg": "",
"errCode": 0
}
1
2
3
4
5
6
2
3
4
5
6
# Sub
Futu::u32_t Sub(const Qot_Sub::Request &stReq);
virtual void OnReply_Sub(Futu::u32_t nSerialNo, const Qot_Sub::Response &stRsp) = 0;
介紹
訂閲註冊需要的實時資訊，指定股票和訂閲的數據類型即可。
香港市場（含正股、窩輪、牛熊、期權、期貨）訂閲，需要 LV1 及以上的權限，BMP 權限下不支援訂閲。
美股市場（含正股、ETFs）夜盤行情訂閲，需要 LV1 及以上的權限，BMP 權限下不支援訂閲。參數
message C2S
{
repeated Qot_Common.Security securityList = 1; //股票陣列
repeated int32 subTypeList = 2; //Qot_Common.SubType，訂閲數據類型陣列
required bool isSubOrUnSub = 3; //true 表示訂閲，false 表示反訂閲
optional bool isRegOrUnRegPush = 4; //是否註冊或反註冊該連線上面行情的推送，該參數不指定不做註冊反註冊操作
repeated int32 regPushRehabTypeList = 5; //Qot_Common.RehabType，復權類型，註冊推送並且是 K 線類型才生效，其他訂閲類型忽略該參數，註冊 K 線推送時該參數不指定預設前復權
optional bool isFirstPush = 6; //註冊後如果本地已有數據是否首推一次已存在數據，該參數不指定則預設 true
optional bool isUnsubAll = 7; //一鍵取消當前連線的所有訂閲，當被設定為 True 時忽略其他參數。
optional bool isSubOrderBookDetail = 8; //訂閲擺盤可用，是否訂閲擺盤明細，僅支援 SF 行情，該參數不指定則預設 false
optional bool extendedTime = 9; // 是否允許美股盤前盤後數據（僅用於訂閲美股的實時 K 線、實時分時、實時逐筆）
optional int32 session = 10; // 是否允許美股盤前盤後以及夜盤數據（僅用於訂閲美股的實時 K 線、實時分時、實時逐筆）,該參數指定後忽略 extendedTime
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
- 返回
message S2C
{
}
message Response
{
required int32 retType = 1 [default = -400]; //RetType,返回結果
optional string retMsg = 2;
optional int32 errCode = 3;
optional S2C s2c = 4;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
- 介面呼叫結果，結構參見 RetType
- Example
class Program : public FTSPI_Qot, public FTSPI_Trd, public FTSPI_Conn
{
public:
Program() {
m_pQotApi = FTAPI::CreateQotApi();
m_pQotApi->RegisterQotSpi(this);
m_pQotApi->RegisterConnSpi(this);
}
~Program() {
if (m_pQotApi != nullptr)
{
m_pQotApi->UnregisterQotSpi();
m_pQotApi->UnregisterConnSpi();
FTAPI::ReleaseQotApi(m_pQotApi);
m_pQotApi = nullptr;
}
}
void Start() {
m_pQotApi->InitConnect("127.0.0.1", 11111, false);
}
virtual void OnInitConnect(FTAPI_Conn* pConn, Futu::i64_t nErrCode, const char* strDesc) {
cout << "connect" << endl;
// 這個介面要先訂閲
Qot_Sub::Request req;
Qot_Sub::C2S *c2s = req.mutable_c2s();
auto secList = c2s->mutable_securitylist();
Qot_Common::Security *sec = secList->Add();
sec->set_code("00700");
sec->set_market(Qot_Common::QotMarket::QotMarket_HK_Security);
c2s->add_subtypelist(Qot_Common::SubType::SubType_Basic);
c2s->set_isregorunregpush(true);
c2s->set_issuborunsub(true);
m_SubSerialNo = m_pQotApi->Sub(req);
cout << "Request Sub SerialNo: " << m_SubSerialNo << endl;
}
virtual void OnReply_Sub(Futu::u32_t nSerialNo, const Qot_Sub::Response &stRsp)
{
if(nSerialNo == m_SubSerialNo)
{
cout << "OnReply_Sub SerialNo: " << nSerialNo << endl;
if(stRsp.rettype() != Common::RetType::RetType_Succeed)
{
cout << "Sub Failed" << endl;
return;
}
// 組包
Qot_GetBasicQot::Request req;
Qot_GetBasicQot::C2S *c2s = req.mutable_c2s();
auto secList = c2s->mutable_securitylist();
Qot_Common::Security *sec = secList->Add();
sec->set_code("00700");
sec->set_market(Qot_Common::QotMarket::QotMarket_HK_Security);
m_GetBasicQotSerialNo = m_pQotApi->GetBasicQot(req);
cout << "Request GetBasicQot SerialNo: " << m_GetBasicQotSerialNo << endl;
}
}
virtual void OnReply_GetBasicQot(Futu::u32_t nSerialNo, const Qot_GetBasicQot::Response &stRsp){
if(nSerialNo == m_GetBasicQotSerialNo)
{
cout << "OnReply_GetBasicQot SerialNo: " << nSerialNo << endl;
// 解析內部結構列印出來
// ProtoBufToBodyData和UTF8ToLocal函數的定義參見Sample中的tool.h檔案
string resp_str;
ProtoBufToBodyData(stRsp, resp_str);
cout << UTF8ToLocal(resp_str) << endl;
}
}
protected:
FTAPI_Qot *m_pQotApi;
Futu::u32_t m_SubSerialNo;
Futu::u32_t m_GetBasicQotSerialNo;
};
int32_t main(int32_t argc, char** argv)
{
FTAPI::Init();
{
Program program;
program.Start();
getchar();
}
protobuf::ShutdownProtobufLibrary();
FTAPI::UnInit();
return 0;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
- Output
connect
Request Sub SerialNo: 3
OnReply_Sub SerialNo: 3
Request GetBasicQot SerialNo: 4
OnReply_GetBasicQot SerialNo: 4
{
"retType": 0,
"retMsg": "",
"errCode": 0,
"s2c": {
"basicQotList": [
{
"security": {
"market": 1,
"code": "00700"
},
"isSuspended": false,
"listTime": "2004-06-16",
"priceSpread": 0.2,
"updateTime": "2021-09-14 16:08:30",
"highPrice": 482.8,
"openPrice": 476.4,
"lowPrice": 468.8,
"curPrice": 472.8,
"lastClosePrice": 478,
"volume": "19905281",
"turnover": 9452753751,
"turnoverRate": 0.207,
"amplitude": 2.929,
"darkStatus": 0,
"listTimestamp": 1087315200,
"updateTimestamp": 1631606910,
"secStatus": 1
}
]
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# Sub
Sub(req);
介紹
訂閲註冊需要的實時資訊，指定股票和訂閲的數據類型即可。
香港市場（含正股窩輪牛熊期權期貨）訂閲，需要 LV1 及以上的權限，BMP 權限下不支援訂閲。
美股市場（含正股、ETFs）夜盤行情訂閲，需要 LV1 及以上的權限，BMP 權限下不支援訂閲。參數
message C2S
{
repeated Qot_Common.Security securityList = 1; //股票陣列
repeated int32 subTypeList = 2; //Qot_Common.SubType，訂閲數據類型陣列
required bool isSubOrUnSub = 3; //true 表示訂閲，false 表示反訂閲
optional bool isRegOrUnRegPush = 4; //是否註冊或反註冊該連線上面行情的推送，該參數不指定不做註冊反註冊操作
repeated int32 regPushRehabTypeList = 5; //Qot_Common.RehabType，復權類型，註冊推送並且是 K 線類型才生效，其他訂閲類型忽略該參數，註冊 K 線推送時該參數不指定預設前復權
optional bool isFirstPush = 6; //註冊後如果本地已有數據是否首推一次已存在數據，該參數不指定則預設 true
optional bool isUnsubAll = 7; //一鍵取消當前連線的所有訂閲，當被設定為 True 時忽略其他參數。
optional bool isSubOrderBookDetail = 8; //訂閲擺盤可用，是否訂閲擺盤明細，僅支援 SF 行情，該參數不指定則預設 false
optional bool extendedTime = 9; // 是否允許美股盤前盤後數據（僅用於訂閲美股的實時 K 線、實時分時、實時逐筆）
optional int32 session = 10; // 是否允許美股盤前盤後以及夜盤數據（僅用於訂閲美股的實時 K 線、實時分時、實時逐筆）,該參數指定後忽略 extendedTime
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
- 返回
message S2C
{
}
message Response
{
required int32 retType = 1 [default = -400]; //RetType,返回結果
optional string retMsg = 2;
optional int32 errCode = 3;
optional S2C s2c = 4;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
- 介面呼叫結果，結構參見 RetType
- Example
import ftWebsocket from "futu-api";
import { ftCmdID } from "futu-api";
import { Common, Qot_Common } from "futu-api/proto";
function Sub(){
const { RetType } = Common
const { SubType, QotMarket } = Qot_Common
let [addr, port, enable_ssl, key] = ["127.0.0.1", 33333, false, 'XXXXX'];
let websocket = new ftWebsocket();
websocket.onlogin = (ret, msg)=>{
if (ret) { // 登入成功
const req = {
c2s: {
securityList: [
{
market: QotMarket.QotMarket_HK_Security,
code: "00700",
},
],
subTypeList: [ SubType.SubType_OrderBook ], // 訂閲買賣擺盤類型
isSubOrUnSub: true, // 訂閲 true, 反訂閲 false
isRegOrUnRegPush: true, // 註冊推送 true, 反註冊推送 false
},
}; // 訂閲參數
websocket.Sub(req) //# 訂閲, OpenD 開始持續收到伺服器的推送
.then((res) => {
let { errCode, retMsg, retType } = res
console.log("subscribe: errCode %d, retMsg %s, retType %d", errCode, retMsg, retType);
})
.catch((error) => {
if ("retMsg" in error) {
console.log("error:", error.retMsg);
}
});
} else {
console.log("error", msg);
}
};
websocket.onPush = (cmd, res)=>{
if(ftCmdID.QotUpdateOrderBook.cmd == cmd){
let { retType, s2c } = res
if(retType == RetType.RetType_Succeed){
console.log("OrderBookTest", s2c);
} else {
console.log("OrderBookTest: error")
}
}
};
websocket.start(addr, port, enable_ssl, key);
setTimeout(()=>{
websocket.stop();
console.log("stop");
}, 5000); // 接收 OpenD 的推送持續時間為5秒,5秒後斷開
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
- Output
subscribe: errCode 0, retMsg , retType 0
OrderBookTest {"security":{"market":1,"code":"00700"},"orderBookAskList":[{"price":492.6,"volume":"32300","orederCount":55},{"price":492.8,"volume":"14100","orederCount":16},{"price":493,"volume":"25200","orederCount":30},{"price":493.2,"volume":"12300","orederCount":11},{"price":493.4,"volume":"9000","orederCount":7},{"price":493.6,"volume":"13500","orederCount":10},{"price":493.8,"volume":"9800","orederCount":12},{"price":494,"volume":"10500","orederCount":18},{"price":494.2,"volume":"6100","orederCount":6},{"price":494.4,"volume":"11400","orederCount":5}],"orderBookBidList":[{"price":492.4,"volume":"30600","orederCount":59},{"price":492.2,"volume":"29800","orederCount":49},{"price":492,"volume":"97900","orederCount":120},{"price":491.8,"volume":"24700","orederCount":55},{"price":491.6,"volume":"35300","orederCount":50},{"price":491.4,"volume":"11200","orederCount":18},{"price":491.2,"volume":"29300","orederCount":39},{"price":491,"volume":"77900","orederCount":229},{"price":490.8,"volume":"14100","orederCount":39},{"price":490.6,"volume":"22800","orederCount":34}]}
OrderBookTest { ... }
...
...
stop
1
2
3
4
5
6
2
3
4
5
6
介面限制
- 支援多種實時數據類型的訂閲，參見 SubType ，每隻股票訂閲一個類型佔用一個額度。
- 訂閲額度規則請參見 訂閲額度 & 歷史 K 線額度。
- 至少訂閲一分鐘才可以反訂閲。
- 由於港股 SF 行情擺盤數據量較大，為保證 SF 行情的速度和 OpenD 的處理效能，目前 SF 權限用戶僅限同時訂閲 50 只證券類產品（含 hkex 的正股、窩輪、牛熊）的擺盤，剩餘訂閲額度仍可用於訂閲其他類型，如：逐筆，買賣經紀等。
- 港股期權期貨在 LV1 權限下，不支援訂閲逐筆類型。
- Python
- Proto
- C#
- Java
- C++
- JavaScript
# 訂閲
subscribe(code_list, subtype_list, is_first_push=True, subscribe_push=True, is_detailed_orderbook=False, extended_time=False, session=Session.NONE)
介紹
訂閲註冊需要的實時資訊，指定股票和訂閲的數據類型即可。
參數
參數 類型 説明 code_list list 需要訂閲的股票代碼列表 list 中元素類型是 strsubtype_list list 需要訂閲的數據類型列表 list 中元素類型是 SubTypeis_first_push bool 訂閲成功之後是否立即推送一次快取數據 - True：推送快取
當腳本和 OpenD 之間出現斷線重連，重新訂閲時若設定為 True，會再次推送斷線前的最後一條數據 - False：不推送快取。等待伺服器的最新推送
subscribe_push bool 訂閲後是否推送 訂閲後，OpenD 提供了兩種取數據的方式，如果您僅使用 獲取實時數據 的方式，選擇 False 可以節省一部分效能消耗- True：推送。如果使用 實時數據回調 的方式，則必須設定為 True
- False：不推送。如果僅使用 獲取實時數據 的方式，則建議設定為 False
is_detailed_orderbook bool 是否訂閲詳細的擺盤訂單明細 - 僅用於港股 SF 行情權限下訂閲港股 ORDER_BOOK 類型
- 美股美期 LV2 權限下不提供詳細擺盤訂單明細
extended_time bool 是否允許美股盤前盤後數據 僅用於訂閲美股實時 K 線、實時分時、實時逐筆session Session 美股訂閲時段 - 僅用於訂閲美股實時 K 線、實時分時、實時逐筆
- 訂閲美股行情不支援入參OVERNIGHT
- 最低OpenD版本：9.2.4207
- True：推送快取
返回
參數 類型 説明 ret RET_CODE 介面呼叫結果 err_message NoneType 當 ret == RET_OK 時，返回 None str 當 ret != RET_OK 時，返回錯誤描述 Example
import time
from moomoo import *
class OrderBookTest(OrderBookHandlerBase):
def on_recv_rsp(self, rsp_pb):
ret_code, data = super(OrderBookTest,self).on_recv_rsp(rsp_pb)
if ret_code != RET_OK:
print("OrderBookTest: error, msg: %s" % data)
return RET_ERROR, data
print("OrderBookTest ", data) # OrderBookTest 自己的處理邏輯
return RET_OK, data
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
handler = OrderBookTest()
quote_ctx.set_handler(handler) # 設定實時擺盤迴調
quote_ctx.subscribe(['US.AAPL'], [SubType.ORDER_BOOK]) # 訂閲買賣擺盤類型，OpenD 開始持續收到伺服器的推送
time.sleep(15) # 設定腳本接收 OpenD 的推送持續時間為15秒
quote_ctx.close() # 關閉當條連線，OpenD 會在1分鐘後自動取消相應股票相應類型的訂閲
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
- Output
OrderBookTest {'code': 'US.AAPL', 'name': '蘋果', 'svr_recv_time_bid': '2025-04-07 05:00:52.266', 'svr_recv_time_ask': '2025-04-07 05:00:53.973', 'Bid': [(180.2, 15, 3, {}), (180.19, 1, 1, {}), (180.18, 11, 2, {}), (180.14, 200, 1, {}), (180.13, 3, 2, {}), (180.1, 99, 3, {}), (180.05, 3, 1, {}), (180.03, 400, 1, {}), (180.02, 10, 1, {}), (180.01, 100, 1, {}), (180.0, 441, 24, {})], 'Ask': [(180.3, 100, 1, {}), (180.38, 4, 2, {}), (180.4, 100, 1, {}), (180.42, 200, 1, {}), (180.46, 29, 1, {}), (180.5, 1019, 2, {}), (180.6, 1000, 1, {}), (180.8, 2001, 3, {}), (180.84, 15, 2, {}), (181.0, 2036, 4, {}), (181.2, 2000, 2, {}), (181.3, 3, 1, {}), (181.4, 2021, 3, {}), (181.5, 59, 2, {}), (181.79, 9, 1, {}), (181.8, 20, 1, {}), (181.9, 94, 4, {}), (181.98, 20, 1, {}), (182.0, 150, 7, {})]}
1
# 取消訂閲
unsubscribe(code_list, subtype_list, unsubscribe_all=False)
介紹
取消訂閲
參數
參數 類型 説明 code_list list 取消訂閲的股票代碼列表 list 中元素類型是 strsubtype_list list 需要訂閲的數據類型列表 list 中元素類型是 SubTypeunsubscribe_all bool 取消所有訂閲 為 True 時忽略其他參數
Return
參數 類型 説明 ret RET_CODE 介面呼叫結果 err_message NoneType 當 ret == RET_OK, 返回 None str 當 ret != RET_OK, 返回錯誤描述 Example
from moomoo import *
import time
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
print('current subscription status :', quote_ctx.query_subscription()) # 查詢初始訂閲狀態
ret_sub, err_message = quote_ctx.subscribe(['US.AAPL'], [SubType.QUOTE, SubType.TICKER], subscribe_push=False, session=Session.None)
# 先訂閲了AAPL全時段 QUOTE 和 TICKER 兩個類型。訂閲成功後 OpenD 將持續收到伺服器的推送，False 代表暫時不需要推送給腳本
if ret_sub == RET_OK: # 訂閲成功
print('subscribe successfully！current subscription status :', quote_ctx.query_subscription()) # 訂閲成功後查詢訂閲狀態
time.sleep(60) # 訂閲之後至少1分鐘才能取消訂閲
ret_unsub, err_message_unsub = quote_ctx.unsubscribe(['US.AAPL'], [SubType.QUOTE])
if ret_unsub == RET_OK:
print('unsubscribe successfully！current subscription status:', quote_ctx.query_subscription()) # 取消訂閲後查詢訂閲狀態
else:
print('unsubscription failed！', err_message_unsub)
else:
print('subscription failed', err_message)
quote_ctx.close() # 結束後記得關閉當條連線，防止連線條數用盡
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
- Output
current subscription status : (0, {'total_used': 0, 'remain': 1000, 'own_used': 0, 'sub_list': {}})
subscribe successfully！current subscription status : (0, {'total_used': 2, 'remain': 998, 'own_used': 2, 'sub_list': {'QUOTE': ['US.AAPL'], 'TICKER': ['US.AAPL']}})
unsubscribe successfully！current subscription status: (0, {'total_used': 1, 'remain': 999, 'own_used': 1, 'sub_list': {'TICKER': ['US.AAPL']}})
1
2
3
2
3
# 取消所有訂閲
unsubscribe_all()
- 介紹
取消所有訂閲
返回
參數 類型 説明 ret RET_CODE 介面呼叫結果 err_message NoneType 當 ret == RET_OK, 返回 None str 當 ret != RET_OK, 返回錯誤描述 Example
from moomoo import *
import time
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
print('current subscription status :', quote_ctx.query_subscription()) # 查詢初始訂閲狀態
ret_sub, err_message = quote_ctx.subscribe(['US.AAPL'], [SubType.QUOTE, SubType.TICKER], subscribe_push=False, session=Session.None)
# 先訂閲了AAPL全時段 QUOTE 和 TICKER 兩個類型。訂閲成功後 OpenD 將持續收到伺服器的推送，False 代表暫時不需要推送給腳本
if ret_sub == RET_OK: # 訂閲成功
print('subscribe successfully！current subscription status :', quote_ctx.query_subscription()) # 訂閲成功後查詢訂閲狀態
time.sleep(60) # 訂閲之後至少1分鐘才能取消訂閲
ret_unsub, err_message_unsub = quote_ctx.unsubscribe_all() # 取消所有訂閲
if ret_unsub == RET_OK:
print('unsubscribe all successfully！current subscription status:', quote_ctx.query_subscription()) # 取消訂閲後查詢訂閲狀態
else:
print('Failed to cancel all subscriptions！', err_message_unsub)
else:
print('subscription failed', err_message)
quote_ctx.close() # 結束後記得關閉當條連線，防止連線條數用盡
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
- Output
current subscription status : (0, {'total_used': 0, 'remain': 1000, 'own_used': 0, 'sub_list': {}})
subscribe successfully！current subscription status : (0, {'total_used': 2, 'remain': 998, 'own_used': 2, 'sub_list': {'QUOTE': ['US.AAPL'], 'TICKER': ['US.AAPL']}})
unsubscribe all successfully！current subscription status: (0, {'total_used': 0, 'remain': 1000, 'own_used': 0, 'sub_list': {}})
1
2
3
2
3
# Qot_Sub.proto
介紹
訂閲註冊需要的實時資訊，指定股票和訂閲的數據類型即可。
參數
message C2S
{
repeated Qot_Common.Security securityList = 1; //股票陣列
repeated int32 subTypeList = 2; //Qot_Common.SubType，訂閲數據類型陣列
required bool isSubOrUnSub = 3; //true 表示訂閲，false 表示反訂閲
optional bool isRegOrUnRegPush = 4; //是否註冊或反註冊該連線上面行情的推送，該參數不指定不做註冊反註冊操作
repeated int32 regPushRehabTypeList = 5; //Qot_Common.RehabType，復權類型，註冊推送並且是 K 線類型才生效，其他訂閲類型忽略該參數，註冊 K 線推送時該參數不指定預設前復權
optional bool isFirstPush = 6; //註冊後如果本地已有數據是否首推一次已存在數據，該參數不指定則預設 true
optional bool isUnsubAll = 7; //一鍵取消當前連線的所有訂閲，當被設定為 True 時忽略其他參數。
optional bool isSubOrderBookDetail = 8; //訂閲擺盤可用，是否訂閲擺盤明細，僅支援 SF 行情，該參數不指定則預設 false
optional bool extendedTime = 9; // 是否允許美股盤前盤後數據（僅用於訂閲美股的實時 K 線、實時分時、實時逐筆）
optional int32 session = 10; // 是否允許美股盤前盤後以及夜盤數據（僅用於訂閲美股的實時 K 線、實時分時、實時逐筆）,該參數指定後忽略 extendedTime
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
- 返回
message S2C
{
}
message Response
{
required int32 retType = 1 [default = -400]; //RetType,返回結果
optional string retMsg = 2;
optional int32 errCode = 3;
optional S2C s2c = 4;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
- 介面呼叫結果，結構參見 RetType
協議 ID
3001
# Sub
uint Sub(QotSub.Request req);
virtual void OnReply_Sub(MMAPI_Conn client, uint nSerialNo, QotSub.Response rsp);
- 介紹
訂閲註冊需要的實時資訊，指定股票和訂閲的數據類型即可。
- 參數
message C2S
{
repeated Qot_Common.Security securityList = 1; //股票陣列
repeated int32 subTypeList = 2; //Qot_Common.SubType，訂閲數據類型陣列
required bool isSubOrUnSub = 3; //true 表示訂閲，false 表示反訂閲
optional bool isRegOrUnRegPush = 4; //是否註冊或反註冊該連線上面行情的推送，該參數不指定不做註冊反註冊操作
repeated int32 regPushRehabTypeList = 5; //Qot_Common.RehabType，復權類型，註冊推送並且是 K 線類型才生效，其他訂閲類型忽略該參數，註冊 K 線推送時該參數不指定預設前復權
optional bool isFirstPush = 6; //註冊後如果本地已有數據是否首推一次已存在數據，該參數不指定則預設 true
optional bool isUnsubAll = 7; //一鍵取消當前連線的所有訂閲，當被設定為 True 時忽略其他參數。
optional bool isSubOrderBookDetail = 8; //訂閲擺盤可用，是否訂閲擺盤明細，僅支援 SF 行情，該參數不指定則預設 false
optional bool extendedTime = 9; // 是否允許美股盤前盤後數據（僅用於訂閲美股的實時 K 線、實時分時、實時逐筆）
optional int32 session = 10; // 是否允許美股盤前盤後以及夜盤數據（僅用於訂閲美股的實時 K 線、實時分時、實時逐筆）,該參數指定後忽略 extendedTime
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
- 返回
message S2C
{
}
message Response
{
required int32 retType = 1 [default = -400]; //RetType,返回結果
optional string retMsg = 2;
optional int32 errCode = 3;
optional S2C s2c = 4;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
- 介面呼叫結果，結構參見 RetType
- Example
public class Program : MMSPI_Qot, MMSPI_Conn {
MMAPI_Qot qot = new MMAPI_Qot();
public Program() {
qot.SetClientInfo("csharp", 1); //設定用戶端資訊
qot.SetConnCallback(this); //設定連線回調
qot.SetQotCallback(this); //設定交易回調
}
public void Start() {
qot.InitConnect("127.0.0.1", (ushort)11111, false);
}
public void OnInitConnect(MMAPI_Conn client, long errCode, String desc)
{
Console.Write("Qot onInitConnect: ret={0} desc={1} connID={2}\n", errCode, desc, client.GetConnectID());
if (errCode != 0)
return;
QotCommon.Security sec = QotCommon.Security.CreateBuilder()
.SetMarket((int)QotCommon.QotMarket.QotMarket_HK_Security)
.SetCode("00700")
.Build();
QotSub.C2S c2s = QotSub.C2S.CreateBuilder()
.AddSecurityList(sec)
.AddSubTypeList((int)QotCommon.SubType.SubType_Basic)
.SetIsSubOrUnSub(true)
.Build();
QotSub.Request req = QotSub.Request.CreateBuilder().SetC2S(c2s).Build();
uint seqNo = qot.Sub(req);
Console.Write("Send QotSub: {0}\n", seqNo);
}
public void OnDisconnect(MMAPI_Conn client, long errCode) {
Console.Write("Qot onDisConnect: {0}\n", errCode);
}
public void OnReply_Sub(MMAPI_Conn client, uint nSerialNo, QotSub.Response rsp) {
Console.Write("Reply: QotSub: {0} {1}\n", nSerialNo, rsp.ToString());
}
public static void Main(String[] args) {
MMAPI.Init();
Program qot = new Program();
qot.Start();
while (true)
Thread.Sleep(1000 * 600);
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
- Output
Qot onInitConnect: ret=0 desc= connID=6819171983431767818
Send QotSub: 3
Reply: QotSub: 3 retType: 0
retMsg: ""
errCode: 0
1
2
3
4
5
2
3
4
5
# sub
int sub(QotSub.Request req);
void onReply_Sub(MMAPI_Conn client, int nSerialNo, QotSub.Response rsp);
- 介紹
訂閲註冊需要的實時資訊，指定股票和訂閲的數據類型即可。
- 參數
message C2S
{
repeated Qot_Common.Security securityList = 1; //股票陣列
repeated int32 subTypeList = 2; //Qot_Common.SubType，訂閲數據類型陣列
required bool isSubOrUnSub = 3; //true 表示訂閲，false 表示反訂閲
optional bool isRegOrUnRegPush = 4; //是否註冊或反註冊該連線上面行情的推送，該參數不指定不做註冊反註冊操作
repeated int32 regPushRehabTypeList = 5; //Qot_Common.RehabType，復權類型，註冊推送並且是 K 線類型才生效，其他訂閲類型忽略該參數，註冊 K 線推送時該參數不指定預設前復權
optional bool isFirstPush = 6; //註冊後如果本地已有數據是否首推一次已存在數據，該參數不指定則預設 true
optional bool isUnsubAll = 7; //一鍵取消當前連線的所有訂閲，當被設定為 True 時忽略其他參數。
optional bool isSubOrderBookDetail = 8; //訂閲擺盤可用，是否訂閲擺盤明細，僅支援 SF 行情，該參數不指定則預設 false
optional bool extendedTime = 9; // 是否允許美股盤前盤後數據（僅用於訂閲美股的實時 K 線、實時分時、實時逐筆）
optional int32 session = 10; // 是否允許美股盤前盤後以及夜盤數據（僅用於訂閲美股的實時 K 線、實時分時、實時逐筆）,該參數指定後忽略 extendedTime
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
- 返回
message S2C
{
}
message Response
{
required int32 retType = 1 [default = -400]; //RetType,返回結果
optional string retMsg = 2;
optional int32 errCode = 3;
optional S2C s2c = 4;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
- 介面呼叫結果，結構參見 RetType
- Example
public class QotDemo implements MMSPI_Qot, MMSPI_Conn {
MMAPI_Conn_Qot qot = new MMAPI_Conn_Qot();
public QotDemo() {
qot.setClientInfo("javaclient", 1); //設定用戶端資訊
qot.setConnSpi(this); //設定連線回調
qot.setQotSpi(this); //設定交易回調
}
public void start() {
qot.initConnect("127.0.0.1", (short)11111, false);
}
@Override
public void onInitConnect(MMAPI_Conn client, long errCode, String desc)
{
System.out.printf("Qot onInitConnect: ret=%b desc=%s connID=%d\n", errCode, desc, client.getConnectID());
if (errCode != 0)
return;
QotCommon.Security sec = QotCommon.Security.newBuilder()
.setMarket(QotCommon.QotMarket.QotMarket_HK_Security_VALUE)
.setCode("00700")
.build();
QotSub.C2S c2s = QotSub.C2S.newBuilder()
.addSecurityList(sec)
.addSubTypeList(QotCommon.SubType.SubType_Basic_VALUE)
.setIsSubOrUnSub(true)
.build();
QotSub.Request req = QotSub.Request.newBuilder().setC2S(c2s).build();
int seqNo = qot.sub(req);
System.out.printf("Send QotSub: %d\n", seqNo);
}
@Override
public void onDisconnect(MMAPI_Conn client, long errCode) {
System.out.printf("Qot onDisConnect: %d\n", errCode);
}
@Override
public void onReply_Sub(MMAPI_Conn client, int nSerialNo, QotSub.Response rsp) {
if (rsp.getRetType() != 0) {
System.out.printf("QotSub failed: %s\n", rsp.getRetMsg());
}
else {
try {
String json = JsonFormat.printer().print(rsp);
System.out.printf("Receive QotSub: %s\n", json);
} catch (InvalidProtocolBufferException e) {
e.printStackTrace();
}
}
}
public static void main(String[] args) {
MMAPI.init();
QotDemo qot = new QotDemo();
qot.start();
while (true) {
try {
Thread.sleep(1000 * 600);
} catch (InterruptedException exc) {
}
}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
- Output
Send QotSub: 2
Receive QotSub: {
"retType": 0,
"retMsg": "",
"errCode": 0
}
1
2
3
4
5
6
2
3
4
5
6
# Sub
moomoo::u32_t Sub(const Qot_Sub::Request &stReq);
virtual void OnReply_Sub(moomoo::u32_t nSerialNo, const Qot_Sub::Response &stRsp) = 0;
介紹
訂閲註冊需要的實時資訊，指定股票和訂閲的數據類型即可。
參數
message C2S
{
repeated Qot_Common.Security securityList = 1; //股票陣列
repeated int32 subTypeList = 2; //Qot_Common.SubType，訂閲數據類型陣列
required bool isSubOrUnSub = 3; //true 表示訂閲，false 表示反訂閲
optional bool isRegOrUnRegPush = 4; //是否註冊或反註冊該連線上面行情的推送，該參數不指定不做註冊反註冊操作
repeated int32 regPushRehabTypeList = 5; //Qot_Common.RehabType，復權類型，註冊推送並且是 K 線類型才生效，其他訂閲類型忽略該參數，註冊 K 線推送時該參數不指定預設前復權
optional bool isFirstPush = 6; //註冊後如果本地已有數據是否首推一次已存在數據，該參數不指定則預設 true
optional bool isUnsubAll = 7; //一鍵取消當前連線的所有訂閲，當被設定為 True 時忽略其他參數。
optional bool isSubOrderBookDetail = 8; //訂閲擺盤可用，是否訂閲擺盤明細，僅支援 SF 行情，該參數不指定則預設 false
optional bool extendedTime = 9; // 是否允許美股盤前盤後數據（僅用於訂閲美股的實時 K 線、實時分時、實時逐筆）
optional int32 session = 10; // 是否允許美股盤前盤後以及夜盤數據（僅用於訂閲美股的實時 K 線、實時分時、實時逐筆）,該參數指定後忽略 extendedTime
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
- 返回
message S2C
{
}
message Response
{
required int32 retType = 1 [default = -400]; //RetType,返回結果
optional string retMsg = 2;
optional int32 errCode = 3;
optional S2C s2c = 4;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
- 介面呼叫結果，結構參見 RetType
- Example
class Program : public MMSPI_Qot, public MMSPI_Trd, public MMSPI_Conn
{
public:
Program() {
m_pQotApi = MMAPI::CreateQotApi();
m_pQotApi->RegisterQotSpi(this);
m_pQotApi->RegisterConnSpi(this);
}
~Program() {
if (m_pQotApi != nullptr)
{
m_pQotApi->UnregisterQotSpi();
m_pQotApi->UnregisterConnSpi();
MMAPI::ReleaseQotApi(m_pQotApi);
m_pQotApi = nullptr;
}
}
void Start() {
m_pQotApi->InitConnect("127.0.0.1", 11111, false);
}
virtual void OnInitConnect(MMAPI_Conn* pConn, moomoo::i64_t nErrCode, const char* strDesc) {
cout << "connect" << endl;
// 這個介面要先訂閲
Qot_Sub::Request req;
Qot_Sub::C2S *c2s = req.mutable_c2s();
auto secList = c2s->mutable_securitylist();
Qot_Common::Security *sec = secList->Add();
sec->set_code("00700");
sec->set_market(Qot_Common::QotMarket::QotMarket_HK_Security);
c2s->add_subtypelist(Qot_Common::SubType::SubType_Basic);
c2s->set_isregorunregpush(true);
c2s->set_issuborunsub(true);
m_SubSerialNo = m_pQotApi->Sub(req);
cout << "Request Sub SerialNo: " << m_SubSerialNo << endl;
}
virtual void OnReply_Sub(moomoo::u32_t nSerialNo, const Qot_Sub::Response &stRsp)
{
if(nSerialNo == m_SubSerialNo)
{
cout << "OnReply_Sub SerialNo: " << nSerialNo << endl;
if(stRsp.rettype() != Common::RetType::RetType_Succeed)
{
cout << "Sub Failed" << endl;
return;
}
// 組包
Qot_GetBasicQot::Request req;
Qot_GetBasicQot::C2S *c2s = req.mutable_c2s();
auto secList = c2s->mutable_securitylist();
Qot_Common::Security *sec = secList->Add();
sec->set_code("00700");
sec->set_market(Qot_Common::QotMarket::QotMarket_HK_Security);
m_GetBasicQotSerialNo = m_pQotApi->GetBasicQot(req);
cout << "Request GetBasicQot SerialNo: " << m_GetBasicQotSerialNo << endl;
}
}
virtual void OnReply_GetBasicQot(moomoo::u32_t nSerialNo, const Qot_GetBasicQot::Response &stRsp){
if(nSerialNo == m_GetBasicQotSerialNo)
{
cout << "OnReply_GetBasicQot SerialNo: " << nSerialNo << endl;
// 解析內部結構列印出來
// ProtoBufToBodyData和UTF8ToLocal函數的定義參見Sample中的tool.h檔案
string resp_str;
ProtoBufToBodyData(stRsp, resp_str);
cout << UTF8ToLocal(resp_str) << endl;
}
}
protected:
MMAPI_Qot *m_pQotApi;
moomoo::u32_t m_SubSerialNo;
moomoo::u32_t m_GetBasicQotSerialNo;
};
int32_t main(int32_t argc, char** argv)
{
MMAPI::Init();
{
Program program;
program.Start();
getchar();
}
protobuf::ShutdownProtobufLibrary();
MMAPI::UnInit();
return 0;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
- Output
connect
Request Sub SerialNo: 3
OnReply_Sub SerialNo: 3
Request GetBasicQot SerialNo: 4
OnReply_GetBasicQot SerialNo: 4
{
"retType": 0,
"retMsg": "",
"errCode": 0,
"s2c": {
"basicQotList": [
{
"security": {
"market": 1,
"code": "00700"
},
"isSuspended": false,
"listTime": "2004-06-16",
"priceSpread": 0.2,
"updateTime": "2021-09-14 16:08:30",
"highPrice": 482.8,
"openPrice": 476.4,
"lowPrice": 468.8,
"curPrice": 472.8,
"lastClosePrice": 478,
"volume": "19905281",
"turnover": 9452753751,
"turnoverRate": 0.207,
"amplitude": 2.929,
"darkStatus": 0,
"listTimestamp": 1087315200,
"updateTimestamp": 1631606910,
"secStatus": 1
}
]
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# Sub
Sub(req);
介紹
訂閲註冊需要的實時資訊，指定股票和訂閲的數據類型即可。
參數
message C2S
{
repeated Qot_Common.Security securityList = 1; //股票陣列
repeated int32 subTypeList = 2; //Qot_Common.SubType，訂閲數據類型陣列
required bool isSubOrUnSub = 3; //true 表示訂閲，false 表示反訂閲
optional bool isRegOrUnRegPush = 4; //是否註冊或反註冊該連線上面行情的推送，該參數不指定不做註冊反註冊操作
repeated int32 regPushRehabTypeList = 5; //Qot_Common.RehabType，復權類型，註冊推送並且是 K 線類型才生效，其他訂閲類型忽略該參數，註冊 K 線推送時該參數不指定預設前復權
optional bool isFirstPush = 6; //註冊後如果本地已有數據是否首推一次已存在數據，該參數不指定則預設 true
optional bool isUnsubAll = 7; //一鍵取消當前連線的所有訂閲，當被設定為 True 時忽略其他參數。
optional bool isSubOrderBookDetail = 8; //訂閲擺盤可用，是否訂閲擺盤明細，僅支援 SF 行情，該參數不指定則預設 false
optional bool extendedTime = 9; // 是否允許美股盤前盤後數據（僅用於訂閲美股的實時 K 線、實時分時、實時逐筆）
optional int32 session = 10; // 是否允許美股盤前盤後以及夜盤數據（僅用於訂閲美股的實時 K 線、實時分時、實時逐筆）,該參數指定後忽略 extendedTime
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
- 返回
message S2C
{
}
message Response
{
required int32 retType = 1 [default = -400]; //RetType,返回結果
optional string retMsg = 2;
optional int32 errCode = 3;
optional S2C s2c = 4;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
- 介面呼叫結果，結構參見 RetType
- Example
import mmWebsocket from "moomoo-api";
import { mmCmdID } from "moomoo-api";
import { Common, Qot_Common } from "moomoo-api/proto";
function Sub(){
const { RetType } = Common
const { SubType, QotMarket } = Qot_Common
let [addr, port, enable_ssl, key] = ["127.0.0.1", 33333, false, 'XXXXX'];
let websocket = new mmWebsocket();
websocket.onlogin = (ret, msg)=>{
if (ret) { // 登入成功
const req = {
c2s: {
securityList: [
{
market: QotMarket.QotMarket_HK_Security,
code: "00700",
},
],
subTypeList: [ SubType.SubType_OrderBook ], // 訂閲買賣擺盤類型
isSubOrUnSub: true, // 訂閲 true, 反訂閲 false
isRegOrUnRegPush: true, // 註冊推送 true, 反註冊推送 false
},
}; // 訂閲參數
websocket.Sub(req) //# 訂閲, OpenD 開始持續收到伺服器的推送
.then((res) => {
let { errCode, retMsg, retType } = res
console.log("subscribe: errCode %d, retMsg %s, retType %d", errCode, retMsg, retType);
})
.catch((error) => {
if ("retMsg" in error) {
console.log("error:", error.retMsg);
}
});
} else {
console.log("error", msg);
}
};
websocket.onPush = (cmd, res)=>{
if(ftCmdID.QotUpdateOrderBook.cmd == cmd){
let { retType, s2c } = res
if(retType == RetType.RetType_Succeed){
console.log("OrderBookTest", s2c);
} else {
console.log("OrderBookTest: error")
}
}
};
websocket.start(addr, port, enable_ssl, key);
setTimeout(()=>{
websocket.stop();
console.log("stop");
}, 5000); // 接收 OpenD 的推送持續時間為5秒,5秒後斷開
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
- Output
subscribe: errCode 0, retMsg , retType 0
OrderBookTest {"security":{"market":1,"code":"00700"},"orderBookAskList":[{"price":492.6,"volume":"32300","orederCount":55},{"price":492.8,"volume":"14100","orederCount":16},{"price":493,"volume":"25200","orederCount":30},{"price":493.2,"volume":"12300","orederCount":11},{"price":493.4,"volume":"9000","orederCount":7},{"price":493.6,"volume":"13500","orederCount":10},{"price":493.8,"volume":"9800","orederCount":12},{"price":494,"volume":"10500","orederCount":18},{"price":494.2,"volume":"6100","orederCount":6},{"price":494.4,"volume":"11400","orederCount":5}],"orderBookBidList":[{"price":492.4,"volume":"30600","orederCount":59},{"price":492.2,"volume":"29800","orederCount":49},{"price":492,"volume":"97900","orederCount":120},{"price":491.8,"volume":"24700","orederCount":55},{"price":491.6,"volume":"35300","orederCount":50},{"price":491.4,"volume":"11200","orederCount":18},{"price":491.2,"volume":"29300","orederCount":39},{"price":491,"volume":"77900","orederCount":229},{"price":490.8,"volume":"14100","orederCount":39},{"price":490.6,"volume":"22800","orederCount":34}]}
OrderBookTest { ... }
...
...
stop
1
2
3
4
5
6
2
3
4
5
6
介面限制
- 支援多種實時數據類型的訂閲，參見 SubType ，每隻股票訂閲一個類型佔用一個額度。
- 訂閲額度規則請參見 訂閲額度 & 歷史 K 線額度。
- 至少訂閲一分鐘才可以反訂閲。
- 由於港股 SF 行情擺盤數據量較大，為保證 SF 行情的速度和 OpenD 的處理效能，目前 SF 權限用戶僅限同時訂閲 50 只證券類產品（含 hkex 的正股、窩輪、牛熊）的擺盤、經紀隊列，剩餘訂閲額度仍可用於訂閲其他類型，如：逐筆，買賣經紀等。
- 港股期權期貨在 LV1 權限下，不支援訂閲逐筆類型。