# Get Industrial Plate Stock
- Python
- Proto
- C#
- Java
- C++
- JavaScript
get_industrial_plate_stock(chain_id=None, plate_id=None, market_list=None, sort_field=None, ascend=None, count=None, page=None)
Description
Get industrial plate constituent stocks, returning the stock list of the specified industrial plate, with support for market filtering, sorting, and pagination.
Parameters
Parameter Type Description chain_id int Industrial chain ID (choose one with plate_id, plate_id takes priority) plate_id int Industrial plate ID (preferred) market_list list[ Market]Market filter (supports HK/US/CN/JP/SG/MY), default all if not provided sort_field PlateStockSortField Sort field, default market cap ascend bool Ascending True / Descending False, default False (descending) count int Per page count [1, 200], default 50 page str Page cursor Return
Parameter Type Description ret RET_CODE API call result data pd.DataFrame When ret == RET_OK, returns data str When ret != RET_OK, returns error description - Data format:
Field Type Description security str Stock code (e.g. 'US.AAPL')name str Stock name
- Data format:
Example
from futu import *
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
ret, data, next_page, all_count = quote_ctx.get_industrial_plate_stock(plate_id=10010508, count=2)
if ret == RET_OK:
print(f'Total count: {all_count}')
print(data)
else:
print('error:', data)
quote_ctx.close()
2
3
4
5
6
7
8
9
10
11
12
- Output
Total count: 111
security name
0 US.NVDA 英伟达
1 US.AAPL 苹果
2
3
4
# Qot_GetIndustrialPlateStock.proto
Description
Get industrial plate constituent stocks. Returns the stock list of the specified industrial plate, with support for market filtering, sorting, and pagination.
Parameters
// Sort field
enum SortField {
SortField_Code = 0; //Code (default)
SortField_ChangeRate = 1; //Change%
SortField_Turnover = 2; //Turnover
SortField_Volume = 3; //Volume
SortField_MarketVal = 4; //Market cap
}
message StockInfo
{
optional Qot_Common.Security security = 1; //Stock
optional string name = 2; //Stock name
}
message C2S
{
optional int64 chainId = 1; //Industry chain ID (choose one with plateId, plateId takes priority)
optional int64 plateId = 2; //Industry plate ID (preferred)
repeated int32 marketList = 3; //Qot_Common.QotMarket market filter (supports HK/US/CN/JP/SG/MY, default all)
optional int32 sortField = 4; //SortField, sort field, default MarketVal (market cap)
optional bool ascend = 5; //Ascending true / descending false, default false (descending)
optional int32 count = 6; //Per page count [1,200], default 50
optional string page = 7; //Page marker, omit for first request, pass page from S2C afterwards
}
message S2C
{
repeated StockInfo stockList = 1; //Constituent stock list
optional string page = 2; //Page marker, returned when more data available
optional int32 allCount = 3; //Total quantity
}
message Request
{
required C2S c2s = 1;
}
message Response
{
required int32 retType = 1 [default = -400]; //RetType, return result
optional string retMsg = 2;
optional int32 errCode = 3;
optional S2C s2c = 4;
}
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
Protocol ID
3431
uint GetIndustrialPlateStock(Qot_GetIndustrialPlateStock.Request req);
virtual void OnReply_GetIndustrialPlateStock(FTAPI_Conn client, uint nSerialNo, Qot_GetIndustrialPlateStock.Response rsp);
Description
Get industrial plate constituent stocks. Returns the stock list of the specified industrial plate, with support for market filtering, sorting, and pagination.
Parameters
// Sort field
enum SortField {
SortField_Code = 0; //Code (default)
SortField_ChangeRate = 1; //Change%
SortField_Turnover = 2; //Turnover
SortField_Volume = 3; //Volume
SortField_MarketVal = 4; //Market cap
}
message StockInfo
{
optional Qot_Common.Security security = 1; //Stock
optional string name = 2; //Stock name
}
message C2S
{
optional int64 chainId = 1; //Industry chain ID (choose one with plateId, plateId takes priority)
optional int64 plateId = 2; //Industry plate ID (preferred)
repeated int32 marketList = 3; //Qot_Common.QotMarket market filter (supports HK/US/CN/JP/SG/MY, default all)
optional int32 sortField = 4; //SortField, sort field, default MarketVal (market cap)
optional bool ascend = 5; //Ascending true / descending false, default false (descending)
optional int32 count = 6; //Per page count [1,200], default 50
optional string page = 7; //Page marker, omit for first request, pass page from S2C afterwards
}
message S2C
{
repeated StockInfo stockList = 1; //Constituent stock list
optional string page = 2; //Page marker, returned when more data available
optional int32 allCount = 3; //Total quantity
}
message Request
{
required C2S c2s = 1;
}
message Response
{
required int32 retType = 1 [default = -400]; //RetType, return result
optional string retMsg = 2;
optional int32 errCode = 3;
optional S2C s2c = 4;
}
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
- For interface result, refer to RetType
Protocol ID
3431
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}
", errCode, desc, client.GetConnectID());
if (errCode != 0)
return;
QotGetIndustrialPlateStock.C2S c2s = QotGetIndustrialPlateStock.C2S.CreateBuilder()
.SetPlateId(10010508)
.SetCount(5)
.Build();
QotGetIndustrialPlateStock.Request req = QotGetIndustrialPlateStock.Request.CreateBuilder().SetC2S(c2s).Build();
uint seqNo = qot.GetIndustrialPlateStock(req);
Console.Write("Send QotGetIndustrialPlateStock: {0}
", seqNo);
}
public void OnDisconnect(FTAPI_Conn client, long errCode) {
Console.Write("Qot onDisConnect: {0}
", errCode);
}
public void OnReply_GetIndustrialPlateStock(FTAPI_Conn client, uint nSerialNo, QotGetIndustrialPlateStock.Response rsp)
{
Console.Write("Reply: QotGetIndustrialPlateStock: {0}
", nSerialNo);
if (rsp.RetType == 0 && rsp.HasS2C)
Console.Write("{0}
", rsp.ToString());
}
public static void Main(String[] args) {
FTAPI.Init();
Program program = new Program();
program.Start();
while (true)
Thread.Sleep(1000 * 600);
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
- Output
Send QotGetIndustrialPlateStock: 3
Reply: QotGetIndustrialPlateStock: 3
GetIndustrialPlateStock: errCode 0, retMsg , retType 0
{
"allCount": 111,
"stockList": [
{ "security": { "market": 11, "code": "NVDA" }, "name": "英伟达" },
{ "security": { "market": 11, "code": "GOOGL" }, "name": "谷歌-A" },
{ "security": { "market": 11, "code": "GOOG" }, "name": "谷歌-C" },
{ "security": { "market": 11, "code": "AAPL" }, "name": "苹果" },
{ "security": { "market": 11, "code": "MSFT" }, "name": "微软" }
]
}
2
3
4
5
6
7
8
9
10
11
12
13
int getIndustrialPlateStock(Qot_GetIndustrialPlateStock.Request req);
onReply_GetIndustrialPlateStock(FTAPI_Conn client, int nSerialNo, Qot_GetIndustrialPlateStock.Response rsp)
Description
Get industrial plate constituent stocks. Returns the stock list of the specified industrial plate, with support for market filtering, sorting, and pagination.
Parameters
// Sort field
enum SortField {
SortField_Code = 0; //Code (default)
SortField_ChangeRate = 1; //Change%
SortField_Turnover = 2; //Turnover
SortField_Volume = 3; //Volume
SortField_MarketVal = 4; //Market cap
}
message StockInfo
{
optional Qot_Common.Security security = 1; //Stock
optional string name = 2; //Stock name
}
message C2S
{
optional int64 chainId = 1; //Industry chain ID (choose one with plateId, plateId takes priority)
optional int64 plateId = 2; //Industry plate ID (preferred)
repeated int32 marketList = 3; //Qot_Common.QotMarket market filter (supports HK/US/CN/JP/SG/MY, default all)
optional int32 sortField = 4; //SortField, sort field, default MarketVal (market cap)
optional bool ascend = 5; //Ascending true / descending false, default false (descending)
optional int32 count = 6; //Per page count [1,200], default 50
optional string page = 7; //Page marker, omit for first request, pass page from S2C afterwards
}
message S2C
{
repeated StockInfo stockList = 1; //Constituent stock list
optional string page = 2; //Page marker, returned when more data available
optional int32 allCount = 3; //Total quantity
}
message Request
{
required C2S c2s = 1;
}
message Response
{
required int32 retType = 1 [default = -400]; //RetType, return result
optional string retMsg = 2;
optional int32 errCode = 3;
optional S2C s2c = 4;
}
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
- For interface result, refer to RetType
Protocol ID
3431
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=%d desc=%s connID=%d
", errCode, desc, client.getConnectID());
if (errCode != 0)
return;
QotGetIndustrialPlateStock.C2S c2s = QotGetIndustrialPlateStock.C2S.newBuilder()
.setPlateId(10010508)
.setCount(5)
.build();
QotGetIndustrialPlateStock.Request req = QotGetIndustrialPlateStock.Request.newBuilder().setC2S(c2s).build();
int seqNo = qot.getIndustrialPlateStock(req);
System.out.printf("Send QotGetIndustrialPlateStock: %d
", seqNo);
}
@Override
public void onDisconnect(FTAPI_Conn client, long errCode) {
System.out.printf("Qot onDisConnect: %d
", errCode);
}
@Override
public void onReply_GetIndustrialPlateStock(FTAPI_Conn client, int nSerialNo, QotGetIndustrialPlateStock.Response rsp) {
if (rsp.getRetType() != 0) {
System.out.printf("QotGetIndustrialPlateStock failed: %s
", rsp.getRetMsg());
} else {
try {
String json = JsonFormat.printer().print(rsp);
System.out.printf("Receive QotGetIndustrialPlateStock: %s
", json);
} catch (InvalidProtocolBufferException e) {
e.printStackTrace();
}
}
}
public static void main(String[] args) {
FTAPI.init();
QotDemo qot = new QotDemo();
qot.start();
while (true) {
try {
Thread.sleep(1000 * 600);
} catch (InterruptedException exc) {
}
}
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
- Output
Send QotGetIndustrialPlateStock: 3
Receive QotGetIndustrialPlateStock: {
"allCount": 111,
"stockList": [
{ "security": { "market": 11, "code": "NVDA" }, "name": "英伟达" },
{ "security": { "market": 11, "code": "GOOGL" }, "name": "谷歌-A" },
{ "security": { "market": 11, "code": "GOOG" }, "name": "谷歌-C" },
{ "security": { "market": 11, "code": "AAPL" }, "name": "苹果" },
{ "security": { "market": 11, "code": "MSFT" }, "name": "微软" }
]
}
2
3
4
5
6
7
8
9
10
11
Futu::u32_t GetIndustrialPlateStock(const Qot_GetIndustrialPlateStock::Request &stReq);
virtual void OnReply_GetIndustrialPlateStock(Futu::u32_t nSerialNo, const Qot_GetIndustrialPlateStock::Response &stRsp) = 0;
Description
Protocol request and response definition
Parameters
// Sort field
enum SortField {
SortField_Code = 0; //Code (default)
SortField_ChangeRate = 1; //Change%
SortField_Turnover = 2; //Turnover
SortField_Volume = 3; //Volume
SortField_MarketVal = 4; //Market cap
}
message StockInfo
{
optional Qot_Common.Security security = 1; //Stock
optional string name = 2; //Stock name
}
message C2S
{
optional int64 chainId = 1; //Industry chain ID (choose one with plateId, plateId takes priority)
optional int64 plateId = 2; //Industry plate ID (preferred)
repeated int32 marketList = 3; //Qot_Common.QotMarket market filter (supports HK/US/CN/JP/SG/MY, default all)
optional int32 sortField = 4; //SortField, sort field, default MarketVal (market cap)
optional bool ascend = 5; //Ascending true / descending false, default false (descending)
optional int32 count = 6; //Per page count [1,200], default 50
optional string page = 7; //Page marker, omit for first request, pass page from S2C afterwards
}
message S2C
{
repeated StockInfo stockList = 1; //Constituent stock list
optional string page = 2; //Page marker, returned when more data available
optional int32 allCount = 3; //Total quantity
}
message Request
{
required C2S c2s = 1;
}
message Response
{
required int32 retType = 1 [default = -400]; //RetType, return result
optional string retMsg = 2;
optional int32 errCode = 3;
optional S2C s2c = 4;
}
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
- For interface result, refer to RetType
Protocol ID
3431
Example
class Program : public FTSPI_Qot, 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) {
Qot_GetIndustrialPlateStock::Request req;
Qot_GetIndustrialPlateStock::C2S *c2s = req.mutable_c2s();
c2s->set_plateid(1234); // example plate ID, obtain from GetIndustrialChainByPlate
c2s->set_count(50);
m_GetIndustrialPlateStockSerialNo = m_pQotApi->GetIndustrialPlateStock(req);
}
virtual void OnReply_GetIndustrialPlateStock(Futu::u32_t nSerialNo, const Qot_GetIndustrialPlateStock::Response &stRsp) {
if (nSerialNo != m_GetIndustrialPlateStockSerialNo) return;
string resp_str;
ProtoBufToBodyData(stRsp, resp_str);
cout << UTF8ToLocal(resp_str) << endl;
}
protected:
FTAPI_Qot *m_pQotApi;
Futu::u32_t m_GetIndustrialPlateStockSerialNo = 0;
};
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
- Output
{
"retType": 0,
"retMsg": "",
"errCode": 0,
"s2c": {
"stockList": [
{
"security": {
"market": 11,
"code": "NVDA"
},
"name": "NVIDIA",
"marketVal": 2150000000000.0
}
],
"allCount": 45
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
getIndustrialPlateStock(qotGetIndustrialPlateStock)
Description
Get industrial plate constituent stocks. Returns the stock list of the specified industrial plate, with support for market filtering, sorting, and pagination.
Parameters
// Sort field
enum SortField {
SortField_Code = 0; //Code (default)
SortField_ChangeRate = 1; //Change%
SortField_Turnover = 2; //Turnover
SortField_Volume = 3; //Volume
SortField_MarketVal = 4; //Market cap
}
message StockInfo
{
optional Qot_Common.Security security = 1; //Stock
optional string name = 2; //Stock name
}
message C2S
{
optional int64 chainId = 1; //Industry chain ID (choose one with plateId, plateId takes priority)
optional int64 plateId = 2; //Industry plate ID (preferred)
repeated int32 marketList = 3; //Qot_Common.QotMarket market filter (supports HK/US/CN/JP/SG/MY, default all)
optional int32 sortField = 4; //SortField, sort field, default MarketVal (market cap)
optional bool ascend = 5; //Ascending true / descending false, default false (descending)
optional int32 count = 6; //Per page count [1,200], default 50
optional string page = 7; //Page marker, omit for first request, pass page from S2C afterwards
}
message S2C
{
repeated StockInfo stockList = 1; //Constituent stock list
optional string page = 2; //Page marker, returned when more data available
optional int32 allCount = 3; //Total quantity
}
message Request
{
required C2S c2s = 1;
}
message Response
{
required int32 retType = 1 [default = -400]; //RetType, return result
optional string retMsg = 2;
optional int32 errCode = 3;
optional S2C s2c = 4;
}
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
- For interface result, refer to RetType
Protocol ID
3431
Example
import ftWebsocket from "futu-api";
import { Common, Qot_Common } from "futu-api/proto";
import beautify from "js-beautify";
function QotGetIndustrialPlateStock(){
const { RetType } = Common
let [addr, port, enable_ssl, key] = ["127.0.0.1", 11111, false, "xxxxxx"];
let websocket = new ftWebsocket();
websocket.onlogin = (ret, msg)=>{
if (ret) {
const req = {
c2s: { plateId: 10010508, count: 5 },
};
websocket.GetIndustrialPlateStock(req)
.then((res)=>{
let { errCode, retMsg, retType, s2c } = res
console.log("GetIndustrialPlateStock: 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("start error", msg);
}
};
websocket.start(addr, port, enable_ssl, key);
setTimeout(()=>{ websocket.stop(); process.exit(); }, 5000);
}
QotGetIndustrialPlateStock()
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
- Output
GetIndustrialPlateStock: errCode 0, retMsg , retType 0
{
"allCount": 111,
"stockList": [
{ "security": { "market": 11, "code": "NVDA" }, "name": "英伟达" },
{ "security": { "market": 11, "code": "GOOGL" }, "name": "谷歌-A" },
{ "security": { "market": 11, "code": "GOOG" }, "name": "谷歌-C" },
{ "security": { "market": 11, "code": "AAPL" }, "name": "苹果" },
{ "security": { "market": 11, "code": "MSFT" }, "name": "微软" }
]
}
2
3
4
5
6
7
8
9
10
11
API Limits
- Maximum 60 requests within 30 seconds
- Only the first page of paginated requests counts towards rate limiting
- Python
- Proto
- C#
- Java
- C++
- JavaScript
get_industrial_plate_stock(chain_id=None, plate_id=None, market_list=None, sort_field=None, ascend=None, count=None, page=None)
Description
Get industrial plate constituent stocks, returning the stock list of the specified industrial plate, with support for market filtering, sorting, and pagination.
Parameters
Parameter Type Description chain_id int Industrial chain ID (choose one with plate_id, plate_id takes priority) plate_id int Industrial plate ID (preferred) market_list list[ Market]Market filter (supports HK/US/CN/JP/SG/MY), default all if not provided sort_field PlateStockSortField Sort field, default market cap ascend bool Ascending True / Descending False, default False (descending) count int Per page count [1, 200], default 50 page str Page cursor Return
Parameter Type Description ret RET_CODE API call result data pd.DataFrame When ret == RET_OK, returns data str When ret != RET_OK, returns error description - Data format:
Field Type Description security str Stock code (e.g. 'US.AAPL')name str Stock name
- Data format:
Example
from futu import *
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
ret, data, next_page, all_count = quote_ctx.get_industrial_plate_stock(plate_id=10010508, count=2)
if ret == RET_OK:
print(f'Total count: {all_count}')
print(data)
else:
print('error:', data)
quote_ctx.close()
2
3
4
5
6
7
8
9
10
11
12
- Output
Total count: 111
security name
0 US.NVDA 英伟达
1 US.AAPL 苹果
2
3
4
# Qot_GetIndustrialPlateStock.proto
Description
Get industrial plate constituent stocks. Returns the stock list of the specified industrial plate, with support for market filtering, sorting, and pagination.
Parameters
// Sort field
enum SortField {
SortField_Code = 0; //Code (default)
SortField_ChangeRate = 1; //Change%
SortField_Turnover = 2; //Turnover
SortField_Volume = 3; //Volume
SortField_MarketVal = 4; //Market cap
}
message StockInfo
{
optional Qot_Common.Security security = 1; //Stock
optional string name = 2; //Stock name
}
message C2S
{
optional int64 chainId = 1; //Industry chain ID (choose one with plateId, plateId takes priority)
optional int64 plateId = 2; //Industry plate ID (preferred)
repeated int32 marketList = 3; //Qot_Common.QotMarket market filter (supports HK/US/CN/JP/SG/MY, default all)
optional int32 sortField = 4; //SortField, sort field, default MarketVal (market cap)
optional bool ascend = 5; //Ascending true / descending false, default false (descending)
optional int32 count = 6; //Per page count [1,200], default 50
optional string page = 7; //Page marker, omit for first request, pass page from S2C afterwards
}
message S2C
{
repeated StockInfo stockList = 1; //Constituent stock list
optional string page = 2; //Page marker, returned when more data available
optional int32 allCount = 3; //Total quantity
}
message Request
{
required C2S c2s = 1;
}
message Response
{
required int32 retType = 1 [default = -400]; //RetType, return result
optional string retMsg = 2;
optional int32 errCode = 3;
optional S2C s2c = 4;
}
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
Protocol ID
3431
uint GetIndustrialPlateStock(Qot_GetIndustrialPlateStock.Request req);
virtual void OnReply_GetIndustrialPlateStock(FTAPI_Conn client, uint nSerialNo, Qot_GetIndustrialPlateStock.Response rsp);
Description
Get industrial plate constituent stocks. Returns the stock list of the specified industrial plate, with support for market filtering, sorting, and pagination.
Parameters
// Sort field
enum SortField {
SortField_Code = 0; //Code (default)
SortField_ChangeRate = 1; //Change%
SortField_Turnover = 2; //Turnover
SortField_Volume = 3; //Volume
SortField_MarketVal = 4; //Market cap
}
message StockInfo
{
optional Qot_Common.Security security = 1; //Stock
optional string name = 2; //Stock name
}
message C2S
{
optional int64 chainId = 1; //Industry chain ID (choose one with plateId, plateId takes priority)
optional int64 plateId = 2; //Industry plate ID (preferred)
repeated int32 marketList = 3; //Qot_Common.QotMarket market filter (supports HK/US/CN/JP/SG/MY, default all)
optional int32 sortField = 4; //SortField, sort field, default MarketVal (market cap)
optional bool ascend = 5; //Ascending true / descending false, default false (descending)
optional int32 count = 6; //Per page count [1,200], default 50
optional string page = 7; //Page marker, omit for first request, pass page from S2C afterwards
}
message S2C
{
repeated StockInfo stockList = 1; //Constituent stock list
optional string page = 2; //Page marker, returned when more data available
optional int32 allCount = 3; //Total quantity
}
message Request
{
required C2S c2s = 1;
}
message Response
{
required int32 retType = 1 [default = -400]; //RetType, return result
optional string retMsg = 2;
optional int32 errCode = 3;
optional S2C s2c = 4;
}
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
- For interface result, refer to RetType
Protocol ID
3431
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}
", errCode, desc, client.GetConnectID());
if (errCode != 0)
return;
QotGetIndustrialPlateStock.C2S c2s = QotGetIndustrialPlateStock.C2S.CreateBuilder()
.SetPlateId(10010508)
.SetCount(5)
.Build();
QotGetIndustrialPlateStock.Request req = QotGetIndustrialPlateStock.Request.CreateBuilder().SetC2S(c2s).Build();
uint seqNo = qot.GetIndustrialPlateStock(req);
Console.Write("Send QotGetIndustrialPlateStock: {0}
", seqNo);
}
public void OnDisconnect(MMAPI_Conn client, long errCode) {
Console.Write("Qot onDisConnect: {0}
", errCode);
}
public void OnReply_GetIndustrialPlateStock(MMAPI_Conn client, uint nSerialNo, QotGetIndustrialPlateStock.Response rsp)
{
Console.Write("Reply: QotGetIndustrialPlateStock: {0}
", nSerialNo);
if (rsp.RetType == 0 && rsp.HasS2C)
Console.Write("{0}
", rsp.ToString());
}
public static void Main(String[] args) {
MMAPI.Init();
Program program = new Program();
program.Start();
while (true)
Thread.Sleep(1000 * 600);
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
- Output
Send QotGetIndustrialPlateStock: 3
Reply: QotGetIndustrialPlateStock: 3
GetIndustrialPlateStock: errCode 0, retMsg , retType 0
{
"allCount": 111,
"stockList": [
{ "security": { "market": 11, "code": "NVDA" }, "name": "英伟达" },
{ "security": { "market": 11, "code": "GOOGL" }, "name": "谷歌-A" },
{ "security": { "market": 11, "code": "GOOG" }, "name": "谷歌-C" },
{ "security": { "market": 11, "code": "AAPL" }, "name": "苹果" },
{ "security": { "market": 11, "code": "MSFT" }, "name": "微软" }
]
}
2
3
4
5
6
7
8
9
10
11
12
13
int getIndustrialPlateStock(Qot_GetIndustrialPlateStock.Request req);
onReply_GetIndustrialPlateStock(FTAPI_Conn client, int nSerialNo, Qot_GetIndustrialPlateStock.Response rsp)
Description
Get industrial plate constituent stocks. Returns the stock list of the specified industrial plate, with support for market filtering, sorting, and pagination.
Parameters
// Sort field
enum SortField {
SortField_Code = 0; //Code (default)
SortField_ChangeRate = 1; //Change%
SortField_Turnover = 2; //Turnover
SortField_Volume = 3; //Volume
SortField_MarketVal = 4; //Market cap
}
message StockInfo
{
optional Qot_Common.Security security = 1; //Stock
optional string name = 2; //Stock name
}
message C2S
{
optional int64 chainId = 1; //Industry chain ID (choose one with plateId, plateId takes priority)
optional int64 plateId = 2; //Industry plate ID (preferred)
repeated int32 marketList = 3; //Qot_Common.QotMarket market filter (supports HK/US/CN/JP/SG/MY, default all)
optional int32 sortField = 4; //SortField, sort field, default MarketVal (market cap)
optional bool ascend = 5; //Ascending true / descending false, default false (descending)
optional int32 count = 6; //Per page count [1,200], default 50
optional string page = 7; //Page marker, omit for first request, pass page from S2C afterwards
}
message S2C
{
repeated StockInfo stockList = 1; //Constituent stock list
optional string page = 2; //Page marker, returned when more data available
optional int32 allCount = 3; //Total quantity
}
message Request
{
required C2S c2s = 1;
}
message Response
{
required int32 retType = 1 [default = -400]; //RetType, return result
optional string retMsg = 2;
optional int32 errCode = 3;
optional S2C s2c = 4;
}
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
- For interface result, refer to RetType
Protocol ID
3431
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=%d desc=%s connID=%d
", errCode, desc, client.getConnectID());
if (errCode != 0)
return;
QotGetIndustrialPlateStock.C2S c2s = QotGetIndustrialPlateStock.C2S.newBuilder()
.setPlateId(10010508)
.setCount(5)
.build();
QotGetIndustrialPlateStock.Request req = QotGetIndustrialPlateStock.Request.newBuilder().setC2S(c2s).build();
int seqNo = qot.getIndustrialPlateStock(req);
System.out.printf("Send QotGetIndustrialPlateStock: %d
", seqNo);
}
@Override
public void onDisconnect(MMAPI_Conn client, long errCode) {
System.out.printf("Qot onDisConnect: %d
", errCode);
}
@Override
public void onReply_GetIndustrialPlateStock(MMAPI_Conn client, int nSerialNo, QotGetIndustrialPlateStock.Response rsp) {
if (rsp.getRetType() != 0) {
System.out.printf("QotGetIndustrialPlateStock failed: %s
", rsp.getRetMsg());
} else {
try {
String json = JsonFormat.printer().print(rsp);
System.out.printf("Receive QotGetIndustrialPlateStock: %s
", json);
} catch (InvalidProtocolBufferException e) {
e.printStackTrace();
}
}
}
public static void main(String[] args) {
MMAPI.init();
QotDemo qot = new QotDemo();
qot.start();
while (true) {
try {
Thread.sleep(1000 * 600);
} catch (InterruptedException exc) {
}
}
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
- Output
Send QotGetIndustrialPlateStock: 3
Receive QotGetIndustrialPlateStock: {
"allCount": 111,
"stockList": [
{ "security": { "market": 11, "code": "NVDA" }, "name": "英伟达" },
{ "security": { "market": 11, "code": "GOOGL" }, "name": "谷歌-A" },
{ "security": { "market": 11, "code": "GOOG" }, "name": "谷歌-C" },
{ "security": { "market": 11, "code": "AAPL" }, "name": "苹果" },
{ "security": { "market": 11, "code": "MSFT" }, "name": "微软" }
]
}
2
3
4
5
6
7
8
9
10
11
moomoo::u32_t GetIndustrialPlateStock(const Qot_GetIndustrialPlateStock::Request &stReq);
virtual void OnReply_GetIndustrialPlateStock(moomoo::u32_t nSerialNo, const Qot_GetIndustrialPlateStock::Response &stRsp) = 0;
Description
Protocol request and response definition
Parameters
// Sort field
enum SortField {
SortField_Code = 0; //Code (default)
SortField_ChangeRate = 1; //Change%
SortField_Turnover = 2; //Turnover
SortField_Volume = 3; //Volume
SortField_MarketVal = 4; //Market cap
}
message StockInfo
{
optional Qot_Common.Security security = 1; //Stock
optional string name = 2; //Stock name
}
message C2S
{
optional int64 chainId = 1; //Industry chain ID (choose one with plateId, plateId takes priority)
optional int64 plateId = 2; //Industry plate ID (preferred)
repeated int32 marketList = 3; //Qot_Common.QotMarket market filter (supports HK/US/CN/JP/SG/MY, default all)
optional int32 sortField = 4; //SortField, sort field, default MarketVal (market cap)
optional bool ascend = 5; //Ascending true / descending false, default false (descending)
optional int32 count = 6; //Per page count [1,200], default 50
optional string page = 7; //Page marker, omit for first request, pass page from S2C afterwards
}
message S2C
{
repeated StockInfo stockList = 1; //Constituent stock list
optional string page = 2; //Page marker, returned when more data available
optional int32 allCount = 3; //Total quantity
}
message Request
{
required C2S c2s = 1;
}
message Response
{
required int32 retType = 1 [default = -400]; //RetType, return result
optional string retMsg = 2;
optional int32 errCode = 3;
optional S2C s2c = 4;
}
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
- For interface result, refer to RetType
Protocol ID
3431
Example
class Program : public MMSPI_Qot, 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) {
Qot_GetIndustrialPlateStock::Request req;
Qot_GetIndustrialPlateStock::C2S *c2s = req.mutable_c2s();
c2s->set_plateid(1234); // example plate ID, obtain from GetIndustrialChainByPlate
c2s->set_count(50);
m_GetIndustrialPlateStockSerialNo = m_pQotApi->GetIndustrialPlateStock(req);
}
virtual void OnReply_GetIndustrialPlateStock(moomoo::u32_t nSerialNo, const Qot_GetIndustrialPlateStock::Response &stRsp) {
if (nSerialNo != m_GetIndustrialPlateStockSerialNo) return;
string resp_str;
ProtoBufToBodyData(stRsp, resp_str);
cout << UTF8ToLocal(resp_str) << endl;
}
protected:
MMAPI_Qot *m_pQotApi;
moomoo::u32_t m_GetIndustrialPlateStockSerialNo = 0;
};
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
- Output
{
"retType": 0,
"retMsg": "",
"errCode": 0,
"s2c": {
"stockList": [
{
"security": {
"market": 11,
"code": "NVDA"
},
"name": "NVIDIA",
"marketVal": 2150000000000.0
}
],
"allCount": 45
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
getIndustrialPlateStock(qotGetIndustrialPlateStock)
Description
Get industrial plate constituent stocks. Returns the stock list of the specified industrial plate, with support for market filtering, sorting, and pagination.
Parameters
// Sort field
enum SortField {
SortField_Code = 0; //Code (default)
SortField_ChangeRate = 1; //Change%
SortField_Turnover = 2; //Turnover
SortField_Volume = 3; //Volume
SortField_MarketVal = 4; //Market cap
}
message StockInfo
{
optional Qot_Common.Security security = 1; //Stock
optional string name = 2; //Stock name
}
message C2S
{
optional int64 chainId = 1; //Industry chain ID (choose one with plateId, plateId takes priority)
optional int64 plateId = 2; //Industry plate ID (preferred)
repeated int32 marketList = 3; //Qot_Common.QotMarket market filter (supports HK/US/CN/JP/SG/MY, default all)
optional int32 sortField = 4; //SortField, sort field, default MarketVal (market cap)
optional bool ascend = 5; //Ascending true / descending false, default false (descending)
optional int32 count = 6; //Per page count [1,200], default 50
optional string page = 7; //Page marker, omit for first request, pass page from S2C afterwards
}
message S2C
{
repeated StockInfo stockList = 1; //Constituent stock list
optional string page = 2; //Page marker, returned when more data available
optional int32 allCount = 3; //Total quantity
}
message Request
{
required C2S c2s = 1;
}
message Response
{
required int32 retType = 1 [default = -400]; //RetType, return result
optional string retMsg = 2;
optional int32 errCode = 3;
optional S2C s2c = 4;
}
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
- For interface result, refer to RetType
Protocol ID
3431
Example
import mmWebsocket from "moomoo-api";
import { Common, Qot_Common } from "moomoo-api/proto";
import beautify from "js-beautify";
function QotGetIndustrialPlateStock(){
const { RetType } = Common
let [addr, port, enable_ssl, key] = ["127.0.0.1", 11111, false, "xxxxxx"];
let websocket = new mmWebsocket();
websocket.onlogin = (ret, msg)=>{
if (ret) {
const req = {
c2s: { plateId: 10010508, count: 5 },
};
websocket.GetIndustrialPlateStock(req)
.then((res)=>{
let { errCode, retMsg, retType, s2c } = res
console.log("GetIndustrialPlateStock: 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("start error", msg);
}
};
websocket.start(addr, port, enable_ssl, key);
setTimeout(()=>{ websocket.stop(); process.exit(); }, 5000);
}
QotGetIndustrialPlateStock()
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
- Output
GetIndustrialPlateStock: errCode 0, retMsg , retType 0
{
"allCount": 111,
"stockList": [
{ "security": { "market": 11, "code": "NVDA" }, "name": "英伟达" },
{ "security": { "market": 11, "code": "GOOGL" }, "name": "谷歌-A" },
{ "security": { "market": 11, "code": "GOOG" }, "name": "谷歌-C" },
{ "security": { "market": 11, "code": "AAPL" }, "name": "苹果" },
{ "security": { "market": 11, "code": "MSFT" }, "name": "微软" }
]
}
2
3
4
5
6
7
8
9
10
11
API Limits
- Maximum 60 requests within 30 seconds
- Only the first page of paginated requests counts towards rate limiting