# Get Research Analyst Consensus
- Python
- Proto
- C#
- Java
- C++
- JavaScript
get_research_analyst_consensus(code)
Description
Get the analyst consensus rating, target price range and rating distribution for the specified stock over the past 3 months
Parameters
Parameter Type Description code str Stock code Return
Parameter Type Description ret RET_CODE API call result data dict If ret == RET_OK, returns analyst consensus data dict str If ret != RET_OK, returns error description The returned dict contains the following fields:
Field Type Description highest float Highest target price average float Average target price lowest float Lowest target price rating ResearchRatingType Consensus rating Analyst consensus rating over the past 3 months
0=Unknown, 1=Sell, 2=Underperform, 3=Hold, 4=Buy, 5=StrongBuy
US stocks only return Sell(1)/Hold(3)/Buy(4); non-US markets also support Underperform(2)/StrongBuy(5)total int Total analyst count Total number of analysts who submitted ratings in the past 3 monthsupdate_time int Update timestamp Seconds; timestamp of when rating data was updatedupdate_time_str str Update date Format YYYY-MM-DD, in the market's timezonebuy float Buy rating ratio Value before the percent sign, e.g. 12.34 means 12.34%hold float Hold rating ratio Value before the percent sign, e.g. 12.34 means 12.34%sell float Sell rating ratio Value before the percent sign, e.g. 12.34 means 12.34%strong_buy float Strong Buy ratio Value before the percent sign, e.g. 12.34 means 12.34%; non-US markets onlyunderperform float Underperform ratio Value before the percent sign, e.g. 12.34 means 12.34%; non-US markets only
Example
import json
from futu import *
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
ret, data = quote_ctx.get_research_analyst_consensus("HK.00700")
if ret == RET_OK:
print(json.dumps(data, indent=2, ensure_ascii=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
{
"highest": 820.0,
"average": 716.0,
"lowest": 579.51,
"rating": 5,
"total": 44,
"update_time": 1778469178,
"update_time_str": "2026-05-11",
"buy": 22.727,
"hold": 0.0,
"sell": 0.0,
"strong_buy": 77.273,
"underperform": 0.0
}
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
# Qot_GetResearchAnalystConsensus.proto
Description
Get research analyst consensus
Parameters
message C2S
{
required Qot_Common.Security security = 1; // Stock
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
- Security structure: refer to Security
- Return
message S2C
{
optional double highest = 1; // Highest target price
optional double average = 2; // Average target price
optional double lowest = 3; // Lowest target price
optional Qot_Common.ResearchRatingType rating = 4; // Analyst consensus rating over the past 3 months, see Qot_Common.ResearchRatingType; US stocks only return Sell(1)/Hold(3)/Buy(4), non-US markets also support Underperform(2)/StrongBuy(5)
optional int32 total = 5; // Total number of analysts who submitted ratings in the past 3 months
optional int64 updateTime = 6; // Rating data update timestamp (seconds)
optional string updateTimeStr = 7; // Rating data update date string, format YYYY-MM-DD, in the market's timezone
optional double buy = 8; // Buy rating ratio, value before the percent sign, e.g. 12.34 means 12.34%
optional double hold = 9; // Hold rating ratio, value before the percent sign, e.g. 12.34 means 12.34%
optional double sell = 10; // Sell rating ratio, value before the percent sign, e.g. 12.34 means 12.34%
// The following fields are only supported in non-US markets
optional double strongBuy = 11; // Strong Buy rating ratio, value before the percent sign, e.g. 12.34 means 12.34%; non-US markets only
optional double underperform = 12; // Underperform rating ratio, value before the percent sign, e.g. 12.34 means 12.34%; non-US markets only
}
message Response
{
required int32 retType = 1 [default = -400]; // Return result, see 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
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
- API call result: refer to RetType
- Analyst consensus rating: refer to ResearchRatingType
Protocol ID
3229
uint GetResearchAnalystConsensus(QotGetResearchAnalystConsensus.Request req);
virtual void OnReply_GetResearchAnalystConsensus(FTAPI_Conn client, uint nSerialNo, QotGetResearchAnalystConsensus.Response rsp);
Description
Get research analyst consensus
Parameters
message C2S
{
required Qot_Common.Security security = 1; // Stock
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
- Security structure: refer to Security
- Return
message S2C
{
optional double highest = 1; // Highest target price
optional double average = 2; // Average target price
optional double lowest = 3; // Lowest target price
optional Qot_Common.ResearchRatingType rating = 4; // Analyst consensus rating over the past 3 months
optional int32 total = 5; // Total number of analysts who submitted ratings in the past 3 months
optional int64 updateTime = 6; // Rating data update timestamp (seconds)
optional string updateTimeStr = 7; // Rating data update date string, format YYYY-MM-DD
optional double buy = 8; // Buy rating ratio, value before the percent sign, e.g. 12.34 means 12.34%
optional double hold = 9; // Hold rating ratio, value before the percent sign, e.g. 12.34 means 12.34%
optional double sell = 10; // Sell rating ratio, value before the percent sign, e.g. 12.34 means 12.34%
optional double strongBuy = 11; // Strong Buy rating ratio, value before the percent sign, e.g. 12.34 means 12.34%; non-US markets only
optional double underperform = 12; // Underperform rating ratio, value before the percent sign, e.g. 12.34 means 12.34%; non-US markets only
}
message Response
{
required int32 retType = 1 [default = -400]; // Return result, see 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
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
- API call result: refer to RetType
- Analyst consensus rating: refer to ResearchRatingType
- 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("00700")
.Build();
QotGetResearchAnalystConsensus.C2S c2s = QotGetResearchAnalystConsensus.C2S.CreateBuilder()
.SetSecurity(sec)
.Build();
QotGetResearchAnalystConsensus.Request req = QotGetResearchAnalystConsensus.Request.CreateBuilder().SetC2S(c2s).Build();
uint seqNo = qot.GetResearchAnalystConsensus(req);
Console.Write("Send QotGetResearchAnalystConsensus: {0}\n", seqNo);
}
public void OnDisconnect(FTAPI_Conn client, long errCode)
{
Console.Write("Qot onDisConnect: {0}\n", errCode);
}
public void OnReply_GetResearchAnalystConsensus(FTAPI_Conn client, uint nSerialNo, QotGetResearchAnalystConsensus.Response rsp)
{
Console.Write("Reply: QotGetResearchAnalystConsensus: {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 {
highest: 820
average: 716
lowest: 579.51
rating: ResearchRatingType_StrongBuy
total: 44
updateTime: 1778414778
updateTimeStr: "2026-05-10"
buy: 22.727
hold: 0
sell: 0
strongBuy: 77.273
underperform: 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
int getResearchAnalystConsensus(QotGetResearchAnalystConsensus.Request req);
void onReply_GetResearchAnalystConsensus(FTAPI_Conn client, int nSerialNo, QotGetResearchAnalystConsensus.Response rsp);
Description
Get research analyst consensus
Parameters
message C2S
{
required Qot_Common.Security security = 1; // Stock
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
- Security structure: refer to Security
- Return
message S2C
{
optional double highest = 1; // Highest target price
optional double average = 2; // Average target price
optional double lowest = 3; // Lowest target price
optional Qot_Common.ResearchRatingType rating = 4; // Analyst consensus rating over the past 3 months
optional int32 total = 5; // Total number of analysts who submitted ratings in the past 3 months
optional int64 updateTime = 6; // Rating data update timestamp (seconds)
optional string updateTimeStr = 7; // Rating data update date string, format YYYY-MM-DD
optional double buy = 8; // Buy rating ratio, value before the percent sign, e.g. 12.34 means 12.34%
optional double hold = 9; // Hold rating ratio, value before the percent sign, e.g. 12.34 means 12.34%
optional double sell = 10; // Sell rating ratio, value before the percent sign, e.g. 12.34 means 12.34%
optional double strongBuy = 11; // Strong Buy rating ratio, value before the percent sign, e.g. 12.34 means 12.34%; non-US markets only
optional double underperform = 12; // Underperform rating ratio, value before the percent sign, e.g. 12.34 means 12.34%; non-US markets only
}
message Response
{
required int32 retType = 1 [default = -400]; // Return result, see 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
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
- API call result: refer to RetType
- Analyst consensus rating: refer to ResearchRatingType
- 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("00700")
.build();
QotGetResearchAnalystConsensus.C2S c2s = QotGetResearchAnalystConsensus.C2S.newBuilder()
.setSecurity(sec)
.build();
QotGetResearchAnalystConsensus.Request req = QotGetResearchAnalystConsensus.Request.newBuilder().setC2S(c2s).build();
int seqNo = qot.getResearchAnalystConsensus(req);
System.out.printf("Send QotGetResearchAnalystConsensus: %d\n", seqNo);
}
@Override
public void onDisconnect(FTAPI_Conn client, long errCode) {
System.out.printf("Qot onDisConnect: %d\n", errCode);
}
@Override
public void onReply_GetResearchAnalystConsensus(FTAPI_Conn client, int nSerialNo, QotGetResearchAnalystConsensus.Response rsp) {
if (rsp.getRetType() != 0) {
System.out.printf("QotGetResearchAnalystConsensus failed: %s\n", rsp.getRetMsg());
}
else {
try {
String json = JsonFormat.printer().print(rsp);
System.out.printf("Receive QotGetResearchAnalystConsensus: %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=7459212574907411306
Send Qot_GetResearchAnalystConsensus: 2
Receive Qot_GetResearchAnalystConsensus: retType: 0
retMsg: ""
errCode: 0
s2c {
highest: 820.0
average: 716.0
lowest: 579.51
rating: ResearchRatingType_StrongBuy
total: 44
updateTime: 1778414778
updateTimeStr: "2026-05-10"
buy: 22.727
hold: 0.0
sell: 0.0
strongBuy: 77.273
underperform: 0.0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
Futu::u32_t GetResearchAnalystConsensus(const Qot_GetResearchAnalystConsensus::Request &stReq);
virtual void OnReply_GetResearchAnalystConsensus(Futu::u32_t nSerialNo, const Qot_GetResearchAnalystConsensus::Response &stRsp) = 0;
Description
Get research analyst consensus
Parameters
message C2S
{
required Qot_Common.Security security = 1; // Stock
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
- Security structure: refer to Security
- Return
message S2C
{
optional double highest = 1; // Highest target price
optional double average = 2; // Average target price
optional double lowest = 3; // Lowest target price
optional Qot_Common.ResearchRatingType rating = 4; // Analyst consensus rating over the past 3 months
optional int32 total = 5; // Total number of analysts who submitted ratings in the past 3 months
optional int64 updateTime = 6; // Rating data update timestamp (seconds)
optional string updateTimeStr = 7; // Rating data update date string, format YYYY-MM-DD
optional double buy = 8; // Buy rating ratio, value before the percent sign, e.g. 12.34 means 12.34%
optional double hold = 9; // Hold rating ratio, value before the percent sign, e.g. 12.34 means 12.34%
optional double sell = 10; // Sell rating ratio, value before the percent sign, e.g. 12.34 means 12.34%
optional double strongBuy = 11; // Strong Buy rating ratio, value before the percent sign, e.g. 12.34 means 12.34%; non-US markets only
optional double underperform = 12; // Underperform rating ratio, value before the percent sign, e.g. 12.34 means 12.34%; non-US markets only
}
message Response
{
required int32 retType = 1 [default = -400]; // Return result, see 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
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
- API call result: refer to RetType
- Analyst consensus rating: refer to ResearchRatingType
- 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_GetResearchAnalystConsensus::Request req;
Qot_GetResearchAnalystConsensus::C2S *c2s = req.mutable_c2s();
Qot_Common::Security *sec = c2s->mutable_security();
sec->set_code("00700");
sec->set_market(Qot_Common::QotMarket::QotMarket_HK_Security);
m_pQotApi->GetResearchAnalystConsensus(req);
cout << "GetResearchAnalystConsensus" << endl;
}
virtual void OnReply_GetResearchAnalystConsensus(Futu::u32_t nSerialNo, const Qot_GetResearchAnalystConsensus::Response &stRsp){
cout << "OnReply_GetResearchAnalystConsensus:" << 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_GetResearchAnalystConsensus seqNo=3
retType: 0
retMsg: ""
errCode: 0
s2c {
highest: 820
average: 716
lowest: 579.51
rating: ResearchRatingType_StrongBuy
total: 44
updateTime: 1778414778
updateTimeStr: "2026-05-10"
buy: 22.727
hold: 0
sell: 0
strongBuy: 77.273
underperform: 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
GetResearchAnalystConsensus(req);
Description
Get research analyst consensus
Parameters
message C2S
{
required Qot_Common.Security security = 1; // Stock
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
- Security structure: refer to Security
- Return
message S2C
{
optional double highest = 1; // Highest target price
optional double average = 2; // Average target price
optional double lowest = 3; // Lowest target price
optional Qot_Common.ResearchRatingType rating = 4; // Analyst consensus rating over the past 3 months
optional int32 total = 5; // Total number of analysts who submitted ratings in the past 3 months
optional int64 updateTime = 6; // Rating data update timestamp (seconds)
optional string updateTimeStr = 7; // Rating data update date string, format YYYY-MM-DD
optional double buy = 8; // Buy rating ratio, value before the percent sign, e.g. 12.34 means 12.34%
optional double hold = 9; // Hold rating ratio, value before the percent sign, e.g. 12.34 means 12.34%
optional double sell = 10; // Sell rating ratio, value before the percent sign, e.g. 12.34 means 12.34%
optional double strongBuy = 11; // Strong Buy rating ratio, value before the percent sign, e.g. 12.34 means 12.34%; non-US markets only
optional double underperform = 12; // Underperform rating ratio, value before the percent sign, e.g. 12.34 means 12.34%; non-US markets only
}
message Response
{
required int32 retType = 1 [default = -400]; // Return result, see 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
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
- API call result: refer to RetType
- Analyst consensus rating: refer to ResearchRatingType
- Example
import ftWebsocket from "futu-api";
import { Common, Qot_Common } from "futu-api/proto";
import beautify from "js-beautify";
function QotGetResearchAnalystConsensus(){
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: "00700",
},
},
};
websocket.GetResearchAnalystConsensus(req)
.then((res) => {
let { errCode, retMsg, retType,s2c } = res
console.log("GetResearchAnalystConsensus: 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
GetResearchAnalystConsensus: errCode 0, retMsg , retType 0
{
"highest": 820,
"average": 716,
"lowest": 579.51,
"rating": "ResearchRatingType_StrongBuy",
"total": 44,
"updateTime": "1778428897",
"updateTimeStr": "2026-05-11",
"buy": 22.727,
"hold": 0,
"sell": 0,
"strongBuy": 77.273,
"underperform": 0
}
stop
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
API Limitations
- Maximum 30 requests per 30 seconds.
- Supports common stocks and REITs.
- Python
- Proto
- C#
- Java
- C++
- JavaScript
get_research_analyst_consensus(code)
Description
Get the analyst consensus rating, target price range and rating distribution for the specified stock over the past 3 months
Parameters
Parameter Type Description code str Stock code Return
Parameter Type Description ret RET_CODE API call result data dict If ret == RET_OK, returns analyst consensus data dict str If ret != RET_OK, returns error description The returned dict contains the following fields:
Field Type Description highest float Highest target price average float Average target price lowest float Lowest target price rating ResearchRatingType Consensus rating Analyst consensus rating over the past 3 months
0=Unknown, 1=Sell, 2=Underperform, 3=Hold, 4=Buy, 5=StrongBuy
US stocks only return Sell(1)/Hold(3)/Buy(4); non-US markets also support Underperform(2)/StrongBuy(5)total int Total analyst count Total number of analysts who submitted ratings in the past 3 monthsupdate_time int Update timestamp Seconds; timestamp of when rating data was updatedupdate_time_str str Update date Format YYYY-MM-DD, in the market's timezonebuy float Buy rating ratio Value before the percent sign, e.g. 12.34 means 12.34%hold float Hold rating ratio Value before the percent sign, e.g. 12.34 means 12.34%sell float Sell rating ratio Value before the percent sign, e.g. 12.34 means 12.34%strong_buy float Strong Buy ratio Value before the percent sign, e.g. 12.34 means 12.34%; non-US markets onlyunderperform float Underperform ratio Value before the percent sign, e.g. 12.34 means 12.34%; non-US markets only
Example
import json
from moomoo import *
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
ret, data = quote_ctx.get_research_analyst_consensus("HK.00700")
if ret == RET_OK:
print(json.dumps(data, indent=2, ensure_ascii=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
{
"highest": 820.0,
"average": 716.0,
"lowest": 579.51,
"rating": 5,
"total": 44,
"update_time": 1778469178,
"update_time_str": "2026-05-11",
"buy": 22.727,
"hold": 0.0,
"sell": 0.0,
"strong_buy": 77.273,
"underperform": 0.0
}
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
# Qot_GetResearchAnalystConsensus.proto
Description
Get research analyst consensus
Parameters
message C2S
{
required Qot_Common.Security security = 1; // Stock
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
- Security structure: refer to Security
- Return
message S2C
{
optional double highest = 1; // Highest target price
optional double average = 2; // Average target price
optional double lowest = 3; // Lowest target price
optional Qot_Common.ResearchRatingType rating = 4; // Analyst consensus rating over the past 3 months, see Qot_Common.ResearchRatingType; US stocks only return Sell(1)/Hold(3)/Buy(4), non-US markets also support Underperform(2)/StrongBuy(5)
optional int32 total = 5; // Total number of analysts who submitted ratings in the past 3 months
optional int64 updateTime = 6; // Rating data update timestamp (seconds)
optional string updateTimeStr = 7; // Rating data update date string, format YYYY-MM-DD, in the market's timezone
optional double buy = 8; // Buy rating ratio, value before the percent sign, e.g. 12.34 means 12.34%
optional double hold = 9; // Hold rating ratio, value before the percent sign, e.g. 12.34 means 12.34%
optional double sell = 10; // Sell rating ratio, value before the percent sign, e.g. 12.34 means 12.34%
// The following fields are only supported in non-US markets
optional double strongBuy = 11; // Strong Buy rating ratio, value before the percent sign, e.g. 12.34 means 12.34%; non-US markets only
optional double underperform = 12; // Underperform rating ratio, value before the percent sign, e.g. 12.34 means 12.34%; non-US markets only
}
message Response
{
required int32 retType = 1 [default = -400]; // Return result, see 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
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
- API call result: refer to RetType
- Analyst consensus rating: refer to ResearchRatingType
Protocol ID
3229
uint GetResearchAnalystConsensus(QotGetResearchAnalystConsensus.Request req);
virtual void OnReply_GetResearchAnalystConsensus(MMAPI_Conn client, uint nSerialNo, QotGetResearchAnalystConsensus.Response rsp);
Description
Get research analyst consensus
Parameters
message C2S
{
required Qot_Common.Security security = 1; // Stock
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
- Security structure: refer to Security
- Return
message S2C
{
optional double highest = 1; // Highest target price
optional double average = 2; // Average target price
optional double lowest = 3; // Lowest target price
optional Qot_Common.ResearchRatingType rating = 4; // Analyst consensus rating over the past 3 months
optional int32 total = 5; // Total number of analysts who submitted ratings in the past 3 months
optional int64 updateTime = 6; // Rating data update timestamp (seconds)
optional string updateTimeStr = 7; // Rating data update date string, format YYYY-MM-DD
optional double buy = 8; // Buy rating ratio, value before the percent sign, e.g. 12.34 means 12.34%
optional double hold = 9; // Hold rating ratio, value before the percent sign, e.g. 12.34 means 12.34%
optional double sell = 10; // Sell rating ratio, value before the percent sign, e.g. 12.34 means 12.34%
optional double strongBuy = 11; // Strong Buy rating ratio, value before the percent sign, e.g. 12.34 means 12.34%; non-US markets only
optional double underperform = 12; // Underperform rating ratio, value before the percent sign, e.g. 12.34 means 12.34%; non-US markets only
}
message Response
{
required int32 retType = 1 [default = -400]; // Return result, see 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
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
- API call result: refer to RetType
- Analyst consensus rating: refer to ResearchRatingType
- 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("00700")
.Build();
QotGetResearchAnalystConsensus.C2S c2s = QotGetResearchAnalystConsensus.C2S.CreateBuilder()
.SetSecurity(sec)
.Build();
QotGetResearchAnalystConsensus.Request req = QotGetResearchAnalystConsensus.Request.CreateBuilder().SetC2S(c2s).Build();
uint seqNo = qot.GetResearchAnalystConsensus(req);
Console.Write("Send QotGetResearchAnalystConsensus: {0}\n", seqNo);
}
public void OnDisconnect(MMAPI_Conn client, long errCode)
{
Console.Write("Qot onDisConnect: {0}\n", errCode);
}
public void OnReply_GetResearchAnalystConsensus(MMAPI_Conn client, uint nSerialNo, QotGetResearchAnalystConsensus.Response rsp)
{
Console.Write("Reply: QotGetResearchAnalystConsensus: {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 {
highest: 820
average: 716
lowest: 579.51
rating: ResearchRatingType_StrongBuy
total: 44
updateTime: 1778414778
updateTimeStr: "2026-05-10"
buy: 22.727
hold: 0
sell: 0
strongBuy: 77.273
underperform: 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
int getResearchAnalystConsensus(QotGetResearchAnalystConsensus.Request req);
void onReply_GetResearchAnalystConsensus(MMAPI_Conn client, int nSerialNo, QotGetResearchAnalystConsensus.Response rsp);
Description
Get research analyst consensus
Parameters
message C2S
{
required Qot_Common.Security security = 1; // Stock
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
- Security structure: refer to Security
- Return
message S2C
{
optional double highest = 1; // Highest target price
optional double average = 2; // Average target price
optional double lowest = 3; // Lowest target price
optional Qot_Common.ResearchRatingType rating = 4; // Analyst consensus rating over the past 3 months
optional int32 total = 5; // Total number of analysts who submitted ratings in the past 3 months
optional int64 updateTime = 6; // Rating data update timestamp (seconds)
optional string updateTimeStr = 7; // Rating data update date string, format YYYY-MM-DD
optional double buy = 8; // Buy rating ratio, value before the percent sign, e.g. 12.34 means 12.34%
optional double hold = 9; // Hold rating ratio, value before the percent sign, e.g. 12.34 means 12.34%
optional double sell = 10; // Sell rating ratio, value before the percent sign, e.g. 12.34 means 12.34%
optional double strongBuy = 11; // Strong Buy rating ratio, value before the percent sign, e.g. 12.34 means 12.34%; non-US markets only
optional double underperform = 12; // Underperform rating ratio, value before the percent sign, e.g. 12.34 means 12.34%; non-US markets only
}
message Response
{
required int32 retType = 1 [default = -400]; // Return result, see 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
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
- API call result: refer to RetType
- Analyst consensus rating: refer to ResearchRatingType
- 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("00700")
.build();
QotGetResearchAnalystConsensus.C2S c2s = QotGetResearchAnalystConsensus.C2S.newBuilder()
.setSecurity(sec)
.build();
QotGetResearchAnalystConsensus.Request req = QotGetResearchAnalystConsensus.Request.newBuilder().setC2S(c2s).build();
int seqNo = qot.getResearchAnalystConsensus(req);
System.out.printf("Send QotGetResearchAnalystConsensus: %d\n", seqNo);
}
@Override
public void onDisconnect(MMAPI_Conn client, long errCode) {
System.out.printf("Qot onDisConnect: %d\n", errCode);
}
@Override
public void onReply_GetResearchAnalystConsensus(MMAPI_Conn client, int nSerialNo, QotGetResearchAnalystConsensus.Response rsp) {
if (rsp.getRetType() != 0) {
System.out.printf("QotGetResearchAnalystConsensus failed: %s\n", rsp.getRetMsg());
}
else {
try {
String json = JsonFormat.printer().print(rsp);
System.out.printf("Receive QotGetResearchAnalystConsensus: %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=7459212574907411306
Send Qot_GetResearchAnalystConsensus: 2
Receive Qot_GetResearchAnalystConsensus: retType: 0
retMsg: ""
errCode: 0
s2c {
highest: 820.0
average: 716.0
lowest: 579.51
rating: ResearchRatingType_StrongBuy
total: 44
updateTime: 1778414778
updateTimeStr: "2026-05-10"
buy: 22.727
hold: 0.0
sell: 0.0
strongBuy: 77.273
underperform: 0.0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
moomoo::u32_t GetResearchAnalystConsensus(const Qot_GetResearchAnalystConsensus::Request &stReq);
virtual void OnReply_GetResearchAnalystConsensus(moomoo::u32_t nSerialNo, const Qot_GetResearchAnalystConsensus::Response &stRsp) = 0;
Description
Get research analyst consensus
Parameters
message C2S
{
required Qot_Common.Security security = 1; // Stock
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
- Security structure: refer to Security
- Return
message S2C
{
optional double highest = 1; // Highest target price
optional double average = 2; // Average target price
optional double lowest = 3; // Lowest target price
optional Qot_Common.ResearchRatingType rating = 4; // Analyst consensus rating over the past 3 months
optional int32 total = 5; // Total number of analysts who submitted ratings in the past 3 months
optional int64 updateTime = 6; // Rating data update timestamp (seconds)
optional string updateTimeStr = 7; // Rating data update date string, format YYYY-MM-DD
optional double buy = 8; // Buy rating ratio, value before the percent sign, e.g. 12.34 means 12.34%
optional double hold = 9; // Hold rating ratio, value before the percent sign, e.g. 12.34 means 12.34%
optional double sell = 10; // Sell rating ratio, value before the percent sign, e.g. 12.34 means 12.34%
optional double strongBuy = 11; // Strong Buy rating ratio, value before the percent sign, e.g. 12.34 means 12.34%; non-US markets only
optional double underperform = 12; // Underperform rating ratio, value before the percent sign, e.g. 12.34 means 12.34%; non-US markets only
}
message Response
{
required int32 retType = 1 [default = -400]; // Return result, see 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
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
- API call result: refer to RetType
- Analyst consensus rating: refer to ResearchRatingType
- 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_GetResearchAnalystConsensus::Request req;
Qot_GetResearchAnalystConsensus::C2S *c2s = req.mutable_c2s();
Qot_Common::Security *sec = c2s->mutable_security();
sec->set_code("00700");
sec->set_market(Qot_Common::QotMarket::QotMarket_HK_Security);
m_pQotApi->GetResearchAnalystConsensus(req);
cout << "GetResearchAnalystConsensus" << endl;
}
virtual void OnReply_GetResearchAnalystConsensus(moomoo::u32_t nSerialNo, const Qot_GetResearchAnalystConsensus::Response &stRsp){
cout << "OnReply_GetResearchAnalystConsensus:" << 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_GetResearchAnalystConsensus seqNo=3
retType: 0
retMsg: ""
errCode: 0
s2c {
highest: 820
average: 716
lowest: 579.51
rating: ResearchRatingType_StrongBuy
total: 44
updateTime: 1778414778
updateTimeStr: "2026-05-10"
buy: 22.727
hold: 0
sell: 0
strongBuy: 77.273
underperform: 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
GetResearchAnalystConsensus(req);
Description
Get research analyst consensus
Parameters
message C2S
{
required Qot_Common.Security security = 1; // Stock
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
- Security structure: refer to Security
- Return
message S2C
{
optional double highest = 1; // Highest target price
optional double average = 2; // Average target price
optional double lowest = 3; // Lowest target price
optional Qot_Common.ResearchRatingType rating = 4; // Analyst consensus rating over the past 3 months
optional int32 total = 5; // Total number of analysts who submitted ratings in the past 3 months
optional int64 updateTime = 6; // Rating data update timestamp (seconds)
optional string updateTimeStr = 7; // Rating data update date string, format YYYY-MM-DD
optional double buy = 8; // Buy rating ratio, value before the percent sign, e.g. 12.34 means 12.34%
optional double hold = 9; // Hold rating ratio, value before the percent sign, e.g. 12.34 means 12.34%
optional double sell = 10; // Sell rating ratio, value before the percent sign, e.g. 12.34 means 12.34%
optional double strongBuy = 11; // Strong Buy rating ratio, value before the percent sign, e.g. 12.34 means 12.34%; non-US markets only
optional double underperform = 12; // Underperform rating ratio, value before the percent sign, e.g. 12.34 means 12.34%; non-US markets only
}
message Response
{
required int32 retType = 1 [default = -400]; // Return result, see 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
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
- API call result: refer to RetType
- Analyst consensus rating: refer to ResearchRatingType
- Example
import mmWebsocket from "moomoo-api";
import { Common, Qot_Common } from "moomoo-api/proto";
import beautify from "js-beautify";
function QotGetResearchAnalystConsensus(){
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: "00700",
},
},
};
websocket.GetResearchAnalystConsensus(req)
.then((res) => {
let { errCode, retMsg, retType,s2c } = res
console.log("GetResearchAnalystConsensus: 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
GetResearchAnalystConsensus: errCode 0, retMsg , retType 0
{
"highest": 820,
"average": 716,
"lowest": 579.51,
"rating": "ResearchRatingType_StrongBuy",
"total": 44,
"updateTime": "1778428897",
"updateTimeStr": "2026-05-11",
"buy": 22.727,
"hold": 0,
"sell": 0,
"strongBuy": 77.273,
"underperform": 0
}
stop
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
API Limitations
- Maximum 30 requests per 30 seconds.
- Supports common stocks and REITs.