Basic Functions

• Python
• Proto
• C#
• Java
• C++
• JavaScript

Protocol ID	Protobuf File	Description
1001	InitConnect	Connection Initialization
1002	GetGlobalState	Get Global Status
1003	Notify	Event Notification Callback
1004	KeepAlive	Heartbeat Keep Alive

Set Interface Information(deprecated)

• Python
• Proto
• C#
• Java
• C++
• JavaScript

set_client_info(client_id, client_ver)

• Introduction

  Set calling interface information (unnecessary).

• Parameters

  • client_id: the identification of the client
  • client_ver: the version number of the client

• Example

from futu import *
SysConfig.set_client_info("MyFutuAPI", 0)
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
quote_ctx.close()

from moomoo import *
SysConfig.set_client_info("MymoomooAPI", 0)
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
quote_ctx.close()

InitConnect.proto

message C2S
{
    required int32 clientVer = 1; //Client version number. clientVer = number before "." * 100 + number after ".". For example: clientVer = 1 * 100 + 1 = 101 for version 1.1 , and clientVer = 2 * 100 + 21 = 221 for version 2.21.
    required string clientID = 2; //The unique identifier for client, no specific generation rules, the client can guarantee the uniqueness
    optional bool recvNotify = 3; //Whether this connection receives notifications of market status or events that transaction needs to be re-unlocked. If True, Futu OpenD will push these notifications to this connection, otherwise false means not receiving or pushing
    //If the communication is to be encrypted, you must first configure the RSA key in both Futu OpenD and the client. If it is not configured, it will not be encrypted.
    //It will be encrypted if the RSA key is configured and the specified encryption algorithm is not PacketEncAlgo_None. (Even if it is not set here and the RSA key is configured, the default encryption method will be used), and the FTAES_ECB algorithm is used by default
    optional int32 packetEncAlgo = 4; //Specify the packet encryption algorithm, refer to the enumeration definition of Common.PacketEncAlgo
    optional int32 pushProtoFmt = 5; //Specify the push protocol format on this connection, if not specified, use the push_proto_type configuration item
}

InitConnect.proto

message C2S
{
    required int32 clientVer = 1; //Client version number. clientVer = number before "." * 100 + number after ".". For example: clientVer = 1 * 100 + 1 = 101 for version 1.1 , and clientVer = 2 * 100 + 21 = 221 for version 2.21.
    required string clientID = 2; //The unique identifier for client, no specific generation rules, the client can guarantee the uniqueness
    optional bool recvNotify = 3; //Whether this connection receives notifications of market status or events that transaction needs to be re-unlocked. If True, moomoo OpenD will push these notifications to this connection, otherwise false means not receiving or pushing
    //If the communication is to be encrypted, you must first configure the RSA key in both moomoo OpenD and the client. If it is not configured, it will not be encrypted.
    //It will be encrypted if the RSA key is configured and the specified encryption algorithm is not PacketEncAlgo_None. (Even if it is not set here and the RSA key is configured, the default encryption method will be used), and the FTAES_ECB algorithm is used by default
    optional int32 packetEncAlgo = 4; //Specify the packet encryption algorithm, refer to the enumeration definition of Common.PacketEncAlgo
    optional int32 pushProtoFmt = 5; //Specify the push protocol format on this connection, if not specified, use the push_proto_type configuration item
}

• Introduction

  Set the clientVer and clientID fields in the initial connection protocol.

void SetClientInfo(String clientID, int clientVer);

• Introduction

  Set calling interface information, unnecessary interface

• Parameters

  • clientID: the identification of the client
  • clientVer: the version number of the client

FTAPI_Qot qot = new FTAPI_Qot();
qot.SetClientInfo("FTAPI4NET_Sample", 1); //Set client information

MMAPI_Qot qot = new MMAPI_Qot();
qot.SetClientInfo("MMAPI4NET_Sample", 1); //Set client information

• Example

void setClientInfo(String clientID, int clientVer);

• Introduction

  Set calling interface information, unnecessary interface

• Parameters

  • clientID: the identification of the client
  • clientVer: the version number of the client

• Example

FTAPI_Conn_Qot qot = new FTAPI_Conn_Qot();
qot.setClientInfo("javaclient", 1); //Set client information

• Example

MMAPI_Conn_Qot qot = new MMAPI_Conn_Qot();
qot.setClientInfo("javaclient", 1); //Set client information

void SetClientInfo(const char* szClientID, moomoo::i32_t nClientVer);

• Introduction

  Set calling interface information, unnecessary interface

• Parameters

  • szClientID: the identification of the client
  • nClientVer: client version number

• Example

FTAPI_Qot *m_pQotApi = FTAPI::CreateQotApi();
m_pQotApi->SetClientInfo('cpp', 1);
FTAPI::ReleaseQotApi(m_pQotApi);

• Example

MMAPI_Qot *m_pQotApi = MMAPI::CreateQotApi();
m_pQotApi->SetClientInfo('cpp', 1);
MMAPI::ReleaseQotApi(m_pQotApi);

Set Protocol Format

• Python
• Proto
• C#
• Java
• C++
• JavaScript

set_proto_fmt(proto_fmt)

• Introduction

  Set the communication protocol body format, Protobuf and Json formats are currently supported , default ProtoBuf, unnecessary interface

• Parameters

  • proto_fmt: protocol format, refer to ProtoFMT

• Example

from futu import *
SysConfig.set_proto_fmt(ProtoFMT.Protobuf)
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
quote_ctx.close()

• Example

from moomoo import *
SysConfig.set_proto_fmt(ProtoFMT.Protobuf)
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
quote_ctx.close()

InitConnect.proto

