# Get Valuation Plate Stock List
- Python
- Proto
- C#
- Java
- C++
- JavaScript
get_valuation_plate_stock_list(code, valuation_type=None, next_key=None, num=None, sort_type=None, sort_id=None, filter_security=None)
Description
Get the valuation list of constituent stocks for a board or index, including valuation, forward valuation, historical percentile, and market cap; the first full request for an index also returns the associated board list
Parameters
Parameter Type Description code str Board or index code e.g. HK.LIST23363 (board) or HK.800000 (index); individual stocks are not supportedvaluation_type ValuationType Valuation type 0=Unknown, 1=PE, 2=PB, 3=PS; default None (1=PE)next_key str Pagination key Omit on first request; pass the nextKey from the previous response on subsequent requests; "-1" means no more datanum int Page size Default 10, range 1–50sort_type SortType Sort direction 1=Desc, 2=Asc; default None (ascending)sort_id SortField Sort column 51=MarketCap (default), 52=Valuation, 53=ForwardValuation, 54=HistoricalPercentilefilter_security str Board filter Valid for indexes only; filter constituent stocks by board, e.g. HK.LIST23363; no filter if omittedReturn
Parameter Type Description ret RET_CODE API call result data dict When ret == RET_OK, returns a dict of constituent stock valuation data str When ret != RET_OK, returns an error description The returned dict contains the following fields:
Field Type Description count int Total constituent stock count stock_list list Constituent stock valuation list; each item see stock_list field table next_key str Pagination key "-1" means no more dataplate_list list Associated board list Returned only on the first full request when target is an index; each item see plate_list field tablestock_list fields (constituent stock valuation entry):
Field Type Description symbol str Stock code valuation_val float Valuation forward_value float Forward valuation Currently supports PE and PS onlyvaluation_percentile float Historical percentile Value before %, e.g. 12.34 means 12.34%market_cap float Market cap name str Stock name plate_list fields (index board entry):
Field Type Description symbol str Board code name str Board name
Example
from futu import *
import pandas as pd
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
ret, data = quote_ctx.get_valuation_plate_stock_list("HK.LIST23363")
if ret == RET_OK:
df = pd.DataFrame(data.get('stock_list', []))
print(df.to_string(index=False))
else:
print('error:', data)
quote_ctx.close()
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
- Output
symbol name valuation_val valuation_percentile market_cap
HK.08076 SING LEE -2.300 65.337673 3.029652e+07
HK.08092 ITE HOLDINGS 19.500 98.209927 3.609481e+07
HK.08036 EBROKER GROUP -12.000 35.313263 4.428000e+07
HK.01561 PAN ASIA DATA H -23.500 1.057770 5.007634e+07
HK.08071 CH NETCOMTECH -13.000 31.489015 6.091863e+07
HK.00248 HKC INT'L HOLD -2.056 19.446705 6.771489e+07
HK.01613 SYNERTONE -2.796 72.660700 8.841764e+07
HK.08062 EFT SOLUTIONS -93.333 0.244101 1.344000e+08
HK.01949 PLATT NERA -5.147 36.523929 1.344000e+08
HK.01206 TECHNOVATOR -0.314 41.171684 1.720823e+08
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
# Qot_GetValuationPlateStockList.proto
Description
Get valuation list of constituent stocks for a board or index
Parameters
message C2S
{
required Qot_Common.Security security = 1; // Stock (board or index)
optional Qot_Common.ValuationType valuationType = 2; // Valuation type, refer to Qot_Common.ValuationType, supports 1-3, default 1 (PE)
optional string nextKey = 3; // Pagination key; omit on first request, pass returned nextKey on subsequent; "-1" means no more data
optional int32 num = 4; // Page size, default 10, range 1–50
optional Qot_Common.SortType sortType = 5; // Sort direction, refer to Qot_Common.SortType, default ascending (SortType_Asc=2)
optional Qot_Common.SortField sortId = 6; // Sort column, refer to Qot_Common.SortField: 51=MarketCap (default) 52=Valuation 53=ForwardValuation 54=HistoricalPercentile
optional Qot_Common.Security filterSecurity = 7; // Board filter; valid for index only, filter constituent stocks by board; no filter if omitted
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
2
3
4
5
6
7
8
9
10
11
12
13
14
15
- Security structure, refer to Security
- Valuation type, refer to ValuationType
- Sort direction, refer to SortType
- Sort column, refer to SortField
- Return
// Index board entry
message PlateItem
{
optional Qot_Common.Security security = 1; // Stock
optional string name = 2; // Board name
}
// Constituent stock valuation entry
message StockItem
{
optional Qot_Common.Security security = 1; // Stock
optional string name = 6; // Stock name
optional double valuationVal = 2; // Valuation
optional double forwardValue = 3; // Forward valuation, PE and PS only
optional double valuationPercentile = 4; // Historical valuation percentile, value before %, e.g. 12.34 means 12.34%
optional double marketCap = 5; // Market cap
}
message S2C
{
optional int32 count = 1; // Total constituent stock count
repeated StockItem stockList = 2; // Constituent stock valuation list
optional string nextKey = 3; // Pagination key, "-1" means no more data
repeated PlateItem plateList = 4; // Index board/sector list; returned only on first full request for an index
}
message Response
{
required int32 retType = 1 [default = -400]; // Return result, refer to Common.RetType
optional string retMsg = 2; // Return result description
optional int32 errCode = 3; // Error code
optional S2C s2c = 4;
}
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
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
- API call result, refer to RetType
Protocol ID
3233
uint GetValuationPlateStockList(QotGetValuationPlateStockList.Request req);
virtual void OnReply_GetValuationPlateStockList(FTAPI_Conn client, uint nSerialNo, QotGetValuationPlateStockList.Response rsp);
Description
Get valuation list of constituent stocks for a board or index
Parameters
message C2S
{
required Qot_Common.Security security = 1; // Stock (board or index)
optional Qot_Common.ValuationType valuationType = 2; // Valuation type, refer to Qot_Common.ValuationType, supports 1-3, default 1 (PE)
optional string nextKey = 3; // Pagination key; omit on first request, pass returned nextKey on subsequent; "-1" means no more data
optional int32 num = 4; // Page size, default 10, range 1–50
optional Qot_Common.SortType sortType = 5; // Sort direction, refer to Qot_Common.SortType, default ascending (SortType_Asc=2)
optional Qot_Common.SortField sortId = 6; // Sort column, refer to Qot_Common.SortField: 51=MarketCap (default) 52=Valuation 53=ForwardValuation 54=HistoricalPercentile
optional Qot_Common.Security filterSecurity = 7; // Board filter; valid for index only, filter constituent stocks by board; no filter if omitted
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
2
3
4
5
6
7
8
9
10
11
12
13
14
15
- Security structure, refer to Security
- Return
// Index board entry
message PlateItem
{
optional Qot_Common.Security security = 1; // Stock
optional string name = 2; // Board name
}
// Constituent stock valuation entry
message StockItem
{
optional Qot_Common.Security security = 1; // Stock
optional string name = 6; // Stock name
optional double valuationVal = 2; // Valuation
optional double forwardValue = 3; // Forward valuation, PE and PS only
optional double valuationPercentile = 4; // Historical valuation percentile, value before %, e.g. 12.34 means 12.34%
optional double marketCap = 5; // Market cap
}
message S2C
{
optional int32 count = 1; // Total constituent stock count
repeated StockItem stockList = 2; // Constituent stock valuation list
optional string nextKey = 3; // Pagination key, "-1" means no more data
repeated PlateItem plateList = 4; // Index board/sector list; returned only on first full request for an index
}
message Response
{
required int32 retType = 1 [default = -400]; // Return result, refer to Common.RetType
optional string retMsg = 2; // Return result description
optional int32 errCode = 3; // Error code
optional S2C s2c = 4;
}
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
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
- 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)
{
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("LIST23363")
.Build();
QotGetValuationPlateStockList.C2S c2s = QotGetValuationPlateStockList.C2S.CreateBuilder()
.SetSecurity(sec)
.Build();
QotGetValuationPlateStockList.Request req = QotGetValuationPlateStockList.Request.CreateBuilder().SetC2S(c2s).Build();
uint seqNo = qot.GetValuationPlateStockList(req);
Console.Write("Send QotGetValuationPlateStockList: {0}\n", seqNo);
}
public void OnDisconnect(FTAPI_Conn client, long errCode)
{
Console.Write("Qot onDisConnect: {0}\n", errCode);
}
public void OnReply_GetValuationPlateStockList(FTAPI_Conn client, uint nSerialNo, QotGetValuationPlateStockList.Response rsp)
{
Console.Write("Reply: QotGetValuationPlateStockList: {0} {1}\n", nSerialNo, rsp.ToString());
}
public static void Main(String[] args)
{
FTAPI.Init();
Program qot = new Program();
qot.Start();
while (true)
Thread.Sleep(1000 * 600);
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
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
- Output
sent seqNo=3
retType: 0
retMsg: ""
errCode: 0
s2c {
count: 69
stockList {
security {
market: 1
code: "08076"
}
valuationVal: -2.3
valuationPercentile: 65.3658536
marketCap: 30296520
name: "SING LEE"
}
stockList {
//...
}
nextKey: "10"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
int getValuationPlateStockList(QotGetValuationPlateStockList.Request req);
void onReply_GetValuationPlateStockList(FTAPI_Conn client, int nSerialNo, QotGetValuationPlateStockList.Response rsp);
Description
Get valuation list of constituent stocks for a board or index
Parameters
message C2S
{
required Qot_Common.Security security = 1; // Stock (board or index)
optional Qot_Common.ValuationType valuationType = 2; // Valuation type, refer to Qot_Common.ValuationType, supports 1-3, default 1 (PE)
optional string nextKey = 3; // Pagination key; omit on first request, pass returned nextKey on subsequent; "-1" means no more data
optional int32 num = 4; // Page size, default 10, range 1–50
optional Qot_Common.SortType sortType = 5; // Sort direction, refer to Qot_Common.SortType, default ascending (SortType_Asc=2)
optional Qot_Common.SortField sortId = 6; // Sort column, refer to Qot_Common.SortField: 51=MarketCap (default) 52=Valuation 53=ForwardValuation 54=HistoricalPercentile
optional Qot_Common.Security filterSecurity = 7; // Board filter; valid for index only, filter constituent stocks by board; no filter if omitted
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
2
3
4
5
6
7
8
9
10
11
12
13
14
15
- Security structure, refer to Security
- Return
// Index board entry
message PlateItem
{
optional Qot_Common.Security security = 1; // Stock
optional string name = 2; // Board name
}
// Constituent stock valuation entry
message StockItem
{
optional Qot_Common.Security security = 1; // Stock
optional string name = 6; // Stock name
optional double valuationVal = 2; // Valuation
optional double forwardValue = 3; // Forward valuation, PE and PS only
optional double valuationPercentile = 4; // Historical valuation percentile, value before %, e.g. 12.34 means 12.34%
optional double marketCap = 5; // Market cap
}
message S2C
{
optional int32 count = 1; // Total constituent stock count
repeated StockItem stockList = 2; // Constituent stock valuation list
optional string nextKey = 3; // Pagination key, "-1" means no more data
repeated PlateItem plateList = 4; // Index board/sector list; returned only on first full request for an index
}
message Response
{
required int32 retType = 1 [default = -400]; // Return result, refer to Common.RetType
optional string retMsg = 2; // Return result description
optional int32 errCode = 3; // Error code
optional S2C s2c = 4;
}
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
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
- API call result, refer to 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("LIST23363")
.build();
QotGetValuationPlateStockList.C2S c2s = QotGetValuationPlateStockList.C2S.newBuilder()
.setSecurity(sec)
.build();
QotGetValuationPlateStockList.Request req = QotGetValuationPlateStockList.Request.newBuilder().setC2S(c2s).build();
int seqNo = qot.getValuationPlateStockList(req);
System.out.printf("Send QotGetValuationPlateStockList: %d\n", seqNo);
}
@Override
public void onDisconnect(FTAPI_Conn client, long errCode) {
System.out.printf("Qot onDisConnect: %d\n", errCode);
}
@Override
public void onReply_GetValuationPlateStockList(FTAPI_Conn client, int nSerialNo, QotGetValuationPlateStockList.Response rsp) {
if (rsp.getRetType() != 0) {
System.out.printf("QotGetValuationPlateStockList failed: %s\n", rsp.getRetMsg());
}
else {
try {
String json = JsonFormat.printer().print(rsp);
System.out.printf("Receive QotGetValuationPlateStockList: %s\n", json);
} catch (InvalidProtocolBufferException e) {
e.printStackTrace();
}
}
}
public static void main(String[] args) {
FTAPI.init();
QotDemo qot = new QotDemo();
qot.start();
while (true) {
try {
Thread.sleep(1000 * 600);
} catch (InterruptedException exc) {
}
}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
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
- Output
Qot onInitConnect: ret=0 desc= connID=7459212604361842573
Send Qot_GetValuationPlateStockList: 2
Receive Qot_GetValuationPlateStockList: retType: 0
retMsg: ""
errCode: 0
s2c {
count: 69
stockList {
security {
market: 1
code: "08076"
}
valuationVal: -2.3
valuationPercentile: 65.3658536
marketCap: 3.029652E7
name: "SING LEE"
}
stockList {
//...
}
nextKey: "10"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
Futu::u32_t GetValuationPlateStockList(const Qot_GetValuationPlateStockList::Request &stReq);
virtual void OnReply_GetValuationPlateStockList(Futu::u32_t nSerialNo, const Qot_GetValuationPlateStockList::Response &stRsp) = 0;
Description
Get valuation list of constituent stocks for a board or index
Parameters
message C2S
{
required Qot_Common.Security security = 1; // Stock (board or index)
optional Qot_Common.ValuationType valuationType = 2; // Valuation type, refer to Qot_Common.ValuationType, supports 1-3, default 1 (PE)
optional string nextKey = 3; // Pagination key; omit on first request, pass returned nextKey on subsequent; "-1" means no more data
optional int32 num = 4; // Page size, default 10, range 1–50
optional Qot_Common.SortType sortType = 5; // Sort direction, refer to Qot_Common.SortType, default ascending (SortType_Asc=2)
optional Qot_Common.SortField sortId = 6; // Sort column, refer to Qot_Common.SortField: 51=MarketCap (default) 52=Valuation 53=ForwardValuation 54=HistoricalPercentile
optional Qot_Common.Security filterSecurity = 7; // Board filter; valid for index only, filter constituent stocks by board; no filter if omitted
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
2
3
4
5
6
7
8
9
10
11
12
13
14
15
- Security structure, refer to Security
- Return
// Index board entry
message PlateItem
{
optional Qot_Common.Security security = 1; // Stock
optional string name = 2; // Board name
}
// Constituent stock valuation entry
message StockItem
{
optional Qot_Common.Security security = 1; // Stock
optional string name = 6; // Stock name
optional double valuationVal = 2; // Valuation
optional double forwardValue = 3; // Forward valuation, PE and PS only
optional double valuationPercentile = 4; // Historical valuation percentile, value before %, e.g. 12.34 means 12.34%
optional double marketCap = 5; // Market cap
}
message S2C
{
optional int32 count = 1; // Total constituent stock count
repeated StockItem stockList = 2; // Constituent stock valuation list
optional string nextKey = 3; // Pagination key, "-1" means no more data
repeated PlateItem plateList = 4; // Index board/sector list; returned only on first full request for an index
}
message Response
{
required int32 retType = 1 [default = -400]; // Return result, refer to Common.RetType
optional string retMsg = 2; // Return result description
optional int32 errCode = 3; // Error code
optional S2C s2c = 4;
}
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
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
- 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 message
Qot_GetValuationPlateStockList::Request req;
Qot_GetValuationPlateStockList::C2S *c2s = req.mutable_c2s();
Qot_Common::Security *sec = c2s->mutable_security();
sec->set_code("LIST23363");
sec->set_market(Qot_Common::QotMarket::QotMarket_HK_Security);
m_pQotApi->GetValuationPlateStockList(req);
cout << "GetValuationPlateStockList" << endl;
}
virtual void OnReply_GetValuationPlateStockList(Futu::u32_t nSerialNo, const Qot_GetValuationPlateStockList::Response &stRsp){
cout << "OnReply_GetValuationPlateStockList:" << endl;
// print response
// ProtoBufToBodyData and UTF8ToLocal refer to tool.h in Samples
string resp_str;
ProtoBufToBodyData(stRsp, resp_str);
cout << UTF8ToLocal(resp_str) << endl;
}
protected:
FTAPI_Qot *m_pQotApi;
};
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
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
- Output
onInitConnect: ret=0 desc=Succeed!
Send Qot_GetValuationPlateStockList seqNo=3
retType: 0
retMsg: ""
errCode: 0
s2c {
count: 69
stockList {
security {
market: 1
code: "08076"
}
valuationVal: -2.3
valuationPercentile: 65.3658536
marketCap: 30296520
name: "SING LEE"
}
stockList {
//...
}
nextKey: "10"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
GetValuationPlateStockList(req);
Description
Get valuation list of constituent stocks for a board or index
Parameters
message C2S
{
required Qot_Common.Security security = 1; // Stock (board or index)
optional Qot_Common.ValuationType valuationType = 2; // Valuation type, refer to Qot_Common.ValuationType, supports 1-3, default 1 (PE)
optional string nextKey = 3; // Pagination key; omit on first request, pass returned nextKey on subsequent; "-1" means no more data
optional int32 num = 4; // Page size, default 10, range 1–50
optional Qot_Common.SortType sortType = 5; // Sort direction, refer to Qot_Common.SortType, default ascending (SortType_Asc=2)
optional Qot_Common.SortField sortId = 6; // Sort column, refer to Qot_Common.SortField: 51=MarketCap (default) 52=Valuation 53=ForwardValuation 54=HistoricalPercentile
optional Qot_Common.Security filterSecurity = 7; // Board filter; valid for index only, filter constituent stocks by board; no filter if omitted
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
2
3
4
5
6
7
8
9
10
11
12
13
14
15
- Security structure, refer to Security
- Return
// Index board entry
message PlateItem
{
optional Qot_Common.Security security = 1; // Stock
optional string name = 2; // Board name
}
// Constituent stock valuation entry
message StockItem
{
optional Qot_Common.Security security = 1; // Stock
optional string name = 6; // Stock name
optional double valuationVal = 2; // Valuation
optional double forwardValue = 3; // Forward valuation, PE and PS only
optional double valuationPercentile = 4; // Historical valuation percentile, value before %, e.g. 12.34 means 12.34%
optional double marketCap = 5; // Market cap
}
message S2C
{
optional int32 count = 1; // Total constituent stock count
repeated StockItem stockList = 2; // Constituent stock valuation list
optional string nextKey = 3; // Pagination key, "-1" means no more data
repeated PlateItem plateList = 4; // Index board/sector list; returned only on first full request for an index
}
message Response
{
required int32 retType = 1 [default = -400]; // Return result, refer to Common.RetType
optional string retMsg = 2; // Return result description
optional int32 errCode = 3; // Error code
optional S2C s2c = 4;
}
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
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
- 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 QotGetValuationPlateStockList(){
const { RetType } = Common
const { QotMarket } = Qot_Common
let [addr, port, enable_ssl, key] = ["127.0.0.1", 33333, false, '7522027ccf5a06b1'];
let websocket = new ftWebsocket();
websocket.onlogin = (ret, msg)=>{
if (ret) {
const req = {
c2s: {
security: {
market: QotMarket.QotMarket_HK_Security,
code: "LIST23363",
},
},
};
websocket.GetValuationPlateStockList(req)
.then((res) => {
let { errCode, retMsg, retType,s2c } = res
console.log("GetValuationPlateStockList: errCode %d, retMsg %s, retType %d", errCode, retMsg, retType);
if(retType == RetType.RetType_Succeed){
let data = beautify(JSON.stringify(s2c), {
indent_size: 2,
space_in_empty_paren: true,
});
console.log(data);
}
})
.catch((error) => {
console.log("error:", error);
});
} else {
console.log("error", msg);
}
};
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
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
- Output
GetValuationPlateStockList: errCode 0, retMsg , retType 0
{
"count": 69,
"stockList": [{
"security": {
"market": 1,
"code": "08076"
},
"valuationVal": -2.3,
"valuationPercentile": 65.3376729,
"marketCap": 30296520,
"name": "SING LEE"
//...
}],
"nextKey": "10"
}
stop
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
API Limits
- Up to 30 requests per 30 seconds.
- Supports boards and indexes; individual stocks are not supported.
- For indexes, the first full request additionally returns the associated board list (plate_list).
- Python
- Proto
- C#
- Java
- C++
- JavaScript
get_valuation_plate_stock_list(code, valuation_type=None, next_key=None, num=None, sort_type=None, sort_id=None, filter_security=None)
Description
Get the valuation list of constituent stocks for a board or index, including valuation, forward valuation, historical percentile, and market cap; the first full request for an index also returns the associated board list
Parameters
Parameter Type Description code str Board or index code e.g. HK.LIST23363 (board) or HK.800000 (index); individual stocks are not supportedvaluation_type ValuationType Valuation type 0=Unknown, 1=PE, 2=PB, 3=PS; default None (1=PE)next_key str Pagination key Omit on first request; pass the nextKey from the previous response on subsequent requests; "-1" means no more datanum int Page size Default 10, range 1–50sort_type SortType Sort direction 1=Desc, 2=Asc; default None (ascending)sort_id SortField Sort column 51=MarketCap (default), 52=Valuation, 53=ForwardValuation, 54=HistoricalPercentilefilter_security str Board filter Valid for indexes only; filter constituent stocks by board, e.g. HK.LIST23363; no filter if omittedReturn
Parameter Type Description ret RET_CODE API call result data dict When ret == RET_OK, returns a dict of constituent stock valuation data str When ret != RET_OK, returns an error description The returned dict contains the following fields:
Field Type Description count int Total constituent stock count stock_list list Constituent stock valuation list; each item see stock_list field table next_key str Pagination key "-1" means no more dataplate_list list Associated board list Returned only on the first full request when target is an index; each item see plate_list field tablestock_list fields (constituent stock valuation entry):
Field Type Description symbol str Stock code valuation_val float Valuation forward_value float Forward valuation Currently supports PE and PS onlyvaluation_percentile float Historical percentile Value before %, e.g. 12.34 means 12.34%market_cap float Market cap name str Stock name plate_list fields (index board entry):
Field Type Description symbol str Board code name str Board name
Example
from moomoo import *
import pandas as pd
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
ret, data = quote_ctx.get_valuation_plate_stock_list("HK.LIST23363")
if ret == RET_OK:
df = pd.DataFrame(data.get('stock_list', []))
print(df.to_string(index=False))
else:
print('error:', data)
quote_ctx.close()
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
- Output
symbol name valuation_val valuation_percentile market_cap
HK.08076 SING LEE -2.300 65.337673 3.029652e+07
HK.08092 ITE HOLDINGS 19.500 98.209927 3.609481e+07
HK.08036 EBROKER GROUP -12.000 35.313263 4.428000e+07
HK.01561 PAN ASIA DATA H -23.500 1.057770 5.007634e+07
HK.08071 CH NETCOMTECH -13.000 31.489015 6.091863e+07
HK.00248 HKC INT'L HOLD -2.056 19.446705 6.771489e+07
HK.01613 SYNERTONE -2.796 72.660700 8.841764e+07
HK.08062 EFT SOLUTIONS -93.333 0.244101 1.344000e+08
HK.01949 PLATT NERA -5.147 36.523929 1.344000e+08
HK.01206 TECHNOVATOR -0.314 41.171684 1.720823e+08
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
# Qot_GetValuationPlateStockList.proto
Description
Get valuation list of constituent stocks for a board or index
Parameters
message C2S
{
required Qot_Common.Security security = 1; // Stock (board or index)
optional Qot_Common.ValuationType valuationType = 2; // Valuation type, refer to Qot_Common.ValuationType, supports 1-3, default 1 (PE)
optional string nextKey = 3; // Pagination key; omit on first request, pass returned nextKey on subsequent; "-1" means no more data
optional int32 num = 4; // Page size, default 10, range 1–50
optional Qot_Common.SortType sortType = 5; // Sort direction, refer to Qot_Common.SortType, default ascending (SortType_Asc=2)
optional Qot_Common.SortField sortId = 6; // Sort column, refer to Qot_Common.SortField: 51=MarketCap (default) 52=Valuation 53=ForwardValuation 54=HistoricalPercentile
optional Qot_Common.Security filterSecurity = 7; // Board filter; valid for index only, filter constituent stocks by board; no filter if omitted
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
2
3
4
5
6
7
8
9
10
11
12
13
14
15
- Security structure, refer to Security
- Valuation type, refer to ValuationType
- Sort direction, refer to SortType
- Sort column, refer to SortField
- Return
// Index board entry
message PlateItem
{
optional Qot_Common.Security security = 1; // Stock
optional string name = 2; // Board name
}
// Constituent stock valuation entry
message StockItem
{
optional Qot_Common.Security security = 1; // Stock
optional string name = 6; // Stock name
optional double valuationVal = 2; // Valuation
optional double forwardValue = 3; // Forward valuation, PE and PS only
optional double valuationPercentile = 4; // Historical valuation percentile, value before %, e.g. 12.34 means 12.34%
optional double marketCap = 5; // Market cap
}
message S2C
{
optional int32 count = 1; // Total constituent stock count
repeated StockItem stockList = 2; // Constituent stock valuation list
optional string nextKey = 3; // Pagination key, "-1" means no more data
repeated PlateItem plateList = 4; // Index board/sector list; returned only on first full request for an index
}
message Response
{
required int32 retType = 1 [default = -400]; // Return result, refer to Common.RetType
optional string retMsg = 2; // Return result description
optional int32 errCode = 3; // Error code
optional S2C s2c = 4;
}
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
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
- API call result, refer to RetType
Protocol ID
3233
uint GetValuationPlateStockList(QotGetValuationPlateStockList.Request req);
virtual void OnReply_GetValuationPlateStockList(MMAPI_Conn client, uint nSerialNo, QotGetValuationPlateStockList.Response rsp);
Description
Get valuation list of constituent stocks for a board or index
Parameters
message C2S
{
required Qot_Common.Security security = 1; // Stock (board or index)
optional Qot_Common.ValuationType valuationType = 2; // Valuation type, refer to Qot_Common.ValuationType, supports 1-3, default 1 (PE)
optional string nextKey = 3; // Pagination key; omit on first request, pass returned nextKey on subsequent; "-1" means no more data
optional int32 num = 4; // Page size, default 10, range 1–50
optional Qot_Common.SortType sortType = 5; // Sort direction, refer to Qot_Common.SortType, default ascending (SortType_Asc=2)
optional Qot_Common.SortField sortId = 6; // Sort column, refer to Qot_Common.SortField: 51=MarketCap (default) 52=Valuation 53=ForwardValuation 54=HistoricalPercentile
optional Qot_Common.Security filterSecurity = 7; // Board filter; valid for index only, filter constituent stocks by board; no filter if omitted
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
2
3
4
5
6
7
8
9
10
11
12
13
14
15
- Security structure, refer to Security
- Return
// Index board entry
message PlateItem
{
optional Qot_Common.Security security = 1; // Stock
optional string name = 2; // Board name
}
// Constituent stock valuation entry
message StockItem
{
optional Qot_Common.Security security = 1; // Stock
optional string name = 6; // Stock name
optional double valuationVal = 2; // Valuation
optional double forwardValue = 3; // Forward valuation, PE and PS only
optional double valuationPercentile = 4; // Historical valuation percentile, value before %, e.g. 12.34 means 12.34%
optional double marketCap = 5; // Market cap
}
message S2C
{
optional int32 count = 1; // Total constituent stock count
repeated StockItem stockList = 2; // Constituent stock valuation list
optional string nextKey = 3; // Pagination key, "-1" means no more data
repeated PlateItem plateList = 4; // Index board/sector list; returned only on first full request for an index
}
message Response
{
required int32 retType = 1 [default = -400]; // Return result, refer to Common.RetType
optional string retMsg = 2; // Return result description
optional int32 errCode = 3; // Error code
optional S2C s2c = 4;
}
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
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
- 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)
{
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("LIST23363")
.Build();
QotGetValuationPlateStockList.C2S c2s = QotGetValuationPlateStockList.C2S.CreateBuilder()
.SetSecurity(sec)
.Build();
QotGetValuationPlateStockList.Request req = QotGetValuationPlateStockList.Request.CreateBuilder().SetC2S(c2s).Build();
uint seqNo = qot.GetValuationPlateStockList(req);
Console.Write("Send QotGetValuationPlateStockList: {0}\n", seqNo);
}
public void OnDisconnect(MMAPI_Conn client, long errCode)
{
Console.Write("Qot onDisConnect: {0}\n", errCode);
}
public void OnReply_GetValuationPlateStockList(MMAPI_Conn client, uint nSerialNo, QotGetValuationPlateStockList.Response rsp)
{
Console.Write("Reply: QotGetValuationPlateStockList: {0} {1}\n", nSerialNo, rsp.ToString());
}
public static void Main(String[] args)
{
MMAPI.Init();
Program qot = new Program();
qot.Start();
while (true)
Thread.Sleep(1000 * 600);
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
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
- Output
sent seqNo=3
retType: 0
retMsg: ""
errCode: 0
s2c {
count: 69
stockList {
security {
market: 1
code: "08076"
}
valuationVal: -2.3
valuationPercentile: 65.3658536
marketCap: 30296520
name: "SING LEE"
}
stockList {
//...
}
nextKey: "10"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
int getValuationPlateStockList(QotGetValuationPlateStockList.Request req);
void onReply_GetValuationPlateStockList(MMAPI_Conn client, int nSerialNo, QotGetValuationPlateStockList.Response rsp);
Description
Get valuation list of constituent stocks for a board or index
Parameters
message C2S
{
required Qot_Common.Security security = 1; // Stock (board or index)
optional Qot_Common.ValuationType valuationType = 2; // Valuation type, refer to Qot_Common.ValuationType, supports 1-3, default 1 (PE)
optional string nextKey = 3; // Pagination key; omit on first request, pass returned nextKey on subsequent; "-1" means no more data
optional int32 num = 4; // Page size, default 10, range 1–50
optional Qot_Common.SortType sortType = 5; // Sort direction, refer to Qot_Common.SortType, default ascending (SortType_Asc=2)
optional Qot_Common.SortField sortId = 6; // Sort column, refer to Qot_Common.SortField: 51=MarketCap (default) 52=Valuation 53=ForwardValuation 54=HistoricalPercentile
optional Qot_Common.Security filterSecurity = 7; // Board filter; valid for index only, filter constituent stocks by board; no filter if omitted
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
2
3
4
5
6
7
8
9
10
11
12
13
14
15
- Security structure, refer to Security
- Return
// Index board entry
message PlateItem
{
optional Qot_Common.Security security = 1; // Stock
optional string name = 2; // Board name
}
// Constituent stock valuation entry
message StockItem
{
optional Qot_Common.Security security = 1; // Stock
optional string name = 6; // Stock name
optional double valuationVal = 2; // Valuation
optional double forwardValue = 3; // Forward valuation, PE and PS only
optional double valuationPercentile = 4; // Historical valuation percentile, value before %, e.g. 12.34 means 12.34%
optional double marketCap = 5; // Market cap
}
message S2C
{
optional int32 count = 1; // Total constituent stock count
repeated StockItem stockList = 2; // Constituent stock valuation list
optional string nextKey = 3; // Pagination key, "-1" means no more data
repeated PlateItem plateList = 4; // Index board/sector list; returned only on first full request for an index
}
message Response
{
required int32 retType = 1 [default = -400]; // Return result, refer to Common.RetType
optional string retMsg = 2; // Return result description
optional int32 errCode = 3; // Error code
optional S2C s2c = 4;
}
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
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
- API call result, refer to 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("LIST23363")
.build();
QotGetValuationPlateStockList.C2S c2s = QotGetValuationPlateStockList.C2S.newBuilder()
.setSecurity(sec)
.build();
QotGetValuationPlateStockList.Request req = QotGetValuationPlateStockList.Request.newBuilder().setC2S(c2s).build();
int seqNo = qot.getValuationPlateStockList(req);
System.out.printf("Send QotGetValuationPlateStockList: %d\n", seqNo);
}
@Override
public void onDisconnect(MMAPI_Conn client, long errCode) {
System.out.printf("Qot onDisConnect: %d\n", errCode);
}
@Override
public void onReply_GetValuationPlateStockList(MMAPI_Conn client, int nSerialNo, QotGetValuationPlateStockList.Response rsp) {
if (rsp.getRetType() != 0) {
System.out.printf("QotGetValuationPlateStockList failed: %s\n", rsp.getRetMsg());
}
else {
try {
String json = JsonFormat.printer().print(rsp);
System.out.printf("Receive QotGetValuationPlateStockList: %s\n", json);
} catch (InvalidProtocolBufferException e) {
e.printStackTrace();
}
}
}
public static void main(String[] args) {
MMAPI.init();
QotDemo qot = new QotDemo();
qot.start();
while (true) {
try {
Thread.sleep(1000 * 600);
} catch (InterruptedException exc) {
}
}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
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
- Output
Qot onInitConnect: ret=0 desc= connID=7459212604361842573
Send Qot_GetValuationPlateStockList: 2
Receive Qot_GetValuationPlateStockList: retType: 0
retMsg: ""
errCode: 0
s2c {
count: 69
stockList {
security {
market: 1
code: "08076"
}
valuationVal: -2.3
valuationPercentile: 65.3658536
marketCap: 3.029652E7
name: "SING LEE"
}
stockList {
//...
}
nextKey: "10"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
moomoo::u32_t GetValuationPlateStockList(const Qot_GetValuationPlateStockList::Request &stReq);
virtual void OnReply_GetValuationPlateStockList(moomoo::u32_t nSerialNo, const Qot_GetValuationPlateStockList::Response &stRsp) = 0;
Description
Get valuation list of constituent stocks for a board or index
Parameters
message C2S
{
required Qot_Common.Security security = 1; // Stock (board or index)
optional Qot_Common.ValuationType valuationType = 2; // Valuation type, refer to Qot_Common.ValuationType, supports 1-3, default 1 (PE)
optional string nextKey = 3; // Pagination key; omit on first request, pass returned nextKey on subsequent; "-1" means no more data
optional int32 num = 4; // Page size, default 10, range 1–50
optional Qot_Common.SortType sortType = 5; // Sort direction, refer to Qot_Common.SortType, default ascending (SortType_Asc=2)
optional Qot_Common.SortField sortId = 6; // Sort column, refer to Qot_Common.SortField: 51=MarketCap (default) 52=Valuation 53=ForwardValuation 54=HistoricalPercentile
optional Qot_Common.Security filterSecurity = 7; // Board filter; valid for index only, filter constituent stocks by board; no filter if omitted
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
2
3
4
5
6
7
8
9
10
11
12
13
14
15
- Security structure, refer to Security
- Return
// Index board entry
message PlateItem
{
optional Qot_Common.Security security = 1; // Stock
optional string name = 2; // Board name
}
// Constituent stock valuation entry
message StockItem
{
optional Qot_Common.Security security = 1; // Stock
optional string name = 6; // Stock name
optional double valuationVal = 2; // Valuation
optional double forwardValue = 3; // Forward valuation, PE and PS only
optional double valuationPercentile = 4; // Historical valuation percentile, value before %, e.g. 12.34 means 12.34%
optional double marketCap = 5; // Market cap
}
message S2C
{
optional int32 count = 1; // Total constituent stock count
repeated StockItem stockList = 2; // Constituent stock valuation list
optional string nextKey = 3; // Pagination key, "-1" means no more data
repeated PlateItem plateList = 4; // Index board/sector list; returned only on first full request for an index
}
message Response
{
required int32 retType = 1 [default = -400]; // Return result, refer to Common.RetType
optional string retMsg = 2; // Return result description
optional int32 errCode = 3; // Error code
optional S2C s2c = 4;
}
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
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
- 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 message
Qot_GetValuationPlateStockList::Request req;
Qot_GetValuationPlateStockList::C2S *c2s = req.mutable_c2s();
Qot_Common::Security *sec = c2s->mutable_security();
sec->set_code("LIST23363");
sec->set_market(Qot_Common::QotMarket::QotMarket_HK_Security);
m_pQotApi->GetValuationPlateStockList(req);
cout << "GetValuationPlateStockList" << endl;
}
virtual void OnReply_GetValuationPlateStockList(moomoo::u32_t nSerialNo, const Qot_GetValuationPlateStockList::Response &stRsp){
cout << "OnReply_GetValuationPlateStockList:" << endl;
// print response
// ProtoBufToBodyData and UTF8ToLocal refer to tool.h in Samples
string resp_str;
ProtoBufToBodyData(stRsp, resp_str);
cout << UTF8ToLocal(resp_str) << endl;
}
protected:
MMAPI_Qot *m_pQotApi;
};
int32_t main(int32_t argc, char** argv)
{
MMAPI::Init();
{
Program program;
program.Start();
getchar();
}
protobuf::ShutdownProtobufLibrary();
MMAPI::UnInit();
return 0;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
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
- Output
onInitConnect: ret=0 desc=Succeed!
Send Qot_GetValuationPlateStockList seqNo=3
retType: 0
retMsg: ""
errCode: 0
s2c {
count: 69
stockList {
security {
market: 1
code: "08076"
}
valuationVal: -2.3
valuationPercentile: 65.3658536
marketCap: 30296520
name: "SING LEE"
}
stockList {
//...
}
nextKey: "10"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
GetValuationPlateStockList(req);
Description
Get valuation list of constituent stocks for a board or index
Parameters
message C2S
{
required Qot_Common.Security security = 1; // Stock (board or index)
optional Qot_Common.ValuationType valuationType = 2; // Valuation type, refer to Qot_Common.ValuationType, supports 1-3, default 1 (PE)
optional string nextKey = 3; // Pagination key; omit on first request, pass returned nextKey on subsequent; "-1" means no more data
optional int32 num = 4; // Page size, default 10, range 1–50
optional Qot_Common.SortType sortType = 5; // Sort direction, refer to Qot_Common.SortType, default ascending (SortType_Asc=2)
optional Qot_Common.SortField sortId = 6; // Sort column, refer to Qot_Common.SortField: 51=MarketCap (default) 52=Valuation 53=ForwardValuation 54=HistoricalPercentile
optional Qot_Common.Security filterSecurity = 7; // Board filter; valid for index only, filter constituent stocks by board; no filter if omitted
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
2
3
4
5
6
7
8
9
10
11
12
13
14
15
- Security structure, refer to Security
- Return
// Index board entry
message PlateItem
{
optional Qot_Common.Security security = 1; // Stock
optional string name = 2; // Board name
}
// Constituent stock valuation entry
message StockItem
{
optional Qot_Common.Security security = 1; // Stock
optional string name = 6; // Stock name
optional double valuationVal = 2; // Valuation
optional double forwardValue = 3; // Forward valuation, PE and PS only
optional double valuationPercentile = 4; // Historical valuation percentile, value before %, e.g. 12.34 means 12.34%
optional double marketCap = 5; // Market cap
}
message S2C
{
optional int32 count = 1; // Total constituent stock count
repeated StockItem stockList = 2; // Constituent stock valuation list
optional string nextKey = 3; // Pagination key, "-1" means no more data
repeated PlateItem plateList = 4; // Index board/sector list; returned only on first full request for an index
}
message Response
{
required int32 retType = 1 [default = -400]; // Return result, refer to Common.RetType
optional string retMsg = 2; // Return result description
optional int32 errCode = 3; // Error code
optional S2C s2c = 4;
}
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
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
- 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 QotGetValuationPlateStockList(){
const { RetType } = Common
const { QotMarket } = Qot_Common
let [addr, port, enable_ssl, key] = ["127.0.0.1", 33333, false, '7522027ccf5a06b1'];
let websocket = new mmWebsocket();
websocket.onlogin = (ret, msg)=>{
if (ret) {
const req = {
c2s: {
security: {
market: QotMarket.QotMarket_HK_Security,
code: "LIST23363",
},
},
};
websocket.GetValuationPlateStockList(req)
.then((res) => {
let { errCode, retMsg, retType,s2c } = res
console.log("GetValuationPlateStockList: errCode %d, retMsg %s, retType %d", errCode, retMsg, retType);
if(retType == RetType.RetType_Succeed){
let data = beautify(JSON.stringify(s2c), {
indent_size: 2,
space_in_empty_paren: true,
});
console.log(data);
}
})
.catch((error) => {
console.log("error:", error);
});
} else {
console.log("error", msg);
}
};
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
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
- Output
GetValuationPlateStockList: errCode 0, retMsg , retType 0
{
"count": 69,
"stockList": [{
"security": {
"market": 1,
"code": "08076"
},
"valuationVal": -2.3,
"valuationPercentile": 65.3376729,
"marketCap": 30296520,
"name": "SING LEE"
//...
}],
"nextKey": "10"
}
stop
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
API Limits
- Up to 30 requests per 30 seconds.
- Supports boards and indexes; individual stocks are not supported.
- For indexes, the first full request additionally returns the associated board list (plate_list).