# Subscribe Event Contract

Python
Proto
C#
Java
C++
JavaScript

subscribe_event_contract(code_list, subtype_list, kline_source_list=None, is_first_push=True, subscribe_push=True)

Description

Subscribe to real-time market data push for event contracts. After a successful subscription, order book, K-line, and ticker data are returned in real time via push callbacks. You must register a handler of the corresponding type via set_handler before receiving push data.

Parameters

Parameter	Type	Description
code_list	list	List of event contract codes, e.g. `['EC.KXODIMATCH-26JUL140600INDENG-IND']`
subtype_list	SubType	List of subscription types
kline_source_list	ECKlineSource	Optional, list of K-line sources. Effective when subscribing to K-line types, defaults to None which means contract-level trade-price K-line
is_first_push	bool	Whether to push existing data once right after subscription, defaults to True
subscribe_push	bool	Whether to register for push, defaults to True

Return

Parameter Type Description

ret RET_CODE API call result

err_message str When ret == RET_OK, returns None; when ret != RET_OK, returns an error description
Example

Parameter	Type	Description
ret	RET_CODE	API call result
err_message	str	When ret == RET_OK, returns None; when ret != RET_OK, returns an error description

from futu import *

quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)

# Subscribe: Day K + Ticker + Order Book
ret, err = quote_ctx.subscribe_event_contract(
    ['EC.KXODIMATCH-26JUL140600INDENG-IND'],
    [SubType.K_DAY, SubType.TICKER, SubType.ORDER_BOOK]
)
if ret == RET_OK:
    print('subscribe success')
else:
    print('subscribe failed:', err)

# To receive push, register handlers via set_handler and keep the connection running
quote_ctx.close()

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

Output

subscribe success

On success err is None. After a successful subscription, the corresponding K-line/ticker/order book pushes will trigger the registered handler callbacks (see the output examples in the push documentation).

# Qot_SubEventContract.proto

Description

Subscribe/unsubscribe real-time market data push for event contracts.
Parameters

// Event contract subscribe/unsubscribe
message C2S
{
	repeated Qot_Common.Security securityList = 1;       // Contract underlying (market+code), subscription semantics are the same as the generic subscription
	repeated int32 subTypeList = 2;                     // Qot_Common.SubType, reuses the generic subscription types
	required bool isSubOrUnSub = 3;                     // true subscribe / false unsubscribe
	optional bool isRegOrUnRegPush = 4;                 // Whether to register/unregister push
	optional bool isFirstPush = 5;                      // Whether to push existing data once after registration, default true
	optional bool isUnsubAll = 6;                       // When true, ignores other parameters and unsubscribes all EC subscriptions of this connection
	repeated Qot_Common.EC_KlineSource klineSource = 7; // K-line source list (None/OrderBookYes), effective when subscribing to KL_*, defaults to [None] if not set
	optional Qot_Common.QotHeader header = 100;         // Quote common parameter header
}