message C2S
{
    required int32 clientVer = 1; //Client version number. clientVer = number before "." * 100 + number after ".". For example: clientVer = 1 * 100 + 1 = 101 for version 1.1 , and clientVer = 2 * 100 + 21 = 221 for version 2.21.
    required string clientID = 2; //The unique identifier for client, no specific generation rules, the client can guarantee the uniqueness
    optional bool recvNotify = 3; //Whether this connection receives notifications of market status or events that transaction needs to be re-unlocked. If True, Futu OpenD will push these notifications to this connection, otherwise false means not receiving or pushing
    //If the communication is to be encrypted, you must first configure the RSA key in both Futu OpenD and the client. If it is not configured, it will not be encrypted.
    //It will be encrypted if the RSA key is configured and the specified encryption algorithm is not PacketEncAlgo_None. (Even if it is not set here and the RSA key is configured, the default encryption method will be used), and the FTAES_ECB algorithm is used by default
    optional int32 packetEncAlgo = 4; //Specify the packet encryption algorithm, refer to the enumeration definition of Common.PacketEncAlgo
    optional int32 pushProtoFmt = 5; //Specify the push protocol format on this connection, if not specified, use the push_proto_type configuration item
}

InitConnect.proto

message C2S
{
    required int32 clientVer = 1; //Client version number. clientVer = number before "." * 100 + number after ".". For example: clientVer = 1 * 100 + 1 = 101 for version 1.1 , and clientVer = 2 * 100 + 21 = 221 for version 2.21.
    required string clientID = 2; //The unique identifier for client, no specific generation rules, the client can guarantee the uniqueness
    optional bool recvNotify = 3; //Whether this connection receives notifications of market status or events that transaction needs to be re-unlocked. If True, moomoo OpenD will push these notifications to this connection, otherwise false means not receiving or pushing
    //If the communication is to be encrypted, you must first configure the RSA key in both moomoo OpenD and the client. If it is not configured, it will not be encrypted.
    //It will be encrypted if the RSA key is configured and the specified encryption algorithm is not PacketEncAlgo_None. (Even if it is not set here and the RSA key is configured, the default encryption method will be used), and the FTAES_ECB algorithm is used by default
    optional int32 packetEncAlgo = 4; //Specify the packet encryption algorithm, refer to the enumeration definition of Common.PacketEncAlgo
    optional int32 pushProtoFmt = 5; //Specify the push protocol format on this connection, if not specified, use the push_proto_type configuration item
}

• Introduction

  The pushProtoFmt field in the initial connection protocol specifies the format of the data pushed on the connection. For the request data format, please refer to the nProtoFmtType field in Protocol header.

Set Protocol Encryption Globally

• Python
• Proto
• C#
• Java
• C++
• JavaScript

Enable_proto_encrypt(is_encrypt)

• Introduction Setting protocol encryption can help users protect their requests and returned contents globally. For more information about Protocol Encryption Process, please check here.

• Parameters

  Parameter	Type	Description
  is_encrypt	bool	Enable encryption or not.

• Example

from futu import *
SysConfig.enable_proto_encrypt(True)
SysConfig.set_init_rsa_file("conn_key.txt")   # rsa private key file path
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
quote_ctx.close()

• Example

from moomoo import *
SysConfig.enable_proto_encrypt(True)
SysConfig.set_init_rsa_file("conn_key.txt")   # rsa private key file path
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
quote_ctx.close()

start(ip, port, ssl, key)

• Introduction

  Initialize connection, connect and initialize

• Parameters

  • ip: WebSocket address listened by Futu OpenD
  • port: the WebSocket port listened by Futu OpenD
  • ssl: Whether to enable SSL encryption, refer to WebSocket related
  • key: The private key of the connection. If it is not set, a connection timeout may occur. The key is configurable in Futu OpenD, and the private key of Visualization Futu OpenD will be randomly specified if it is not set.

• Example

import ftWebSocket from "@/components/ft-websocket/main.js";
class Example {
    example() {
        this.websocket = new ftWebSocket();
        this.websocket.start("127.0.0.1", 33333, true, '123456');
    }
}

• Parameters

  • ip: WebSocket address listened by moomoo OpenD
  • port: the WebSocket port listened by moomoo OpenD
  • ssl: Whether to enable SSL encryption, refer to WebSocket related
  • key: The private key of the connection. If it is not set, a connection timeout may occur. The key is configurable in moomoo OpenD, and the private key of Visualization moomoo OpenD will be randomly specified if it is not set.

• Example

import mmWebSocket from "@/components/mm-websocket/main.js";
class Example {
    example() {
        this.websocket = new ftWebSocket();
        this.websocket.start("127.0.0.1", 33333, true, '123456');
    }
}

Set the Path of Private Key

• Python
• Proto
• C#
• Java
• C++
• JavaScript

set_init_rsa_file(file)

• Introduction

  Set the Path of Private Key in Futu API. For more information about Protocol Encryption Process, please check here.

• Parameters

  Parameter	Type	Description
  file	str	Private key file path.

• Example

from futu import *
SysConfig.enable_proto_encrypt(True)
SysConfig.set_init_rsa_file("conn_key.txt")   # rsa private key file path
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
quote_ctx.close()

• Introduction

  Set the Path of Private Key in moomoo API. For more information about Protocol Encryption Process, please check here.

• Parameters

  Parameter	Type	Description
  file	str	Private key file path.

• Example

from moomoo import *
SysConfig.enable_proto_encrypt(True)
SysConfig.set_init_rsa_file("conn_key.txt")   # rsa private key file path
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
quote_ctx.close()

InitConnect.proto

message C2S
{
    required int32 clientVer = 1; //Client version number. clientVer = number before "." * 100 + number after ".". For example: clientVer = 1 * 100 + 1 = 101 for version 1.1 , and clientVer = 2 * 100 + 21 = 221 for version 2.21.
    required string clientID = 2; //The unique identifier for client, no specific generation rules, the client can guarantee the uniqueness
    optional bool recvNotify = 3; //Whether this connection receives notifications of market status or events that transaction needs to be re-unlocked. If True, Futu OpenD will push these notifications to this connection, otherwise false means not receiving or pushing
    //If the communication is to be encrypted, you must first configure the RSA key in both Futu OpenD and the client. If it is not configured, it will not be encrypted.
    //It will be encrypted if the RSA key is configured and the specified encryption algorithm is not PacketEncAlgo_None. (Even if it is not set here and the RSA key is configured, the default encryption method will be used), and the FTAES_ECB algorithm is used by default
    optional int32 packetEncAlgo = 4; //Specify the packet encryption algorithm, refer to the enumeration definition of Common.PacketEncAlgo
    optional int32 pushProtoFmt = 5; //Specify the push protocol format on this connection, if not specified, use the push_proto_type configuration item
}

