# 登録・登録解除
- 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)
概要
必要なリアルタイム情報の配信登録を行います。銘柄と登録するデータタイプを指定してください。
香港市場(正株、ワラント、CBBC、オプション、先物を含む)の登録にはLV1以上の権限が必要です。BMP権限では登録に対応していません。
米国株市場(正株、ETFを含む)の夜間取引相場情報の登録にはLV1以上の権限が必要です。BMP権限では登録に対応していません。パラメータ
パラメータ 型 説明 code_list list 登録する銘柄コードリスト list内の要素タイプはstrsubtype_list list 登録するデータタイプリスト list内の要素タイプはSubTypeis_first_push bool 登録成功後にキャッシュデータを即座にプッシュするかどうか - True:キャッシュをプッシュ
スクリプトとOpenD間で切断・再接続が発生し、再登録時にTrueを設定すると、切断前の最後のデータを再プッシュします - False:キャッシュをプッシュしない。サーバーからの最新プッシュを待機
subscribe_push bool 登録後にプッシュするかどうか 登録後、OpenDは2種類のデータ取得方式を提供しています。リアルタイムデータ取得方式のみ使用する場合、Falseに設定するとパフォーマンス消費を節約できます- True:プッシュする。リアルタイムデータコールバック方式を使用する場合はTrueに設定必須
- False:プッシュしない。リアルタイムデータ取得方式のみ使用する場合はFalseに設定推奨
is_detailed_orderbook bool 詳細な板情報の注文明細を登録するかどうか - 香港株SF相場情報権限での香港株ORDER_BOOKタイプの登録にのみ使用
- 米国株・米国先物LV2権限では詳細な板情報の注文明細は提供されません
extended_time bool 米国株のプレ/アフターマーケットデータを許可するかどうか 米国株のリアルタイムローソク足、リアルタイム分時、リアルタイムティックの登録にのみ使用session Session 米国株の登録時間帯 - 米国株のリアルタイムローソク足、リアルタイム分時、リアルタイムティックの登録にのみ使用
- 米国株の相場情報登録ではOVERNIGHTパラメータは非対応
- 最低OpenDバージョン:9.2.4207
- True:キャッシュをプッシュ
戻り値
パラメータ 型 説明 ret RET_CODE API呼び出し結果 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分後に対応銘柄の登録を自動解除
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, {})]}
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 API呼び出し結果 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の2タイプを登録。登録成功後、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() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。
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']}})
2
3
# すべての登録を解除
unsubscribe_all()
- 概要
すべての登録を解除
戻り値
パラメータ 型 説明 ret RET_CODE API呼び出し結果 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の2タイプを登録。登録成功後、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() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。
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': {}})
2
3
# Qot_Sub.proto
概要
必要なリアルタイム情報の配信登録を行います。銘柄と登録するデータタイプを指定してください。
香港市場(正株、ワラント、CBBC、オプション、先物を含む)の登録にはLV1以上の権限が必要です。BMP権限では登録に対応していません。
米国株市場(正株、ETFを含む)の夜間取引相場情報の登録には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、復権タイプ。プッシュ登録かつローソク足タイプの場合のみ有効。他の登録タイプではこのパラメータを無視。ローソク足プッシュ登録時に未指定の場合、デフォルトは前復権
optional bool isFirstPush = 6; //登録後、ローカルに既存データがある場合に初回プッシュするかどうか。未指定の場合はデフォルト true
optional bool isUnsubAll = 7; //現在の接続のすべての登録を一括解除。True に設定すると他のパラメータを無視します。
optional bool isSubOrderBookDetail = 8; //板情報の登録時に使用可能。板情報明細を登録するかどうか。SF相場情報のみ対応。未指定の場合はデフォルト false
optional bool extendedTime = 9; // 米国株プレ/アフターマーケットデータを許可するか(米国株のリアルタイムローソク足・リアルタイム分時・リアルタイムティックの登録でのみ使用)
optional int32 session = 10; // 米国株のプレ/アフターマーケットおよび夜間取引データを許可するか(米国株のリアルタイムローソク足・リアルタイム分時・リアルタイムティックの登録でのみ使用)。このパラメータ指定時は extendedTime を無視
}
message Request
{
required C2S c2s = 1;
}
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;
}
2
3
4
5
6
7
8
9
10
11
12
13
- API 呼び出し結果,構造は~を参照: RetType
プロトコル ID
3001
# Sub
uint Sub(QotSub.Request req);
virtual void OnReply_Sub(FTAPI_Conn client, uint nSerialNo, QotSub.Response rsp);
- 概要
必要なリアルタイム情報の配信登録を行います。銘柄と登録するデータタイプを指定してください。
香港市場(正株、ワラント、CBBC、オプション、先物を含む)の登録には、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、復権タイプ。プッシュ登録かつローソク足タイプの場合のみ有効。他の登録タイプではこのパラメータを無視。ローソク足プッシュ登録時に未指定の場合、デフォルトは前復権
optional bool isFirstPush = 6; //登録後、ローカルに既存データがある場合に初回プッシュするかどうか。未指定の場合はデフォルト true
optional bool isUnsubAll = 7; //現在の接続のすべての登録を一括解除。True に設定すると他のパラメータを無視します。
optional bool isSubOrderBookDetail = 8; //板情報の登録時に使用可能。板情報明細を登録するかどうか。SF相場情報のみ対応。未指定の場合はデフォルト false
optional bool extendedTime = 9; // 米国株プレ/アフターマーケットデータを許可するか(米国株のリアルタイムローソク足・リアルタイム分時・リアルタイムティックの登録でのみ使用)
}
message Request
{
required C2S c2s = 1;
}
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;
}
2
3
4
5
6
7
8
9
10
11
12
13
- API 呼び出し結果,構造は~を参照: 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);
}
}
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
2
3
4
5
# sub
int sub(QotSub.Request req);
void onReply_Sub(FTAPI_Conn client, int nSerialNo, QotSub.Response rsp);
- 概要
必要なリアルタイム情報の配信登録を行います。銘柄と登録するデータタイプを指定してください。
香港市場(正株、ワラント、CBBC、オプション、先物を含む)の登録には、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、復権タイプ。プッシュ登録かつローソク足タイプの場合のみ有効。他の登録タイプではこのパラメータを無視。ローソク足プッシュ登録時に未指定の場合、デフォルトは前復権
optional bool isFirstPush = 6; //登録後、ローカルに既存データがある場合に初回プッシュするかどうか。未指定の場合はデフォルト true
optional bool isUnsubAll = 7; //現在の接続のすべての登録を一括解除。True に設定すると他のパラメータを無視します。
optional bool isSubOrderBookDetail = 8; //板情報の登録時に使用可能。板情報明細を登録するかどうか。SF相場情報のみ対応。未指定の場合はデフォルト false
optional bool extendedTime = 9; // 米国株プレ/アフターマーケットデータを許可するか(米国株のリアルタイムローソク足・リアルタイム分時・リアルタイムティックの登録でのみ使用)
optional int32 session = 10; // 米国株のプレ/アフターマーケットおよび夜間取引データを許可するか(米国株のリアルタイムローソク足・リアルタイム分時・リアルタイムティックの登録でのみ使用)。このパラメータ指定時は extendedTime を無視
}
message Request
{
required C2S c2s = 1;
}
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;
}
2
3
4
5
6
7
8
9
10
11
12
13
- API 呼び出し結果,構造は~を参照: 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) {
}
}
}
}
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
}
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;
概要
必要なリアルタイム情報の配信登録を行います。銘柄と登録するデータタイプを指定してください。
香港市場(正株、ワラント、CBBC、オプション、先物を含む)の登録にはLV1以上の権限が必要です。BMP権限では登録に対応していません。
米国株市場(正株、ETFを含む)の夜間取引相場情報の登録には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、復権タイプ。プッシュ登録かつローソク足タイプの場合のみ有効。他の登録タイプではこのパラメータを無視。ローソク足プッシュ登録時に未指定の場合、デフォルトは前復権
optional bool isFirstPush = 6; //登録後、ローカルに既存データがある場合に初回プッシュするかどうか。未指定の場合はデフォルト true
optional bool isUnsubAll = 7; //現在の接続のすべての登録を一括解除。True に設定すると他のパラメータを無視します。
optional bool isSubOrderBookDetail = 8; //板情報の登録時に使用可能。板情報明細を登録するかどうか。SF相場情報のみ対応。未指定の場合はデフォルト false
optional bool extendedTime = 9; // 米国株プレ/アフターマーケットデータを許可するか(米国株のリアルタイムローソク足・リアルタイム分時・リアルタイムティックの登録でのみ使用)
optional int32 session = 10; // 米国株のプレ/アフターマーケットおよび夜間取引データを許可するか(米国株のリアルタイムローソク足・リアルタイム分時・リアルタイムティックの登録でのみ使用)。このパラメータ指定時は extendedTime を無視
}
message Request
{
required C2S c2s = 1;
}
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;
}
2
3
4
5
6
7
8
9
10
11
12
13
- API 呼び出し結果,構造は~を参照: 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;
// この API は事前に登録が必要
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;
}
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
}
]
}
}
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);
概要
必要なリアルタイム情報の配信登録を行います。銘柄と登録するデータタイプを指定してください。
香港市場(正株、ワラント、CBBC、オプション、先物を含む)の登録には、LV1 以上の権限が必要です。BMP 権限では登録に対応していません。
米国株市場(正株、ETFを含む)の夜間取引相場情報の登録には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、復権タイプ。プッシュ登録かつローソク足タイプの場合のみ有効。他の登録タイプではこのパラメータを無視。ローソク足プッシュ登録時に未指定の場合、デフォルトは前復権
optional bool isFirstPush = 6; //登録後、ローカルに既存データがある場合に初回プッシュするかどうか。未指定の場合はデフォルト true
optional bool isUnsubAll = 7; //現在の接続のすべての登録を一括解除。True に設定すると他のパラメータを無視します。
optional bool isSubOrderBookDetail = 8; //板情報の登録時に使用可能。板情報明細を登録するかどうか。SF相場情報のみ対応。未指定の場合はデフォルト false
optional bool extendedTime = 9; // 米国株プレ/アフターマーケットデータを許可するか(米国株のリアルタイムローソク足・リアルタイム分時・リアルタイムティックの登録でのみ使用)
optional int32 session = 10; // 米国株のプレ/アフターマーケットおよび夜間取引データを許可するか(米国株のリアルタイムローソク足・リアルタイム分時・リアルタイムティックの登録でのみ使用)。このパラメータ指定時は extendedTime を無視
}
message Request
{
required C2S c2s = 1;
}
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;
}
2
3
4
5
6
7
8
9
10
11
12
13
- API 呼び出し結果,構造は~を参照: 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秒後に切断
}
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
2
3
4
5
6
APIレート制限
- 複数のリアルタイムデータタイプの登録に対応しています。SubType を参照してください。銘柄ごとに1タイプの登録で1枠を消費します。
- 登録枠ルール請を参照 登録枠 & 過去ローソク足データ枠。
- 登録後、少なくとも1分経過しないと登録解除できません。
- 香港株 SF 相場情報の板情報はデータ量が大きいため、SF 相場情報の速度と OpenD の処理性能を確保するために、現在 SF 権限ユーザーは同時に50銘柄(HKEX の正株、ワラント、CBBC を含む)の板情報のみ登録可能です。残りの登録枠は引き続きティック、売買ブローカーなどの他のタイプの登録に使用できます。
- 香港株オプション先物在 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は2種類のデータ取得方式を提供しています。リアルタイムデータ取得方式のみ使用する場合、Falseに設定するとパフォーマンス消費を節約できます- True:プッシュする。リアルタイムデータコールバック方式を使用する場合はTrueに設定必須
- False:プッシュしない。リアルタイムデータ取得方式のみ使用する場合はFalseに設定推奨
is_detailed_orderbook bool 詳細な板情報の注文明細を登録するかどうか - 香港株SF相場情報権限での香港株ORDER_BOOKタイプの登録にのみ使用
- 米国株・米国先物LV2権限では詳細な板情報の注文明細は提供されません
extended_time bool 米国株のプレ/アフターマーケットデータを許可するかどうか 米国株のリアルタイムローソク足、リアルタイム分時、リアルタイムティックの登録にのみ使用session Session 米国株の登録時間帯 - 米国株のリアルタイムローソク足、リアルタイム分時、リアルタイムティックの登録にのみ使用
- 米国株の相場情報登録ではOVERNIGHTパラメータは非対応
- 最低OpenDバージョン:9.2.4207
- True:キャッシュをプッシュ
戻り値
パラメータ 型 説明 ret RET_CODE API呼び出し結果 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分後に対応銘柄の登録を自動解除
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, {})]}
# 登録解除
unsubscribe(code_list, subtype_list, unsubscribe_all=False)
概要
登録解除
パラメータ
パラメータ 型 説明 code_list list 登録解除する銘柄コードリスト list内の要素タイプはstrsubtype_list list 登録するデータタイプリスト list内の要素タイプはSubTypeunsubscribe_all bool すべての登録を解除 為 True 时無視其他パラメータ
Return
パラメータ 型 説明 ret RET_CODE API呼び出し結果 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の2タイプを登録。登録成功後、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() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。
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']}})
2
3
# すべての登録を解除
unsubscribe_all()
- 概要
すべての登録を解除
戻り値
パラメータ 型 説明 ret RET_CODE API呼び出し結果 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の2タイプを登録。登録成功後、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() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。
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': {}})
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、復権タイプ。プッシュ登録かつローソク足タイプの場合のみ有効。他の登録タイプではこのパラメータを無視。ローソク足プッシュ登録時に未指定の場合、デフォルトは前復権
optional bool isFirstPush = 6; //登録後、ローカルに既存データがある場合に初回プッシュするかどうか。未指定の場合はデフォルト true
optional bool isUnsubAll = 7; //現在の接続のすべての登録を一括解除。True に設定すると他のパラメータを無視します。
optional bool isSubOrderBookDetail = 8; //板情報の登録時に使用可能。板情報明細を登録するかどうか。SF相場情報のみ対応。未指定の場合はデフォルト false
optional bool extendedTime = 9; // 米国株プレ/アフターマーケットデータを許可するか(米国株のリアルタイムローソク足・リアルタイム分時・リアルタイムティックの登録でのみ使用)
optional int32 session = 10; // 米国株のプレ/アフターマーケットおよび夜間取引データを許可するか(米国株のリアルタイムローソク足・リアルタイム分時・リアルタイムティックの登録でのみ使用)。このパラメータ指定時は extendedTime を無視
}
message Request
{
required C2S c2s = 1;
}
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;
}
2
3
4
5
6
7
8
9
10
11
12
13
- API 呼び出し結果,構造は~を参照: 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、復権タイプ。プッシュ登録かつローソク足タイプの場合のみ有効。他の登録タイプではこのパラメータを無視。ローソク足プッシュ登録時に未指定の場合、デフォルトは前復権
optional bool isFirstPush = 6; //登録後、ローカルに既存データがある場合に初回プッシュするかどうか。未指定の場合はデフォルト true
optional bool isUnsubAll = 7; //現在の接続のすべての登録を一括解除。True に設定すると他のパラメータを無視します。
optional bool isSubOrderBookDetail = 8; //板情報の登録時に使用可能。板情報明細を登録するかどうか。SF相場情報のみ対応。未指定の場合はデフォルト false
optional bool extendedTime = 9; // 米国株プレ/アフターマーケットデータを許可するか(米国株のリアルタイムローソク足・リアルタイム分時・リアルタイムティックの登録でのみ使用)
optional int32 session = 10; // 米国株のプレ/アフターマーケットおよび夜間取引データを許可するか(米国株のリアルタイムローソク足・リアルタイム分時・リアルタイムティックの登録でのみ使用)。このパラメータ指定時は extendedTime を無視
}
message Request
{
required C2S c2s = 1;
}
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;
}
2
3
4
5
6
7
8
9
10
11
12
13
- API 呼び出し結果,構造は~を参照: 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);
}
}
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
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、復権タイプ。プッシュ登録かつローソク足タイプの場合のみ有効。他の登録タイプではこのパラメータを無視。ローソク足プッシュ登録時に未指定の場合、デフォルトは前復権
optional bool isFirstPush = 6; //登録後、ローカルに既存データがある場合に初回プッシュするかどうか。未指定の場合はデフォルト true
optional bool isUnsubAll = 7; //現在の接続のすべての登録を一括解除。True に設定すると他のパラメータを無視します。
optional bool isSubOrderBookDetail = 8; //板情報の登録時に使用可能。板情報明細を登録するかどうか。SF相場情報のみ対応。未指定の場合はデフォルト false
optional bool extendedTime = 9; // 米国株プレ/アフターマーケットデータを許可するか(米国株のリアルタイムローソク足・リアルタイム分時・リアルタイムティックの登録でのみ使用)
optional int32 session = 10; // 米国株のプレ/アフターマーケットおよび夜間取引データを許可するか(米国株のリアルタイムローソク足・リアルタイム分時・リアルタイムティックの登録でのみ使用)。このパラメータ指定時は extendedTime を無視
}
message Request
{
required C2S c2s = 1;
}
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;
}
2
3
4
5
6
7
8
9
10
11
12
13
- API 呼び出し結果,構造は~を参照: 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) {
}
}
}
}
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
}
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、復権タイプ。プッシュ登録かつローソク足タイプの場合のみ有効。他の登録タイプではこのパラメータを無視。ローソク足プッシュ登録時に未指定の場合、デフォルトは前復権
optional bool isFirstPush = 6; //登録後、ローカルに既存データがある場合に初回プッシュするかどうか。未指定の場合はデフォルト true
optional bool isUnsubAll = 7; //現在の接続のすべての登録を一括解除。True に設定すると他のパラメータを無視します。
optional bool isSubOrderBookDetail = 8; //板情報の登録時に使用可能。板情報明細を登録するかどうか。SF相場情報のみ対応。未指定の場合はデフォルト false
optional bool extendedTime = 9; // 米国株プレ/アフターマーケットデータを許可するか(米国株のリアルタイムローソク足・リアルタイム分時・リアルタイムティックの登録でのみ使用)
optional int32 session = 10; // 米国株のプレ/アフターマーケットおよび夜間取引データを許可するか(米国株のリアルタイムローソク足・リアルタイム分時・リアルタイムティックの登録でのみ使用)。このパラメータ指定時は extendedTime を無視
}
message Request
{
required C2S c2s = 1;
}
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;
}
2
3
4
5
6
7
8
9
10
11
12
13
- API 呼び出し結果,構造は~を参照: 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;
// この API は事前に登録が必要
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;
}
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
}
]
}
}
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、復権タイプ。プッシュ登録かつローソク足タイプの場合のみ有効。他の登録タイプではこのパラメータを無視。ローソク足プッシュ登録時に未指定の場合、デフォルトは前復権
optional bool isFirstPush = 6; //登録後、ローカルに既存データがある場合に初回プッシュするかどうか。未指定の場合はデフォルト true
optional bool isUnsubAll = 7; //現在の接続のすべての登録を一括解除。True に設定すると他のパラメータを無視します。
optional bool isSubOrderBookDetail = 8; //板情報の登録時に使用可能。板情報明細を登録するかどうか。SF相場情報のみ対応。未指定の場合はデフォルト false
optional bool extendedTime = 9; // 米国株プレ/アフターマーケットデータを許可するか(米国株のリアルタイムローソク足・リアルタイム分時・リアルタイムティックの登録でのみ使用)
optional int32 session = 10; // 米国株のプレ/アフターマーケットおよび夜間取引データを許可するか(米国株のリアルタイムローソク足・リアルタイム分時・リアルタイムティックの登録でのみ使用)。このパラメータ指定時は extendedTime を無視
}
message Request
{
required C2S c2s = 1;
}
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;
}
2
3
4
5
6
7
8
9
10
11
12
13
- API 呼び出し結果,構造は~を参照: 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秒後に切断
}
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
2
3
4
5
6
APIレート制限
- 複数のリアルタイムデータタイプの登録に対応しています。SubType を参照してください。銘柄ごとに1タイプの登録で1枠を消費します。
- 登録枠ルール請を参照 登録枠 & 過去ローソク足データ枠。
- 登録後、少なくとも1分経過しないと登録解除できません。
- 香港株 SF 相場情報の板情報はデータ量が大きいため、SF 相場情報の速度と OpenD の処理性能を確保するために、現在 SF 権限ユーザーは同時に50銘柄(HKEX の正株、ワラント、CBBC を含む)の板情報・ブローカーキューのみ登録可能です。残りの登録枠は引き続きティック、売買ブローカーなどの他のタイプの登録に使用できます。
- 香港株オプション先物在 LV1 権限下,不対応登録ティックタイプ。