message Request
{
	required C2S c2s = 1;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

For stock structure, refer to Security

For subscription types, refer to SubType

For K-line source, refer to ECKlineSource

For quote common parameter header, refer to QotHeader

Return

message S2C
{
}

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

1
2
3
4
5
6
7
8
9
10
11

For API call result, refer to RetType

Protocol ID

3455
Data Type
- For stock structure, refer to Security
- For subscription types, refer to SubType
- For K-line source, refer to ECKlineSource
- For quote common parameter header, refer to QotHeader

uint SubEventContract(SubEventContract.Request req);
virtual void OnReply_SubEventContract(FTAPI_Conn client, uint nSerialNo, SubEventContract.Response rsp);

Description

Subscribe/unsubscribe real-time market data push for event contracts.
Parameters

message C2S
{
	repeated Qot_Common.Security securityList = 1;
	repeated int32 subTypeList = 2;
	required bool isSubOrUnSub = 3;
	optional bool isRegOrUnRegPush = 4;
	optional bool isFirstPush = 5;
	optional bool isUnsubAll = 6;
	repeated Qot_Common.EC_KlineSource klineSource = 7;
	optional Qot_Common.QotHeader header = 100;
}

message Request
{
	required C2S c2s = 1;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

For stock structure, refer to Security

Return

message S2C
{
}

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

1
2
3
4
5
6
7
8
9
10
11

For API call result, refer to 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)
    {
        if (errCode != 0) return;
        QotCommon.Security sec = QotCommon.Security.CreateBuilder()
            .SetMarket((int)QotCommon.QotMarket.QotMarket_EventContract)
            .SetCode("EC.KXODIMATCH-26JUL140600INDENG-IND").Build();
        var c2s = SubEventContract.C2S.CreateBuilder()
            .AddSecurity(sec)
            .AddSubType((int)QotCommon.SubType.SubType_OrderBook)
            .AddSubType((int)QotCommon.SubType.SubType_Ticker)
            .AddSubType((int)QotCommon.SubType.SubType_KL_Day)
            .SetIsSubOrUnSub(true)
            .SetIsRegOrUnRegPush(true).Build();
        var req = SubEventContract.Request.CreateBuilder().SetC2S(c2s).Build();
        uint seqNo = qot.SubEventContract(req);
        Console.Write("Send SubEventContract: {0}\n", seqNo);
    }
    public void OnReply_SubEventContract(FTAPI_Conn client, uint nSerialNo, SubEventContract.Response rsp)
    {
        Console.Write("Reply: {0}  {1}\n", nSerialNo, rsp.ToString());
    }
    public static void Main(String[] args)
    {
        FTAPI.Init();
        new Program().Start();
        while (true) Thread.Sleep(1000 * 600);
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

int subEventContract(QotSubEventContract.Request req);
void onReply_SubEventContract(FTAPI_Conn client, int nSerialNo, QotSubEventContract.Response rsp);

Description

Subscribe/unsubscribe real-time market data push for event contracts.
Parameters

message C2S
{
	repeated Qot_Common.Security securityList = 1;
	repeated int32 subTypeList = 2;
	required bool isSubOrUnSub = 3;
	optional bool isRegOrUnRegPush = 4;
	optional bool isFirstPush = 5;
	optional bool isUnsubAll = 6;
	repeated Qot_Common.EC_KlineSource klineSource = 7;
	optional Qot_Common.QotHeader header = 100;
}

message Request
{
	required C2S c2s = 1;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

For stock structure, refer to Security

Return

message S2C
{
}

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

1
2
3
4
5
6
7
8
9
10
11

For API call result, refer to RetType

Example

public class Program implements FTSPI_Qot, FTSPI_Conn {

    private FTAPI_Conn_Qot qot = new FTAPI_Conn_Qot();

    public Program() {
        qot.setClientInfo("java", 1);
        qot.setConnCallback(this);
        qot.setQotCallback(this);
    }

    public void start() {
        qot.initConnect("127.0.0.1", (short) 11111, false);
    }

    @Override
    public void onInitConnect(FTAPI_Conn client, long errCode, String desc) {
        if (errCode != 0) return;
        QotCommon.Security sec = QotCommon.Security.newBuilder()
            .setMarket(QotCommon.QotMarket.QotMarket_EventContract_VALUE)
            .setCode("EC.KXODIMATCH-26JUL140600INDENG-IND").build();
        QotSubEventContract.C2S c2s = QotSubEventContract.C2S.newBuilder()
            .addSecurity(sec)
            .addSubType(QotCommon.SubType.SubType_OrderBook_VALUE)
            .addSubType(QotCommon.SubType.SubType_Ticker_VALUE)
            .addSubType(QotCommon.SubType.SubType_KL_Day_VALUE)
            .setIsSubOrUnSub(true)
            .setIsRegOrUnRegPush(true).build();
        QotSubEventContract.Request req = QotSubEventContract.Request.newBuilder()
            .setC2S(c2s).build();
        int seqNo = qot.subEventContract(req);
        System.out.println("Send SubEventContract: " + seqNo);
    }

    @Override
    public void onReply_SubEventContract(FTAPI_Conn client, int nSerialNo, QotSubEventContract.Response rsp) {
        System.out.println("Reply: " + nSerialNo + "  " + rsp.toString());
    }

    public static void main(String[] args) {
        FTAPI.init();
        new Program().start();
        while (true) {
            try { Thread.sleep(1000 * 600); } catch (InterruptedException e) {}
        }
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

Futu::u32_t SubEventContract(const Qot_SubEventContract::Request &stReq);
virtual void OnReply_SubEventContract(Futu::u32_t nSerialNo, const Qot_SubEventContract::Response &stRsp) = 0;

Description

Subscribe/unsubscribe real-time market data push for event contracts.
Parameters

// Event contract subscribe/unsubscribe
message C2S
{
	repeated Qot_Common.Security securityList = 1;       // Contract underlying (market+code), subscription semantics are the same as the generic subscription
	repeated int32 subTypeList = 2;                     // Qot_Common.SubType, reuses the generic subscription types
	required bool isSubOrUnSub = 3;                     // true subscribe / false unsubscribe
	optional bool isRegOrUnRegPush = 4;                 // Whether to register/unregister push
	optional bool isFirstPush = 5;                      // Whether to push existing data once after registration, default true
	optional bool isUnsubAll = 6;                       // When true, ignores other parameters and unsubscribes all EC subscriptions of this connection
	repeated Qot_Common.EC_KlineSource klineSource = 7; // K-line source list (None/OrderBookYes), effective when subscribing to KL_*, defaults to [None] if not set
	optional Qot_Common.QotHeader header = 100;         // Quote common parameter header
}

message Request
{
	required C2S c2s = 1;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

For stock structure, refer to Security

For subscription types, refer to SubType

For K-line source, refer to ECKlineSource

For quote common parameter header, refer to QotHeader

Return

message S2C
{
}

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

1
2
3
4
5
6
7
8
9
10
11

For API call result, refer to 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;

		// construct request
		Qot_SubEventContract::Request req;
		Qot_SubEventContract::C2S *c2s = req.mutable_c2s();
		Qot_Common::Security *sec = c2s->add_securitylist();
		sec->set_code("EC.KXODIMATCH-26JUL140600INDENG-IND");
		sec->set_market(Qot_Common::QotMarket::QotMarket_EventContract);
		c2s->add_subtypelist(Qot_Common::SubType::SubType_OrderBook);
		c2s->add_subtypelist(Qot_Common::SubType::SubType_Ticker);
		c2s->add_subtypelist(Qot_Common::SubType::SubType_KL_Day);
		c2s->set_isregorunregpush(true);
		c2s->set_issuborunsub(true);

		m_SubEventContractSerialNo = m_pQotApi->SubEventContract(req);
		cout << "Request SubEventContract SerialNo: " << m_SubEventContractSerialNo << endl;
	}

	virtual void OnReply_SubEventContract(Futu::u32_t nSerialNo, const Qot_SubEventContract::Response &stRsp) {
		if (nSerialNo == m_SubEventContractSerialNo)
		{
			cout << "OnReply_SubEventContract SerialNo: " << nSerialNo << endl;
			// Parse and print the internal structure
			// ProtoBufToBodyData and UTF8ToLocal functions are defined in tool.h in the Sample
			string resp_str;
			ProtoBufToBodyData(stRsp, resp_str);
			cout << UTF8ToLocal(resp_str) << endl;
		}
	}

protected:
	FTAPI_Qot *m_pQotApi;

	Futu::u32_t m_SubEventContractSerialNo;
};

int32_t main(int32_t argc, char** argv)
{
	FTAPI::Init();

	{
		Program program;
		program.Start();
		getchar();
	}

	protobuf::ShutdownProtobufLibrary();
	FTAPI::UnInit();
	return 0;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

Output

connect
Request SubEventContract SerialNo: 1
OnReply_SubEventContract SerialNo: 1
{
 "retType": 0,
 "retMsg": "",
 "errCode": 0
}

1
2
3
4
5
6
7
8

SubEventContract(req);

Description

Subscribe/unsubscribe real-time market data push for event contracts.
Parameters

// Event contract subscribe/unsubscribe
message C2S
{
    repeated Qot_Common.Security securityList = 1;       // Contract underlying (market+code), subscription semantics are the same as the generic subscription
    repeated int32 subTypeList = 2;                     // Qot_Common.SubType, reuses the generic subscription types
    required bool isSubOrUnSub = 3;                     // true subscribe / false unsubscribe
    optional bool isRegOrUnRegPush = 4;                 // Whether to register/unregister push
    optional bool isFirstPush = 5;                      // Whether to push existing data once after registration, default true
    optional bool isUnsubAll = 6;                       // When true, ignores other parameters and unsubscribes all EC subscriptions of this connection
    repeated Qot_Common.EC_KlineSource klineSource = 7; // K-line source list (None/OrderBookYes), effective when subscribing to KL_*, defaults to [None] if not set
    optional Qot_Common.QotHeader header = 100;         // Quote common parameter header
}

message Request
{
    required C2S c2s = 1;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

Return

message S2C
{
}

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

1
2
3
4
5
6
7
8
9
10
11

For API call result, refer to RetType

Example

import ftWebsocket from "futu-api";
import { Common, Qot_Common } from "futu-api/proto";
import beautify from "js-beautify";

function SubEventContract() {
    const { RetType } = Common;
    const { QotMarket, SubType } = Qot_Common;
    let [addr, port, enable_ssl, key] = ["127.0.0.1", 11111, false, ""];
    let websocket = new ftWebsocket();

    websocket.onlogin = async (ret, msg) => {
        if (!ret) { console.log("start error", msg); return; }
        try {
            const req = { c2s: { securityList: [{ market: QotMarket.QotMarket_EventContract, code: "EC.KXODIMATCH-26JUL140600INDENG-IND" }], subTypeList: [SubType.SubType_OrderBook, SubType.SubType_Ticker, SubType.SubType_KL_Day], isSubOrUnSub: true, isRegOrUnRegPush: true } };
            let { errCode, retMsg, retType, s2c } = await websocket.SubEventContract(req);
            console.log("SubEventContract: errCode %d, retMsg %s, retType %d", errCode, retMsg, retType);
            if (retType == RetType.RetType_Succeed) {
                console.log(beautify(JSON.stringify(s2c), { indent_size: 2, space_in_empty_paren: true }));
            }
        } catch (error) {
            console.log("error:", error);
        }
    };

    websocket.start(addr, port, enable_ssl, key);
    setTimeout(() => { websocket.stop(); console.log("stop"); }, 5000);
}

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

Output

SubEventContract: errCode 0, retMsg , retType 0
{}

1
2

Python
Proto
C#
Java
C++
JavaScript

subscribe_event_contract(code_list, subtype_list, kline_source_list=None, is_first_push=True, subscribe_push=True)

Description

Subscribe to real-time market data push for event contracts. After a successful subscription, order book, K-line, and ticker data are returned in real time via push callbacks. You must register a handler of the corresponding type via set_handler before receiving push data.

Parameters

Parameter	Type	Description
code_list	list	List of event contract codes, e.g. `['EC.KXODIMATCH-26JUL140600INDENG-IND']`
subtype_list	SubType	List of subscription types
kline_source_list	ECKlineSource	Optional, list of K-line sources. Effective when subscribing to K-line types, defaults to None which means contract-level trade-price K-line
is_first_push	bool	Whether to push existing data once right after subscription, defaults to True
subscribe_push	bool	Whether to register for push, defaults to True

Return

Parameter Type Description

ret RET_CODE API call result

err_message str When ret == RET_OK, returns None; when ret != RET_OK, returns an error description
Example

Parameter	Type	Description
ret	RET_CODE	API call result
err_message	str	When ret == RET_OK, returns None; when ret != RET_OK, returns an error description

from moomoo import *

quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)

# Subscribe: Day K + Ticker + Order Book
ret, err = quote_ctx.subscribe_event_contract(
    ['EC.KXODIMATCH-26JUL140600INDENG-IND'],
    [SubType.K_DAY, SubType.TICKER, SubType.ORDER_BOOK]
)
if ret == RET_OK:
    print('subscribe success')
else:
    print('subscribe failed:', err)

# To receive push, register handlers via set_handler and keep the connection running
quote_ctx.close()

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

Output

subscribe success

On success err is None. After a successful subscription, the corresponding K-line/ticker/order book pushes will trigger the registered handler callbacks (see the output examples in the push documentation).

# Qot_SubEventContract.proto

Description

Subscribe/unsubscribe real-time market data push for event contracts.
Parameters

// Event contract subscribe/unsubscribe
message C2S
{
	repeated Qot_Common.Security securityList = 1;       // Contract underlying (market+code), subscription semantics are the same as the generic subscription
	repeated int32 subTypeList = 2;                     // Qot_Common.SubType, reuses the generic subscription types
	required bool isSubOrUnSub = 3;                     // true subscribe / false unsubscribe
	optional bool isRegOrUnRegPush = 4;                 // Whether to register/unregister push
	optional bool isFirstPush = 5;                      // Whether to push existing data once after registration, default true
	optional bool isUnsubAll = 6;                       // When true, ignores other parameters and unsubscribes all EC subscriptions of this connection
	repeated Qot_Common.EC_KlineSource klineSource = 7; // K-line source list (None/OrderBookYes), effective when subscribing to KL_*, defaults to [None] if not set
	optional Qot_Common.QotHeader header = 100;         // Quote common parameter header
}

message Request
{
	required C2S c2s = 1;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

For stock structure, refer to Security

For subscription types, refer to SubType

For K-line source, refer to ECKlineSource

For quote common parameter header, refer to QotHeader

Return

message S2C
{
}

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

1
2
3
4
5
6
7
8
9
10
11

For API call result, refer to RetType

Protocol ID

3455
Data Type
- For stock structure, refer to Security
- For subscription types, refer to SubType
- For K-line source, refer to ECKlineSource
- For quote common parameter header, refer to QotHeader

uint SubEventContract(SubEventContract.Request req);
virtual void OnReply_SubEventContract(MMAPI_Conn client, uint nSerialNo, SubEventContract.Response rsp);

Description

Subscribe/unsubscribe real-time market data push for event contracts.
Parameters

message C2S
{
	repeated Qot_Common.Security securityList = 1;
	repeated int32 subTypeList = 2;
	required bool isSubOrUnSub = 3;
	optional bool isRegOrUnRegPush = 4;
	optional bool isFirstPush = 5;
	optional bool isUnsubAll = 6;
	repeated Qot_Common.EC_KlineSource klineSource = 7;
	optional Qot_Common.QotHeader header = 100;
}

message Request
{
	required C2S c2s = 1;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

For stock structure, refer to Security

Return

message S2C
{
}

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

1
2
3
4
5
6
7
8
9
10
11

For API call result, refer to 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)
    {
        if (errCode != 0) return;
        QotCommon.Security sec = QotCommon.Security.CreateBuilder()
            .SetMarket((int)QotCommon.QotMarket.QotMarket_EventContract)
            .SetCode("EC.KXODIMATCH-26JUL140600INDENG-IND").Build();
        var c2s = SubEventContract.C2S.CreateBuilder()
            .AddSecurity(sec)
            .AddSubType((int)QotCommon.SubType.SubType_OrderBook)
            .AddSubType((int)QotCommon.SubType.SubType_Ticker)
            .AddSubType((int)QotCommon.SubType.SubType_KL_Day)
            .SetIsSubOrUnSub(true)
            .SetIsRegOrUnRegPush(true).Build();
        var req = SubEventContract.Request.CreateBuilder().SetC2S(c2s).Build();
        uint seqNo = qot.SubEventContract(req);
        Console.Write("Send SubEventContract: {0}\n", seqNo);
    }
    public void OnReply_SubEventContract(MMAPI_Conn client, uint nSerialNo, SubEventContract.Response rsp)
    {
        Console.Write("Reply: {0}  {1}\n", nSerialNo, rsp.ToString());
    }
    public static void Main(String[] args)
    {
        MMAPI.Init();
        new Program().Start();
        while (true) Thread.Sleep(1000 * 600);
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

int subEventContract(QotSubEventContract.Request req);
void onReply_SubEventContract(MMAPI_Conn client, int nSerialNo, QotSubEventContract.Response rsp);

Description

Subscribe/unsubscribe real-time market data push for event contracts.
Parameters

message C2S
{
	repeated Qot_Common.Security securityList = 1;
	repeated int32 subTypeList = 2;
	required bool isSubOrUnSub = 3;
	optional bool isRegOrUnRegPush = 4;
	optional bool isFirstPush = 5;
	optional bool isUnsubAll = 6;
	repeated Qot_Common.EC_KlineSource klineSource = 7;
	optional Qot_Common.QotHeader header = 100;
}

message Request
{
	required C2S c2s = 1;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

For stock structure, refer to Security

Return

message S2C
{
}

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

1
2
3
4
5
6
7
8
9
10
11

For API call result, refer to RetType

Example

public class Program implements MMSPI_Qot, MMSPI_Conn {

    private MMAPI_Conn_Qot qot = new MMAPI_Conn_Qot();

    public Program() {
        qot.setClientInfo("java", 1);
        qot.setConnCallback(this);
        qot.setQotCallback(this);
    }

    public void start() {
        qot.initConnect("127.0.0.1", (short) 11111, false);
    }

    @Override
    public void onInitConnect(MMAPI_Conn client, long errCode, String desc) {
        if (errCode != 0) return;
        QotCommon.Security sec = QotCommon.Security.newBuilder()
            .setMarket(QotCommon.QotMarket.QotMarket_EventContract_VALUE)
            .setCode("EC.KXODIMATCH-26JUL140600INDENG-IND").build();
        QotSubEventContract.C2S c2s = QotSubEventContract.C2S.newBuilder()
            .addSecurity(sec)
            .addSubType(QotCommon.SubType.SubType_OrderBook_VALUE)
            .addSubType(QotCommon.SubType.SubType_Ticker_VALUE)
            .addSubType(QotCommon.SubType.SubType_KL_Day_VALUE)
            .setIsSubOrUnSub(true)
            .setIsRegOrUnRegPush(true).build();
        QotSubEventContract.Request req = QotSubEventContract.Request.newBuilder()
            .setC2S(c2s).build();
        int seqNo = qot.subEventContract(req);
        System.out.println("Send SubEventContract: " + seqNo);
    }

    @Override
    public void onReply_SubEventContract(MMAPI_Conn client, int nSerialNo, QotSubEventContract.Response rsp) {
        System.out.println("Reply: " + nSerialNo + "  " + rsp.toString());
    }

    public static void main(String[] args) {
        MMAPI.init();
        new Program().start();
        while (true) {
            try { Thread.sleep(1000 * 600); } catch (InterruptedException e) {}
        }
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

moomoo::u32_t SubEventContract(const Qot_SubEventContract::Request &stReq);
virtual void OnReply_SubEventContract(moomoo::u32_t nSerialNo, const Qot_SubEventContract::Response &stRsp) = 0;

Description

Subscribe/unsubscribe real-time market data push for event contracts.
Parameters

// Event contract subscribe/unsubscribe
message C2S
{
	repeated Qot_Common.Security securityList = 1;       // Contract underlying (market+code), subscription semantics are the same as the generic subscription
	repeated int32 subTypeList = 2;                     // Qot_Common.SubType, reuses the generic subscription types
	required bool isSubOrUnSub = 3;                     // true subscribe / false unsubscribe
	optional bool isRegOrUnRegPush = 4;                 // Whether to register/unregister push
	optional bool isFirstPush = 5;                      // Whether to push existing data once after registration, default true
	optional bool isUnsubAll = 6;                       // When true, ignores other parameters and unsubscribes all EC subscriptions of this connection
	repeated Qot_Common.EC_KlineSource klineSource = 7; // K-line source list (None/OrderBookYes), effective when subscribing to KL_*, defaults to [None] if not set
	optional Qot_Common.QotHeader header = 100;         // Quote common parameter header
}

message Request
{
	required C2S c2s = 1;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

For stock structure, refer to Security

For subscription types, refer to SubType

For K-line source, refer to ECKlineSource

For quote common parameter header, refer to QotHeader

Return

message S2C
{
}

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

1
2
3
4
5
6
7
8
9
10
11

For API call result, refer to 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;

		// construct request
		Qot_SubEventContract::Request req;
		Qot_SubEventContract::C2S *c2s = req.mutable_c2s();
		Qot_Common::Security *sec = c2s->add_securitylist();
		sec->set_code("EC.KXODIMATCH-26JUL140600INDENG-IND");
		sec->set_market(Qot_Common::QotMarket::QotMarket_EventContract);
		c2s->add_subtypelist(Qot_Common::SubType::SubType_OrderBook);
		c2s->add_subtypelist(Qot_Common::SubType::SubType_Ticker);
		c2s->add_subtypelist(Qot_Common::SubType::SubType_KL_Day);
		c2s->set_isregorunregpush(true);
		c2s->set_issuborunsub(true);

		m_SubEventContractSerialNo = m_pQotApi->SubEventContract(req);
		cout << "Request SubEventContract SerialNo: " << m_SubEventContractSerialNo << endl;
	}

	virtual void OnReply_SubEventContract(moomoo::u32_t nSerialNo, const Qot_SubEventContract::Response &stRsp) {
		if (nSerialNo == m_SubEventContractSerialNo)
		{
			cout << "OnReply_SubEventContract SerialNo: " << nSerialNo << endl;
			// Parse and print the internal structure
			// ProtoBufToBodyData and UTF8ToLocal functions are defined in tool.h in the Sample
			string resp_str;
			ProtoBufToBodyData(stRsp, resp_str);
			cout << UTF8ToLocal(resp_str) << endl;
		}
	}

protected:
	MMAPI_Qot *m_pQotApi;

	moomoo::u32_t m_SubEventContractSerialNo;
};

int32_t main(int32_t argc, char** argv)
{
	MMAPI::Init();

	{
		Program program;
		program.Start();
		getchar();
	}

	protobuf::ShutdownProtobufLibrary();
	MMAPI::UnInit();
	return 0;
}

Output

connect
Request SubEventContract SerialNo: 1
OnReply_SubEventContract SerialNo: 1
{
 "retType": 0,
 "retMsg": "",
 "errCode": 0
}

1
2
3
4
5
6
7
8

SubEventContract(req);

Description

Subscribe/unsubscribe real-time market data push for event contracts.
Parameters

// Event contract subscribe/unsubscribe
message C2S
{
    repeated Qot_Common.Security securityList = 1;       // Contract underlying (market+code), subscription semantics are the same as the generic subscription
    repeated int32 subTypeList = 2;                     // Qot_Common.SubType, reuses the generic subscription types
    required bool isSubOrUnSub = 3;                     // true subscribe / false unsubscribe
    optional bool isRegOrUnRegPush = 4;                 // Whether to register/unregister push
    optional bool isFirstPush = 5;                      // Whether to push existing data once after registration, default true
    optional bool isUnsubAll = 6;                       // When true, ignores other parameters and unsubscribes all EC subscriptions of this connection
    repeated Qot_Common.EC_KlineSource klineSource = 7; // K-line source list (None/OrderBookYes), effective when subscribing to KL_*, defaults to [None] if not set
    optional Qot_Common.QotHeader header = 100;         // Quote common parameter header
}

message Request
{
    required C2S c2s = 1;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

Return

message S2C
{
}

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

1
2
3
4
5
6
7
8
9
10
11

For API call result, refer to RetType

Example

import mmWebsocket from "moomoo-api";
import { Common, Qot_Common } from "moomoo-api/proto";
import beautify from "js-beautify";

function SubEventContract() {
    const { RetType } = Common;
    const { QotMarket, SubType } = Qot_Common;
    let [addr, port, enable_ssl, key] = ["127.0.0.1", 11111, false, ""];
    let websocket = new mmWebsocket();

    websocket.onlogin = async (ret, msg) => {
        if (!ret) { console.log("start error", msg); return; }
        try {
            const req = { c2s: { securityList: [{ market: QotMarket.QotMarket_EventContract, code: "EC.KXODIMATCH-26JUL140600INDENG-IND" }], subTypeList: [SubType.SubType_OrderBook, SubType.SubType_Ticker, SubType.SubType_KL_Day], isSubOrUnSub: true, isRegOrUnRegPush: true } };
            let { errCode, retMsg, retType, s2c } = await websocket.SubEventContract(req);
            console.log("SubEventContract: errCode %d, retMsg %s, retType %d", errCode, retMsg, retType);
            if (retType == RetType.RetType_Succeed) {
                console.log(beautify(JSON.stringify(s2c), { indent_size: 2, space_in_empty_paren: true }));
            }
        } catch (error) {
            console.log("error:", error);
        }
    };

    websocket.start(addr, port, enable_ssl, key);
    setTimeout(() => { websocket.stop(); console.log("stop"); }, 5000);
}

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

Output

SubEventContract: errCode 0, retMsg , retType 0
{}

1
2

← Event Contract API Overview Unsubscribe Event Contract →