InitConnect.proto

message C2S
{
    required int32 clientVer = 1; //Client version number. clientVer = number before "." * 100 + number after ".". For example: clientVer = 1 * 100 + 1 = 101 for version 1.1 , and clientVer = 2 * 100 + 21 = 221 for version 2.21.
    required string clientID = 2; //The unique identifier for client, no specific generation rules, the client can guarantee the uniqueness
    optional bool recvNotify = 3; //Whether this connection receives notifications of market status or events that transaction needs to be re-unlocked. If True, moomoo OpenD will push these notifications to this connection, otherwise false means not receiving or pushing
    //If the communication is to be encrypted, you must first configure the RSA key in both moomoo OpenD and the client. If it is not configured, it will not be encrypted.
    //It will be encrypted if the RSA key is configured and the specified encryption algorithm is not PacketEncAlgo_None. (Even if it is not set here and the RSA key is configured, the default encryption method will be used), and the FTAES_ECB algorithm is used by default
    optional int32 packetEncAlgo = 4; //Specify the packet encryption algorithm, refer to the enumeration definition of Common.PacketEncAlgo
    optional int32 pushProtoFmt = 5; //Specify the push protocol format on this connection, if not specified, use the push_proto_type configuration item
}

• Introduction

  The packetEncAlgo field in the initialization connection protocol specifies the encryption algorithm of the connection. For details of protocol encryption, refer to Encrypted Communication Process.

void SetRSAPrivateKey(string key)

• Introduction

  Set the Path of Private Key in Futu API. For more information about Protocol Encryption Process, please check here.

• Parameters

  • key: private key content

• Example

public class Program : FTSPI_Qot, FTSPI_Conn {
    FTAPI_Qot qot = new FTAPI_Qot();

    public Program() {
        qot.SetClientInfo("csharp", 1); //Set client information
        qot.SetConnCallback(this); //Set connection callback
        qot.SetQotCallback(this); //Set transaction callback
        qot.SetRSAPrivateKey(System.IO.File.ReadAllText(@"d:\rsa1024", Encoding.UTF8)); //Set rsa key
    }

    public void Start() {
        qot.InitConnect("127.0.0.1", (ushort)11111, true); //Connection encryption
    }

    
    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);
    }
}

• Introduction

  Set the Path of Private Key in moomoo API. For more information about Protocol Encryption Process, please check here.

• Parameters

  • key: private key content

• Example

public class Program : MMSPI_Qot, MMSPI_Conn {
    MMAPI_Qot qot = new MMAPI_Qot();

    public Program() {
        qot.SetClientInfo("csharp", 1); //Set client information
        qot.SetConnCallback(this); //Set connection callback
        qot.SetQotCallback(this); //Set transaction callback
        qot.SetRSAPrivateKey(System.IO.File.ReadAllText(@"d:\rsa1024", Encoding.UTF8)); //Set rsa key
    }

    public void Start() {
        qot.InitConnect("127.0.0.1", (ushort)11111, true); //Connection encryption
    }

    
    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);
    }
}

• Output

Qot onInitConnect: ret=0 desc= connID=6827935070720340213
Send QotSub: 3
Reply: QotSub: 3  retType: 0
retMsg: ""
errCode: 0

void setRSAPrivateKey(String key)

• Introduction

  Set the Path of Private Key in Futu API. For more information about Protocol Encryption Process, please check here.

• Parameters

  • key: private key content

• Example

public class QotDemo implements FTSPI_Qot, FTSPI_Conn {
    FTAPI_Conn_Qot qot = new FTAPI_Conn_Qot();

    public QotDemo() {
        qot.setClientInfo("javaclient", 1); //Set client information
        qot.setConnSpi(this); //Set connection callback
    }

    public void start() throws IOException {
        String rsaKey = "";
        byte[] buf = java.nio.file.Files.readAllBytes(Paths.get("c:\\rsa1024"));
        rsaKey = new String(buf, Charset.forName("UTF-8"));
        qot.setRSAPrivateKey(rsaKey);
    }

    public static void main(String[] args) throws IOException {
        FTAPI.init();
        QotDemo qot = new QotDemo();
        qot.start();

        while (true) {
            try {
                Thread.sleep(1000 * 600);
            } catch (InterruptedException exc) {

            }
        }
    }
}

• Introduction

  Set the Path of Private Key in moomoo API. For more information about Protocol Encryption Process, please check here.

• Parameters

  • key: private key content

• Example

public class QotDemo implements MMSPI_Qot, MMSPI_Conn {
    MMAPI_Conn_Qot qot = new FTAPI_Conn_Qot();

    public QotDemo() {
        qot.setClientInfo("javaclient", 1); //Set client information
        qot.setConnSpi(this); //Set connection callback
    }

    public void start() throws IOException {
        String rsaKey = "";
        byte[] buf = java.nio.file.Files.readAllBytes(Paths.get("c:\\rsa1024"));
        rsaKey = new String(buf, Charset.forName("UTF-8"));
        qot.setRSAPrivateKey(rsaKey);
    }

    public static void main(String[] args) throws IOException {
        MMAPI.init();
        QotDemo qot = new QotDemo();
        qot.start();

        while (true) {
            try {
                Thread.sleep(1000 * 600);
            } catch (InterruptedException exc) {

            }
        }
    }
}

void SetRSAPrivateKey(const char* szRSAPrivateKey);

• Introduction

  Set the Path of Private Key in Futu API. For more information about Protocol Encryption Process, please check here.

• Parameters

  • strRSAPrivateKey: private key content

• Example

string strKey;
ifstream file("key");
file >> strKey;
file.close();
FTAPI_Qot *m_pQotApi = FTAPI::CreateQotApi();
m_pQotApi->SetRSAPrivateKey(strKey.c_str());
m_pQotApi->InitConnect("127.0.0.1", 11111, true);
FTAPI::ReleaseQotApi(m_pQotApi);

