# Get Institution Distribution
- Python
- Proto
- C#
- Java
- C++
- JavaScript
get_institution_distribution(market, institution_id)
Description
Get institution distribution, returning the specified institution's position value and percentage data by industry classification.
Parameters
Parameter Type Description market Market Market type (HK/US) (required) institution_id int Institution ID (obtained from get_institution_list) (required) 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 industry_id int Industry ID industry_name str Industry name position_value float Holding market value portfolio_pct float Industry proportion (%)
- Data format:
Example
from futu import *
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
# First get institution ID
ret, data, _, _ = quote_ctx.get_institution_list(market=Market.US, count=1)
if ret == RET_OK and len(data) > 0:
inst_id = data.iloc[0]['institution_id']
# Query industry distribution
ret, data = quote_ctx.get_institution_distribution(market=Market.US, institution_id=inst_id)
if ret == RET_OK:
print(data)
else:
print('error:', data)
quote_ctx.close()
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
- Output
industry_id industry_name position_value portfolio_pct
0 6 电子 1319006433351.533936 19.8494
1 26 计算机 992844462205.649048 14.9411
2 12 医药生物 633746255374.343994 9.5371
3 27 互联网与传媒 484195469416.382996 7.2865
4 19 非银金融 481223610387.026001 7.2418
5 N/A 其他 N/A 41.1441
1
2
3
4
5
6
7
2
3
4
5
6
7
# Qot_GetInstitutionDistribution.proto
Description
Get institution holdings industry distribution. Returns the market value and proportion data of the specified institution holdings classified by industry.
Parameters
message C2S {
required int32 market = 1; // Qot_Common.QotMarket
required int32 institutionId = 2; // Institution ID
}
// Industry distribution data item
message IndustryDistributionItem {
optional uint64 industryId = 1; // Industry ID
optional string industryName = 2; // Industry name
optional double positionValue = 3; // Holding market value
optional double portfolioPct = 4; // Industry ratio(%)
}
message S2C {
repeated IndustryDistributionItem dataList = 1; // Data list
}
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;
}
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
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
Protocol ID
3420
uint GetInstitutionDistribution(Qot_GetInstitutionDistribution.Request req);
virtual void OnReply_GetInstitutionDistribution(FTAPI_Conn client, uint nSerialNo, Qot_GetInstitutionDistribution.Response rsp);
Description
Get institution holdings industry distribution. Returns the market value and proportion data of the specified institution holdings classified by industry.
Parameters
message C2S {
required int32 market = 1; // Qot_Common.QotMarket
required int32 institutionId = 2; // Institution ID
}
// Industry distribution data item
message IndustryDistributionItem {
optional uint64 industryId = 1; // Industry ID
optional string industryName = 2; // Industry name
optional double positionValue = 3; // Holding market value
optional double portfolioPct = 4; // Industry ratio(%)
}
message S2C {
repeated IndustryDistributionItem dataList = 1; // Data list
}
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;
}
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
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
- For interface result, refer to RetType
Protocol ID
3420
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;
QotGetInstitutionDistribution.C2S c2s = QotGetInstitutionDistribution.C2S.CreateBuilder()
.SetMarket(11)
.SetInstitutionId(403413)
.Build();
QotGetInstitutionDistribution.Request req = QotGetInstitutionDistribution.Request.CreateBuilder().SetC2S(c2s).Build();
uint seqNo = qot.GetInstitutionDistribution(req);
Console.Write("Send QotGetInstitutionDistribution: {0}
", seqNo);
}
public void OnDisconnect(FTAPI_Conn client, long errCode) {
Console.Write("Qot onDisConnect: {0}
", errCode);
}
public void OnReply_GetInstitutionDistribution(FTAPI_Conn client, uint nSerialNo, QotGetInstitutionDistribution.Response rsp)
{
Console.Write("Reply: QotGetInstitutionDistribution: {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);
}
}
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
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 QotGetInstitutionDistribution: 3
Reply: QotGetInstitutionDistribution: 3
GetInstitutionDistribution: errCode 0, retMsg , retType 0
{
"dataList": [
{ "industryName": "电子", "positionValue": 1377382444141.795, "portfolioPct": 20.4857 },
{ "industryName": "计算机", "positionValue": 1005127353809.240, "portfolioPct": 14.9492 },
{ "industryName": "医药生物", "positionValue": 621853010218.809, "portfolioPct": 9.2488 }
]
}
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
int getInstitutionDistribution(Qot_GetInstitutionDistribution.Request req);
onReply_GetInstitutionDistribution(FTAPI_Conn client, int nSerialNo, Qot_GetInstitutionDistribution.Response rsp)
Description
Get institution holdings industry distribution. Returns the market value and proportion data of the specified institution holdings classified by industry.
Parameters
message C2S {
required int32 market = 1; // Qot_Common.QotMarket
required int32 institutionId = 2; // Institution ID
}
// Industry distribution data item
message IndustryDistributionItem {
optional uint64 industryId = 1; // Industry ID
optional string industryName = 2; // Industry name
optional double positionValue = 3; // Holding market value
optional double portfolioPct = 4; // Industry ratio(%)
}
message S2C {
repeated IndustryDistributionItem dataList = 1; // Data list
}
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;
}
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
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
- For interface result, refer to RetType
Protocol ID
3420
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;
QotGetInstitutionDistribution.C2S c2s = QotGetInstitutionDistribution.C2S.newBuilder()
.setMarket(11)
.setInstitutionId(403413)
.build();
QotGetInstitutionDistribution.Request req = QotGetInstitutionDistribution.Request.newBuilder().setC2S(c2s).build();
int seqNo = qot.getInstitutionDistribution(req);
System.out.printf("Send QotGetInstitutionDistribution: %d
", seqNo);
}
@Override
public void onDisconnect(FTAPI_Conn client, long errCode) {
System.out.printf("Qot onDisConnect: %d
", errCode);
}
@Override
public void onReply_GetInstitutionDistribution(FTAPI_Conn client, int nSerialNo, QotGetInstitutionDistribution.Response rsp) {
if (rsp.getRetType() != 0) {
System.out.printf("QotGetInstitutionDistribution failed: %s
", rsp.getRetMsg());
} else {
try {
String json = JsonFormat.printer().print(rsp);
System.out.printf("Receive QotGetInstitutionDistribution: %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) {
}
}
}
}
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
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 QotGetInstitutionDistribution: 3
Receive QotGetInstitutionDistribution: {
"dataList": [
{ "industryName": "电子", "positionValue": 1377382444141.795, "portfolioPct": 20.4857 },
{ "industryName": "计算机", "positionValue": 1005127353809.240, "portfolioPct": 14.9492 },
{ "industryName": "医药生物", "positionValue": 621853010218.809, "portfolioPct": 9.2488 }
]
}
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
Futu::u32_t GetInstitutionDistribution(const Qot_GetInstitutionDistribution::Request &stReq); virtual void OnReply_GetInstitutionDistribution(Futu::u32_t nSerialNo, const Qot_GetInstitutionDistribution::Response &stRsp) = 0;
Description
Protocol request and response definition
Parameters
message C2S {
required int32 market = 1; // Qot_Common.QotMarket
required int32 institutionId = 2; // Institution ID
}
// Industry distribution data item
message IndustryDistributionItem {
optional uint64 industryId = 1; // Industry ID
optional string industryName = 2; // Industry name
optional double positionValue = 3; // Holding market value
optional double portfolioPct = 4; // Industry ratio(%)
}
message S2C {
repeated IndustryDistributionItem dataList = 1; // Data list
}
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;
}
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
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
- For interface result, refer to RetType
Protocol ID
3420
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_GetInstitutionDistribution::Request req;
Qot_GetInstitutionDistribution::C2S *c2s = req.mutable_c2s();
c2s->set_market(Qot_Common::QotMarket::QotMarket_US_Security);
c2s->set_institutionid(1001); // example institution ID, obtain from GetInstitutionList
m_GetInstitutionDistributionSerialNo = m_pQotApi->GetInstitutionDistribution(req);
}
virtual void OnReply_GetInstitutionDistribution(Futu::u32_t nSerialNo, const Qot_GetInstitutionDistribution::Response &stRsp) {
if (nSerialNo != m_GetInstitutionDistributionSerialNo) return;
string resp_str;
ProtoBufToBodyData(stRsp, resp_str);
cout << UTF8ToLocal(resp_str) << endl;
}
protected:
FTAPI_Qot *m_pQotApi;
Futu::u32_t m_GetInstitutionDistributionSerialNo = 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
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": {
"dataList": [
{
"industryName": "Information Technology",
"holdingValue": 85000000000.0,
"holdingPct": 42.5
}
]
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
getInstitutionDistribution(qotGetInstitutionDistribution)
Description
Get institution holdings industry distribution. Returns the market value and proportion data of the specified institution holdings classified by industry.
Parameters
message C2S {
required int32 market = 1; // Qot_Common.QotMarket
required int32 institutionId = 2; // Institution ID
}
// Industry distribution data item
message IndustryDistributionItem {
optional uint64 industryId = 1; // Industry ID
optional string industryName = 2; // Industry name
optional double positionValue = 3; // Holding market value
optional double portfolioPct = 4; // Industry ratio(%)
}
message S2C {
repeated IndustryDistributionItem dataList = 1; // Data list
}
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;
}
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
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
- For interface result, refer to RetType
Protocol ID
3420
Example
import ftWebsocket from "futu-api";
import { Common, Qot_Common } from "futu-api/proto";
import beautify from "js-beautify";
function QotGetInstitutionDistribution(){
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: { market: 11, institutionId: 403413 },
};
websocket.GetInstitutionDistribution(req)
.then((res)=>{
let { errCode, retMsg, retType, s2c } = res
console.log("GetInstitutionDistribution: 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);
}
QotGetInstitutionDistribution()
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
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
GetInstitutionDistribution: errCode 0, retMsg , retType 0
{
"dataList": [
{ "industryName": "电子", "positionValue": 1377382444141.795, "portfolioPct": 20.4857 },
{ "industryName": "计算机", "positionValue": 1005127353809.240, "portfolioPct": 14.9492 },
{ "industryName": "医药生物", "positionValue": 621853010218.809, "portfolioPct": 9.2488 }
]
}
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
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_institution_distribution(market, institution_id)
Description
Get institution distribution, returning the specified institution's position value and percentage data by industry classification.
Parameters
Parameter Type Description market Market Market type (HK/US) (required) institution_id int Institution ID (obtained from get_institution_list) (required) 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 industry_id int Industry ID industry_name str Industry name position_value float Holding market value portfolio_pct float Industry proportion (%)
- Data format:
Example
from futu import *
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
# First get institution ID
ret, data, _, _ = quote_ctx.get_institution_list(market=Market.US, count=1)
if ret == RET_OK and len(data) > 0:
inst_id = data.iloc[0]['institution_id']
# Query industry distribution
ret, data = quote_ctx.get_institution_distribution(market=Market.US, institution_id=inst_id)
if ret == RET_OK:
print(data)
else:
print('error:', data)
quote_ctx.close()
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
- Output
industry_id industry_name position_value portfolio_pct
0 6 电子 1319006433351.533936 19.8494
1 26 计算机 992844462205.649048 14.9411
2 12 医药生物 633746255374.343994 9.5371
3 27 互联网与传媒 484195469416.382996 7.2865
4 19 非银金融 481223610387.026001 7.2418
5 N/A 其他 N/A 41.1441
1
2
3
4
5
6
7
2
3
4
5
6
7
# Qot_GetInstitutionDistribution.proto
Description
Get institution holdings industry distribution. Returns the market value and proportion data of the specified institution holdings classified by industry.
Parameters
message C2S {
required int32 market = 1; // Qot_Common.QotMarket
required int32 institutionId = 2; // Institution ID
}
// Industry distribution data item
message IndustryDistributionItem {
optional uint64 industryId = 1; // Industry ID
optional string industryName = 2; // Industry name
optional double positionValue = 3; // Holding market value
optional double portfolioPct = 4; // Industry ratio(%)
}
message S2C {
repeated IndustryDistributionItem dataList = 1; // Data list
}
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;
}
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
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
Protocol ID
3420
uint GetInstitutionDistribution(Qot_GetInstitutionDistribution.Request req);
virtual void OnReply_GetInstitutionDistribution(FTAPI_Conn client, uint nSerialNo, Qot_GetInstitutionDistribution.Response rsp);
Description
Get institution holdings industry distribution. Returns the market value and proportion data of the specified institution holdings classified by industry.
Parameters
message C2S {
required int32 market = 1; // Qot_Common.QotMarket
required int32 institutionId = 2; // Institution ID
}
// Industry distribution data item
message IndustryDistributionItem {
optional uint64 industryId = 1; // Industry ID
optional string industryName = 2; // Industry name
optional double positionValue = 3; // Holding market value
optional double portfolioPct = 4; // Industry ratio(%)
}
message S2C {
repeated IndustryDistributionItem dataList = 1; // Data list
}
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;
}
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
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
- For interface result, refer to RetType
Protocol ID
3420
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;
QotGetInstitutionDistribution.C2S c2s = QotGetInstitutionDistribution.C2S.CreateBuilder()
.SetMarket(11)
.SetInstitutionId(403413)
.Build();
QotGetInstitutionDistribution.Request req = QotGetInstitutionDistribution.Request.CreateBuilder().SetC2S(c2s).Build();
uint seqNo = qot.GetInstitutionDistribution(req);
Console.Write("Send QotGetInstitutionDistribution: {0}
", seqNo);
}
public void OnDisconnect(MMAPI_Conn client, long errCode) {
Console.Write("Qot onDisConnect: {0}
", errCode);
}
public void OnReply_GetInstitutionDistribution(MMAPI_Conn client, uint nSerialNo, QotGetInstitutionDistribution.Response rsp)
{
Console.Write("Reply: QotGetInstitutionDistribution: {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);
}
}
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
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 QotGetInstitutionDistribution: 3
Reply: QotGetInstitutionDistribution: 3
GetInstitutionDistribution: errCode 0, retMsg , retType 0
{
"dataList": [
{ "industryName": "电子", "positionValue": 1377382444141.795, "portfolioPct": 20.4857 },
{ "industryName": "计算机", "positionValue": 1005127353809.240, "portfolioPct": 14.9492 },
{ "industryName": "医药生物", "positionValue": 621853010218.809, "portfolioPct": 9.2488 }
]
}
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
int getInstitutionDistribution(Qot_GetInstitutionDistribution.Request req);
onReply_GetInstitutionDistribution(FTAPI_Conn client, int nSerialNo, Qot_GetInstitutionDistribution.Response rsp)
Description
Get institution holdings industry distribution. Returns the market value and proportion data of the specified institution holdings classified by industry.
Parameters
message C2S {
required int32 market = 1; // Qot_Common.QotMarket
required int32 institutionId = 2; // Institution ID
}
// Industry distribution data item
message IndustryDistributionItem {
optional uint64 industryId = 1; // Industry ID
optional string industryName = 2; // Industry name
optional double positionValue = 3; // Holding market value
optional double portfolioPct = 4; // Industry ratio(%)
}
message S2C {
repeated IndustryDistributionItem dataList = 1; // Data list
}
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;
}
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
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
- For interface result, refer to RetType
Protocol ID
3420
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;
QotGetInstitutionDistribution.C2S c2s = QotGetInstitutionDistribution.C2S.newBuilder()
.setMarket(11)
.setInstitutionId(403413)
.build();
QotGetInstitutionDistribution.Request req = QotGetInstitutionDistribution.Request.newBuilder().setC2S(c2s).build();
int seqNo = qot.getInstitutionDistribution(req);
System.out.printf("Send QotGetInstitutionDistribution: %d
", seqNo);
}
@Override
public void onDisconnect(MMAPI_Conn client, long errCode) {
System.out.printf("Qot onDisConnect: %d
", errCode);
}
@Override
public void onReply_GetInstitutionDistribution(MMAPI_Conn client, int nSerialNo, QotGetInstitutionDistribution.Response rsp) {
if (rsp.getRetType() != 0) {
System.out.printf("QotGetInstitutionDistribution failed: %s
", rsp.getRetMsg());
} else {
try {
String json = JsonFormat.printer().print(rsp);
System.out.printf("Receive QotGetInstitutionDistribution: %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) {
}
}
}
}
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
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 QotGetInstitutionDistribution: 3
Receive QotGetInstitutionDistribution: {
"dataList": [
{ "industryName": "电子", "positionValue": 1377382444141.795, "portfolioPct": 20.4857 },
{ "industryName": "计算机", "positionValue": 1005127353809.240, "portfolioPct": 14.9492 },
{ "industryName": "医药生物", "positionValue": 621853010218.809, "portfolioPct": 9.2488 }
]
}
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
moomoo::u32_t GetInstitutionDistribution(const Qot_GetInstitutionDistribution::Request &stReq); virtual void OnReply_GetInstitutionDistribution(moomoo::u32_t nSerialNo, const Qot_GetInstitutionDistribution::Response &stRsp) = 0;
Description
Protocol request and response definition
Parameters
message C2S {
required int32 market = 1; // Qot_Common.QotMarket
required int32 institutionId = 2; // Institution ID
}
// Industry distribution data item
message IndustryDistributionItem {
optional uint64 industryId = 1; // Industry ID
optional string industryName = 2; // Industry name
optional double positionValue = 3; // Holding market value
optional double portfolioPct = 4; // Industry ratio(%)
}
message S2C {
repeated IndustryDistributionItem dataList = 1; // Data list
}
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;
}
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
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
- For interface result, refer to RetType
Protocol ID
3420
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_GetInstitutionDistribution::Request req;
Qot_GetInstitutionDistribution::C2S *c2s = req.mutable_c2s();
c2s->set_market(Qot_Common::QotMarket::QotMarket_US_Security);
c2s->set_institutionid(1001); // example institution ID, obtain from GetInstitutionList
m_GetInstitutionDistributionSerialNo = m_pQotApi->GetInstitutionDistribution(req);
}
virtual void OnReply_GetInstitutionDistribution(moomoo::u32_t nSerialNo, const Qot_GetInstitutionDistribution::Response &stRsp) {
if (nSerialNo != m_GetInstitutionDistributionSerialNo) return;
string resp_str;
ProtoBufToBodyData(stRsp, resp_str);
cout << UTF8ToLocal(resp_str) << endl;
}
protected:
MMAPI_Qot *m_pQotApi;
moomoo::u32_t m_GetInstitutionDistributionSerialNo = 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
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": {
"dataList": [
{
"industryName": "Information Technology",
"holdingValue": 85000000000.0,
"holdingPct": 42.5
}
]
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
getInstitutionDistribution(qotGetInstitutionDistribution)
Description
Get institution holdings industry distribution. Returns the market value and proportion data of the specified institution holdings classified by industry.
Parameters
message C2S {
required int32 market = 1; // Qot_Common.QotMarket
required int32 institutionId = 2; // Institution ID
}
// Industry distribution data item
message IndustryDistributionItem {
optional uint64 industryId = 1; // Industry ID
optional string industryName = 2; // Industry name
optional double positionValue = 3; // Holding market value
optional double portfolioPct = 4; // Industry ratio(%)
}
message S2C {
repeated IndustryDistributionItem dataList = 1; // Data list
}
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;
}
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
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
- For interface result, refer to RetType
Protocol ID
3420
Example
import mmWebsocket from "moomoo-api";
import { Common, Qot_Common } from "moomoo-api/proto";
import beautify from "js-beautify";
function QotGetInstitutionDistribution(){
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: { market: 11, institutionId: 403413 },
};
websocket.GetInstitutionDistribution(req)
.then((res)=>{
let { errCode, retMsg, retType, s2c } = res
console.log("GetInstitutionDistribution: 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);
}
QotGetInstitutionDistribution()
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
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
GetInstitutionDistribution: errCode 0, retMsg , retType 0
{
"dataList": [
{ "industryName": "电子", "positionValue": 1377382444141.795, "portfolioPct": 20.4857 },
{ "industryName": "计算机", "positionValue": 1005127353809.240, "portfolioPct": 14.9492 },
{ "industryName": "医药生物", "positionValue": 621853010218.809, "portfolioPct": 9.2488 }
]
}
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
API Limits
- Maximum 60 requests within 30 seconds
- Only the first page of paginated requests counts towards rate limiting