• Introduction

  Set the Path of Private Key in moomoo API. For more information about Protocol Encryption Process, please check here.

• Parameters

  • strRSAPrivateKey: private key content

• Example

string strKey;
ifstream file("key");
file >> strKey;
file.close();
MMAPI_Qot *m_pQotApi = MMAPI::CreateQotApi();
m_pQotApi->SetRSAPrivateKey(strKey.c_str());
m_pQotApi->InitConnect("127.0.0.1", 11111, true);
MMAPI::ReleaseQotApi(m_pQotApi);

start(ip, port, ssl, key)

• Introduction

  Initialize connection, connect and initialize

• Parameters

  • ip: WebSocket address listened by Futu OpenD
  • port: the WebSocket port listened by Futu OpenD
  • ssl: Whether to enable SSL encryption, refer to WebSocket related
  • key: The private key of the connection. If it is not set, a connection timeout may occur. The key is configurable in Futu OpenD, and the Visualization Futu OpenD will be randomly assigned if it is not specified.

• Example

import ftWebSocket from "@/components/ft-websocket/main.js";
class Example {
    example() {
        this.websocket = new ftWebSocket();
        this.websocket.start("127.0.0.1", 33333, true, '123456');
    }
}

• Parameters

  • ip: WebSocket address listened by moomoo OpenD
  • port: the WebSocket port listened by moomoo OpenD
  • ssl: Whether to enable SSL encryption, refer to WebSocket related
  • key: The private key of the connection. If it is not set, a connection timeout may occur. The key is configurable in moomoo OpenD, and the Visualization moomoo OpenD will be randomly assigned if it is not specified.

• Example

import ftWebSocket from "@/components/mm-websocket/main.js";
class Example {
    example() {
        this.websocket = new mmWebSocket();
        this.websocket.start("127.0.0.1", 33333, true, '123456');
    }
}

Set Thread Mode

• Python
• Proto
• C#
• Java
• C++
• JavaScript

set_all_thread_daemon(all_daemon)

• Introduction Whether to set all internally threads to be daemon threads.

  • If it is set to be daemon threads, then after the main thread exits, the process also exits.
    For example, when using the real-time callback API, you need to make sure the main thread survives by yourself. Otherwise, when the main thread exits, the process also exits and you will no longer receive the push data.
  • If it is set to a non-daemon thread, the process will not exit after the main thread exits. For example, if you do not call close() to close the connection after creating a quote or trade object, the process will not exit even if the main thread exits.

• Parameters

  Parameter	Type	Description
  all_daemon	bool	Whether to set threads to be daemon threads. True：set to daemon threads False：set to non-daemon threads Default is False

• Example

from futu import *
SysConfig.set_all_thread_daemon(True)
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
# the process will exit without calling quote_ctx.close(), 

• Example

from moomoo import *
SysConfig.set_all_thread_daemon(True)
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
# the process will exit without calling quote_ctx.close(), 

Set Callback

• Python
• Proto
• C#
• Java
• C++
• JavaScript

set_handler(handler)

• Introduction

  Set asynchronous callback processing object

• Parameters

  • handler: callback processing object

    Class	Description
    SysNotifyHandlerBase	Futu OpenD notification processing base class
    StockQuoteHandlerBase	Quote processing base class
    OrderBookHandlerBase	Order book processing base class
    CurKlineHandlerBase	Real-time candlestick processing base class
    TickerHandlerBase	Tick-By-Tick processing base class
    RTDataHandlerBase	Time Frame data processing base class
    BrokerHandlerBase	Broker queue processing base class
    PriceReminderHandlerBase	Price reminder processing base class
    TradeOrderHandlerBase	Order processing base class
    TradeDealHandlerBase	Order fill processing base class

• 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's own processing logic
        return RET_OK, data
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
handler = OrderBookTest()
quote_ctx.set_handler(handler) # Setting real-time order book callback
quote_ctx.subscribe(['HK.00700'], [SubType.ORDER_BOOK]) # Subscribe to the order book type, OpenD starts to receive pushed data from the server continuously
time.sleep(15) # Set the script to receive OpenD push duration to 15 seconds
quote_ctx.close() # Close the current connection, OpenD will automatically cancel the subscription of the corresponding stock in 1 minute

• Parameters

  • handler: callback processing object

    Class	Description
    SysNotifyHandlerBase	moomoo OpenD notification processing base class
    StockQuoteHandlerBase	Quote processing base class
    OrderBookHandlerBase	Order book processing base class
    CurKlineHandlerBase	Real-time candlestick processing base class
    TickerHandlerBase	Tick-By-Tick processing base class
    RTDataHandlerBase	Time Frame data processing base class
    BrokerHandlerBase	Broker queue processing base class
    PriceReminderHandlerBase	Price reminder processing base class
    TradeOrderHandlerBase	Order processing base class
    TradeDealHandlerBase	Order fill processing base class

• 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's own processing logic
        return RET_OK, data
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
handler = OrderBookTest()
quote_ctx.set_handler(handler) # Setting real-time order book callback
quote_ctx.subscribe(['HK.00700'], [SubType.ORDER_BOOK]) # Subscribe to the order book type, OpenD starts to receive pushed data from the server continuously
time.sleep(15) # Set the script to receive OpenD push duration to 15 seconds
quote_ctx.close() # Close the current connection, OpenD will automatically cancel the subscription of the corresponding stock in 1 minute

void SetConnCallback(FTSPI_Conn connCallback)
void SetQotCallback(FTSPI_Qot callback)
void SetTrdCallback(FTSPI_Trd callback)

• Introduction

  Callback setting

• Parameters

  • callback: callback function

• Example

public class Program: FTSPI_Qot, FTSPI_Conn
    {
        FTAPI_Qot qot = new FTAPI_Qot();

        public Program()
        {
            qot.SetClientInfo("csharp", 1); //Set client information
            qot.SetConnCallback(this); //Set connection callback
            qot.SetQotCallback(this); //Set transaction callback
        }

        public void Start()
        {
            qot.InitConnect("127.0.0.1", (ushort)11111, false); //Connection encryption
        }


        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;
        }


        public void OnDisconnect(FTAPI_Conn client, long errCode)
        {
            Console.Write("Qot onDisConnect: {0}\n", errCode);
        }


        public static void Main(String[] args)
        {
            FTAPI.Init();
            Program qot = new Program();
            qot.Start();


            while (true)
                Thread.Sleep(1000 * 600);
        }
    }

void SetConnCallback(MMSPI_Conn connCallback)
void SetQotCallback(MMSPI_Qot callback)
void SetTrdCallback(MMSPI_Trd callback)

• Introduction

  Callback setting

• Parameters

  • callback: callback function

• Example

public class Program: MMSPI_Qot, MMSPI_Conn
    {
        MMAPI_Qot qot = new MMAPI_Qot();

        public Program()
        {
            qot.SetClientInfo("csharp", 1); //Set client information
            qot.SetConnCallback(this); //Set connection callback
            qot.SetQotCallback(this); //Set transaction callback
        }

        public void Start()
        {
            qot.InitConnect("127.0.0.1", (ushort)11111, false); //Connection encryption
        }


        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;
        }


        public void OnDisconnect(MMAPI_Conn client, long errCode)
        {
            Console.Write("Qot onDisConnect: {0}\n", errCode);
        }


        public static void Main(String[] args)
        {
            MMAPI.Init();
            Program qot = new Program();
            qot.Start();


            while (true)
                Thread.Sleep(1000 * 600);
        }
    }

• Output

Qot onInitConnect: ret=0 desc= connID=6827937191858660334

setConnSpi(FTSPI_Conn callback);
void setQotSpi(FTSPI_Qot callback);
void setTrdSpi(FTSPI_Trd callback);

• Introduction

  Callback setting

• Parameters

  • callback: callback function

• Example

public class QotDemo implements FTSPI_Qot, FTSPI_Conn {
    FTAPI_Conn_Qot qot = new FTAPI_Conn_Qot();

    public QotDemo() {
        qot.setClientInfo("javaclient", 1); //Set client information
        qot.setConnSpi(this); //Set connection callback
        qot.setQotSpi(this); //Set the market callback
    }

    public void start() throws IOException {
        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());
    }

    @Override
    public void onDisconnect(FTAPI_Conn client, long errCode) {
        System.out.printf("Qot onDisConnect: %d\n", errCode);
    }

    public static void main(String[] args) throws IOException {
        FTAPI.init();
        QotDemo qot = new QotDemo();
        qot.start();

        while (true) {
            try {
                Thread.sleep(1000 * 600);
            } catch (InterruptedException exc) {

            }
        }
    }
}

setConnSpi(MMSPI_Conn callback);
void setQotSpi(MMSPI_Qot callback);
void setTrdSpi(MMSPI_Trd callback);

• Introduction

  Callback setting

• Parameters

  • callback: callback function

• Example

public class QotDemo implements MMSPI_Qot, MMSPI_Conn {
    MMAPI_Conn_Qot qot = new MMAPI_Conn_Qot();

    public QotDemo() {
        qot.setClientInfo("javaclient", 1); //Set client information
        qot.setConnSpi(this); //Set connection callback
        qot.setQotSpi(this); //Set the market callback
    }

    public void start() throws IOException {
        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());
    }

    @Override
    public void onDisconnect(MMAPI_Conn client, long errCode) {
        System.out.printf("Qot onDisConnect: %d\n", errCode);
    }

    public static void main(String[] args) throws IOException {
        MMAPI.init();
        QotDemo qot = new QotDemo();
        qot.start();

        while (true) {
            try {
                Thread.sleep(1000 * 600);
            } catch (InterruptedException exc) {

            }
        }
    }
}

void RegisterConnSpi(FTSPI_Qot* pSpi);
void RegisterQotSpi(FTSPI_Qot* pSpi);
void RegisterTrdSpi(FTSPI_Qot* pSpi);

• Introduction

  Callback setting

• Parameters

  • pSpi: callback function

• Example

FTAPI_Qot *m_pQotApi = FTAPI::CreateQotApi();
m_pQotApi->InitConnect("127.0.0.1", 11111, false);
m_pQotApi->RegisterQotSpi(this);
m_pQotApi->RegisterConnSpi(this);
FTAPI::ReleaseQotApi(m_pQotApi);

void RegisterConnSpi(MMSPI_Qot* pSpi);
void RegisterQotSpi(MMSPI_Qot* pSpi);
void RegisterTrdSpi(MMSPI_Qot* pSpi);

• Introduction

  Callback setting

• Parameters

  • pSpi: callback function

• Example

MMAPI_Qot *m_pQotApi = MMAPI::CreateQotApi();
m_pQotApi->InitConnect("127.0.0.1", 11111, false);
m_pQotApi->RegisterQotSpi(this);
m_pQotApi->RegisterConnSpi(this);
MMAPI::ReleaseQotApi(m_pQotApi);

onPush(cmd, res)
onlogin(ret, msg)

• Introduction

  Login callback and push callback

• Return

  • cmd: Pushed protocol ID
  • res: Pushed agreement content
  • ret: whether the initialization is successful
  • msg: failure description

• Example

import ftWebSocket from "@/components/ft-websocket/main.js";
class Example {
    example() {
        this.websocket = new ftWebSocket();
        this.websocket.start("127.0.0.1", 33333, false, null);
        this.websocket.onPush = this.onPush.bind(this);
        this.websocket.onlogin = this.onLogin.bind(this);
    },
    onPush(cmd, res) {
    const obj = ftWebSocket.findCmdObj(cmd);
        if (obj && obj.description) {
            console.log(res);
        }
    },
    onLogin(ret, msg) {
        if (ret) {
            console.log(this.websocket.getConnID());
        }
    }
}

• Example

import mmWebSocket from "@/components/mm-websocket/main.js";
class Example {
    example() {
        this.websocket = new mmWebSocket();
        this.websocket.start("127.0.0.1", 33333, false, null);
        this.websocket.onPush = this.onPush.bind(this);
        this.websocket.onlogin = this.onLogin.bind(this);
    },
    onPush(cmd, res) {
    const obj = ftWebSocket.findCmdObj(cmd);
        if (obj && obj.description) {
            console.log(res);
        }
    },
    onLogin(ret, msg) {
        if (ret) {
            console.log(this.websocket.getConnID());
        }
    }
}

Get Connection ID

• Python
• Proto
• C#
• Java
• C++
• JavaScript

get_sync_conn_id()

• Introduction

  Get the connection ID, the value will be available after the connection is successfully initialized

• Return

  • conn_id: connection ID

• Example

from futu import *
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
quote_ctx.get_sync_conn_id()
quote_ctx.close() # After using the connection, remember to close it to prevent the number of connections from running out

• Example

from moomoo import *
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
quote_ctx.get_sync_conn_id()
quote_ctx.close() # After using the connection, remember to close it to prevent the number of connections from running out

InitConnect.proto

message S2C
{
    required int32 serverVer = 1; //Futu OpenD version number
    required uint64 loginUserID = 2; //Futu OpenD login user ID
    required uint64 connID = 3; //The connection ID of this connection, the unique identifier of the connection
    required string connAESKey = 4; //The key for subsequent AES encrypted communication of this connection is fixed as a 16-byte long string
    required int32 keepAliveInterval = 5; //Heartbeat keepalive interval
    optional string aesCBCiv = 6; //The iv of AES encrypted communication CBC encryption mode is fixed as a 16-byte long string
}

message S2C
{
    required int32 serverVer = 1; //moomoo OpenD version number
    required uint64 loginUserID = 2; //moomoo OpenD login user ID
    required uint64 connID = 3; //The connection ID of this connection, the unique identifier of the connection
    required string connAESKey = 4; //The key for subsequent AES encrypted communication of this connection is fixed as a 16-byte long string
    required int32 keepAliveInterval = 5; //Heartbeat keepalive interval
    optional string aesCBCiv = 6; //The iv of AES encrypted communication CBC encryption mode is fixed as a 16-byte long string
}

• Introduction

  The connID field in the InitConnect protocol return packet

uint GetConnectID();

• Introduction

  Get the connection ID, the value will be available after the connection is successfully initialized

• Return

  • connID: connection ID

• Example

public class Program : FTSPI_Qot, FTSPI_Conn
    {
        FTAPI_Qot qot = new FTAPI_Qot();

        public Program()
        {
            qot.SetClientInfo("csharp", 1); //Set client information
            qot.SetConnCallback(this); //Set connection callback
            qot.SetQotCallback(this); //Set transaction callback
        }

        public void Start()
        {
            qot.InitConnect("127.0.0.1", (ushort)11111, false); //Connection encryption
        }


        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;
        }


        public void OnDisconnect(FTAPI_Conn client, long errCode)
        {
            Console.Write("Qot onDisConnect: {0}\n", errCode);
        }

        public static void Main(String[] args)
        {
            FTAPI.Init();
            Program qot = new Program();
            qot.Start();


            while (true)
                Thread.Sleep(1000 * 600);
        }
    }

• Example

public class Program : MMSPI_Qot, MMSPI_Conn
    {
        MMAPI_Qot qot = new MMAPI_Qot();

        public Program()
        {
            qot.SetClientInfo("csharp", 1); //Set client information
            qot.SetConnCallback(this); //Set connection callback
            qot.SetQotCallback(this); //Set transaction callback
        }

        public void Start()
        {
            qot.InitConnect("127.0.0.1", (ushort)11111, false); //Connection encryption
        }


        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;
        }


        public void OnDisconnect(MMAPI_Conn client, long errCode)
        {
            Console.Write("Qot onDisConnect: {0}\n", errCode);
        }

        public static void Main(String[] args)
        {
            MMAPI.Init();
            Program qot = new Program();
            qot.Start();


            while (true)
                Thread.Sleep(1000 * 600);
        }
    }

• Output

Qot onInitConnect: ret=0 desc= connID=6827937791149892052

long getConnectID();

• Introduction

  Get the connection ID, the value will be available after the connection is successfully initialized

• Return

  • connID: connection ID

• Example

public class QotDemo implements FTSPI_Qot, FTSPI_Conn {
    FTAPI_Conn_Qot qot = new FTAPI_Conn_Qot();

    public QotDemo() {
        qot.setClientInfo("javaclient", 1); //Set client information
        qot.setConnSpi(this); //Set connection callback
        qot.setQotSpi(this); //Set the market callback
    }

    public void start() throws IOException {
        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());
    }

    @Override
    public void onDisconnect(FTAPI_Conn client, long errCode) {
        System.out.printf("Qot onDisConnect: %d\n", errCode);
    }

    public static void main(String[] args) throws IOException {
        FTAPI.init();
        QotDemo qot = new QotDemo();
        qot.start();

        while (true) {
            try {
                Thread.sleep(1000 * 60);
            } catch (InterruptedException exc) {

            }
        }
    }
}

• Example

public class QotDemo implements MMSPI_Qot, MMSPI_Conn {
    MMAPI_Conn_Qot qot = new MMAPI_Conn_Qot();

    public QotDemo() {
        qot.setClientInfo("javaclient", 1); //Set client information
        qot.setConnSpi(this); //Set connection callback
        qot.setQotSpi(this); //Set the market callback
    }

    public void start() throws IOException {
        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());
    }

    @Override
    public void onDisconnect(MMAPI_Conn client, long errCode) {
        System.out.printf("Qot onDisConnect: %d\n", errCode);
    }

    public static void main(String[] args) throws IOException {
        MMAPI.init();
        QotDemo qot = new QotDemo();
        qot.start();

        while (true) {
            try {
                Thread.sleep(1000 * 60);
            } catch (InterruptedException exc) {

            }
        }
    }
}

Futu::u64_t GetConnectID()

• Introduction

  Get the connection ID, the value will be available after the connection is successfully initialized

• Return

  • nConnID: Connection ID

• Example

FTAPI_Qot *m_pQotApi = FTAPI::CreateQotApi();
m_pQotApi->InitConnect("127.0.0.1", 11111, false);
m_pQotApi->GetConnectID();
FTAPI::ReleaseQotApi(m_pQotApi);

moomoo::u64_t GetConnectID()

• Introduction

  Get the connection ID, the value will be available after the connection is successfully initialized

• Return

  • nConnID: Connection ID

• Example

MMAPI_Qot *m_pQotApi = MMAPI::CreateQotApi();
m_pQotApi->InitConnect("127.0.0.1", 11111, false);
m_pQotApi->GetConnectID();
MMAPI::ReleaseQotApi(m_pQotApi);

getConnID()

• Introduction

  Get the connection ID, the value will be available after the connection is successfully initialized

• Return

  • connID: connection ID

• Example

import ftWebSocket from "@/components/ft-websocket/main.js";
class Example {
    example() {
        this.websocket = new ftWebSocket();
        this.websocket.start("127.0.0.1", 33333, false, null);
        this.websocket.onlogin = this.onLogin.bind(this);
    },
    onLogin(ret, msg) {
    if (ret) {
        this.websocket.getConnID();
    }
}

• Example

import mmWebSocket from "@/components/mm-websocket/main.js";
class Example {
    example() {
        this.websocket = new mmWebSocket();
        this.websocket.start("127.0.0.1", 33333, false, null);
        this.websocket.onlogin = this.onLogin.bind(this);
    },
    onLogin(ret, msg) {
    if (ret) {
        this.websocket.getConnID();
    }
}

Event Notification Callback

• Python
• Proto
• C#
• Java
• C++
• JavaScript

SysNotifyHandlerBase

• Introduction

  Notify Futu OpenD of some important news, such as disconnection, etc.

• Introduction

  Notify moomoo OpenD of some important news, such as disconnection, etc.

• Protocol ID

  1003

• Return

  Parameter	Type	Description
  ret	int	Returned value. On success, ret == RET_OK. On error, ret != RET_OK.
  data	tuple	If ret == RET_OK, event notification data is returned.
  	str	If ret != RET_OK, error description is returned.

  • The format of event notification data is as follows:

    
    

    Parameter	Type	Description
    notify_type	SysNotifyType	Notification data type
    sub_type	ProgramStatusType	Subtype. If notify_type == SysNotifyType.PROGRAM_STATUS, program status type is returned.
    	GtwEventType	Subtype. If notify_type == SysNotifyType.GTW_EVENT, OpenD event type is returned.
    	0	If notify_type !=SysNotifyType.PROGRAM_STATUS and notify_type !=SysNotifyType.GTW_EVENT, no useful information is returned.
    msg	dict	Event information. If notify_type == SysNotifyType.CONN_STATUS, connection status event information is returned.
    		Event information. If notify_type == SysNotifyType.QOT_RIGHT, quote right event information is returned.

    • The format of connection status event information is as follows(The value of connection status is a bool type, with True for normal, and False for disconnected):

      {
          'qot_logined': bool1, 
          'trd_logined': bool2,
      }
      

    • The format of quote right event information is as follows(the type of quote right refers to Quote Right):

      {
          'hk_qot_right': value1,
          'hk_option_qot_right': value2,
          'hk_future_qot_right': value3,
          'us_qot_right': value4,
          'us_option_qot_right': value5,
          'us_future_qot_right': value6,  // deprecated
          'cn_qot_right': value7,
      	'us_index_qot_right': value8,
      	'us_otc_qot_right': value9,
      	'sg_future_qot_right': value10,
      	'jp_future_qot_right': value11,
      	'us_future_qot_right_cme': value12,
      	'us_future_qot_right_cbot': value13,
      	'us_future_qot_right_nymex': value14,
      	'us_future_qot_right_comex': value15,
      	'us_future_qot_right_cboe': value16,
      }
      

• Example

import time
from futu import *

class SysNotifyTest(SysNotifyHandlerBase):
    def on_recv_rsp(self, rsp_str):
        ret_code, data = super(SysNotifyTest, self).on_recv_rsp(rsp_str)
        notify_type, sub_type, msg = data
        if ret_code != RET_OK:
            logger.debug("SysNotifyTest: error, msg: {}".format(msg))
            return RET_ERROR, data
        if (notify_type == SysNotifyType.GTW_EVENT):  #  Futu OpenD event notification
            print("GTW_EVENT, type: {} msg: {}".format(sub_type, msg))
        elif (notify_type == SysNotifyType.PROGRAM_STATUS):  # Notification of change in program status
            print("PROGRAM_STATUS, type: {} msg: {}".format(sub_type, msg))
        elif (notify_type == SysNotifyType.CONN_STATUS):  ## Notification of change in connection status
            print("CONN_STATUS, qot: {}".format(msg['qot_logined']))
            print("CONN_STATUS, trd: {}".format(msg['trd_logined']))
        elif (notify_type == SysNotifyType.QOT_RIGHT):  # Notification of change in quote right
            print("QOT_RIGHT, hk: {}".format(msg['hk_qot_right']))
            print("QOT_RIGHT, hk_option: {}".format(msg['hk_option_qot_right']))
            print("QOT_RIGHT, hk_future: {}".format(msg['hk_future_qot_right']))
            print("QOT_RIGHT, us: {}".format(msg['us_qot_right']))
            print("QOT_RIGHT, us_option: {}".format(msg['us_option_qot_right']))
            print("QOT_RIGHT, us_future: {}".format(msg['us_future_qot_right']))
            print("QOT_RIGHT, cn: {}".format(msg['cn_qot_right']))
            print("QOT_RIGHT, us_index: {}".format(msg['us_index_qot_right']))
			print("QOT_RIGHT, us_otc: {}".format(msg['us_otc_qot_right']))
			print("QOT_RIGHT, sg_future: {}".format(msg['sg_future_qot_right']))
			print("QOT_RIGHT, jp_future: {}".format(msg['jp_future_qot_right']))
            print("QOT_RIGHT, us_future_cme: {}".format(msg['us_future_qot_right_cme']))
            print("QOT_RIGHT, us_future_cbot: {}".format(msg['us_future_qot_right_cbot']))
            print("QOT_RIGHT, us_future_nymex: {}".format(msg['us_future_qot_right_nymex']))
            print("QOT_RIGHT, us_future_comex: {}".format(msg['us_future_qot_right_comex']))
            print("QOT_RIGHT, us_future_cboe: {}".format(msg['us_future_qot_right_cboe']))
        return RET_OK, data

quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
handler = SysNotifyTest()
quote_ctx.set_handler(handler)   # Set real-time swing callback
time.sleep(15)  # Set the script to receive Futu OpenD push duration to 15 seconds
quote_ctx.close()  # After using the connection, remember to close it to prevent the number of connections from running out

• Example

import time
from moomoo import *

class SysNotifyTest(SysNotifyHandlerBase):
    def on_recv_rsp(self, rsp_str):
        ret_code, data = super(SysNotifyTest, self).on_recv_rsp(rsp_str)
        notify_type, sub_type, msg = data
        if ret_code != RET_OK:
            logger.debug("SysNotifyTest: error, msg: {}".format(msg))
            return RET_ERROR, data
        if (notify_type == SysNotifyType.GTW_EVENT):  #  moomoo OpenD event notification
            print("GTW_EVENT, type: {} msg: {}".format(sub_type, msg))
        elif (notify_type == SysNotifyType.PROGRAM_STATUS):  # Notification of change in program status
            print("PROGRAM_STATUS, type: {} msg: {}".format(sub_type, msg))
        elif (notify_type == SysNotifyType.CONN_STATUS):  ## Notification of change in connection status
            print("CONN_STATUS, qot: {}".format(msg['qot_logined']))
            print("CONN_STATUS, trd: {}".format(msg['trd_logined']))
        elif (notify_type == SysNotifyType.QOT_RIGHT):  # Notification of change in quote right
            print("QOT_RIGHT, hk: {}".format(msg['hk_qot_right']))
            print("QOT_RIGHT, hk_option: {}".format(msg['hk_option_qot_right']))
            print("QOT_RIGHT, hk_future: {}".format(msg['hk_future_qot_right']))
            print("QOT_RIGHT, us: {}".format(msg['us_qot_right']))
            print("QOT_RIGHT, us_option: {}".format(msg['us_option_qot_right']))
            print("QOT_RIGHT, us_future: {}".format(msg['us_future_qot_right']))
            print("QOT_RIGHT, cn: {}".format(msg['cn_qot_right']))
            print("QOT_RIGHT, us_index: {}".format(msg['us_index_qot_right']))
			print("QOT_RIGHT, us_otc: {}".format(msg['us_otc_qot_right']))
			print("QOT_RIGHT, sg_future: {}".format(msg['sg_future_qot_right']))
			print("QOT_RIGHT, jp_future: {}".format(msg['jp_future_qot_right']))
            print("QOT_RIGHT, us_future_cme: {}".format(msg['us_future_qot_right_cme']))
            print("QOT_RIGHT, us_future_cbot: {}".format(msg['us_future_qot_right_cbot']))
            print("QOT_RIGHT, us_future_nymex: {}".format(msg['us_future_qot_right_nymex']))
            print("QOT_RIGHT, us_future_comex: {}".format(msg['us_future_qot_right_comex']))
            print("QOT_RIGHT, us_future_cboe: {}".format(msg['us_future_qot_right_cboe']))
        return RET_OK, data

quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
handler = SysNotifyTest()
quote_ctx.set_handler(handler)   # Set real-time swing callback
time.sleep(15)  # Set the script to receive moomoo OpenD push duration to 15 seconds
quote_ctx.close()  # After using the connection, remember to close it to prevent the number of connections from running out

Notify.proto

message S2C
{
    required int32 type = 1; //Notification type
    optional GtwEvent event = 2; //Event information
    optional ProgramStatus programStatus = 3; //Program status
    optional ConnectStatus connectStatus = 4; //Connection status
    optional QotRight qotRight = 5; //Quotation authority
    optional APILevel apiLevel = 6; //User level, which has been deprecated after version 2.10
    optional APIQuota apiQuota = 7; //API quota
}

message Response
{
    required int32 retType = 1 [default = -400]; //RetType, return result
	optional string retMsg = 2;
	optional int32 errCode = 3;
	
	optional S2C s2c = 4;
}

void OnReply_Notify(FTAPI_Conn client, uint nSerialNo, Notify.Response rsp)

• Introduction

  Notify OpenD of some important information, such as disconnection, etc.

void onPush_Notify(FTAPI_Conn client, Notify.Response rsp)

• Introduction

  Notify OpenD of some important information, such as disconnection, etc.

virtual void OnPush_Notify(const Notify::Response &stRsp) = 0;

• Introduction

  Notify OpenD of some important information, such as disconnection, etc.

onPush(cmd, res)

• Introduction

  Notify OpenD of some important information, such as disconnection, etc.

• Example

import ftWebSocket from "@/components/ft-websocket/main.js";
class Example {
    example() {
        this.websocket = new ftWebSocket();
        this.websocket.start("127.0.0.1", 33333, false, null);
        this.websocket.onPush = this.onPush.bind(this);
        this.websocket.onlogin = this.onLogin.bind(this);
    },
    onPush(cmd, res) {
    const obj = ftWebSocket.findCmdObj(cmd);
        if (obj && obj.description && cmd == 1003) {
            console.log(res);
        }
    },
    onLogin(ret, msg) {
        if (ret) {
            console.log(this.websocket.getConnID());
        }
    }
}

• Example

import mmWebSocket from "@/components/mm-websocket/main.js";
class Example {
    example() {
        this.websocket = new ftWebSocket();
        this.websocket.start("127.0.0.1", 33333, false, null);
        this.websocket.onPush = this.onPush.bind(this);
        this.websocket.onlogin = this.onLogin.bind(this);
    },
    onPush(cmd, res) {
    const obj = mmWebSocket.findCmdObj(cmd);
        if (obj && obj.description && cmd == 1003) {
            console.log(res);
        }
    },
    onLogin(ret, msg) {
        if (ret) {
            console.log(this.websocket.getConnID());
        }
    }
}