# Get High Dividend SOE Rank
- Python
- Proto
- C#
- Java
- C++
- JavaScript
get_high_dividend_soe_rank(sort_field=None, sort_dir=None, count=10, offset=None, filter_list=None)
Description
Get high dividend SOE rank (HK stocks), returning HK stock ranking data meeting default conditions: SOE value concept sector, PB<=1, dividend yield TTM>=5%, PE>=0. Users can override default thresholds via filter conditions.
Parameters
Parameter Type Description sort_field HighDividendSOESortField Sort field, default market cap sort_dir RankSortDir Sort direction, default descending count int Return count [1, 200], default 10 offset int Start position, default 0 filter_list list[ HighDividendSOERankFilter]Filter condition list (can override default conditions) Input Limits
filter_listFilter Conditions（HighDividendSOERankFilter）：Constructor Parameter Description indicator_typeFilter indicator type ( HighDividendSOEIndicatorType, required)interval_minRange minimum (closed interval) interval_maxRange maximum (closed interval) Server-side default fixed conditions:
- Concept sector = SOE (State-Owned Enterprise) value stocks
- P/B ratio <= 1
- Dividend yield TTM >= 5%
- P/E ratio >= 0
Return
Parameter Type Description ret RET_CODE API call result data pd.DataFrame When ret == RET_OK, returns (all_count, DataFrame) tuple str When ret != RET_OK, returns error description - Data format:
Field Type Description security str Stock code (e.g. 'HK.00857')name str Stock name industry str Industry cur_price float Latest price change_ratio float Change rate (%) turnover float Turnover volume int Volume market_cap float Market cap pe_ttm float P/E ratio TTM pb float P/B ratio dividend_yield_ttm float Dividend yield TTM (%) turnover_ratio float Turnover rate (%) change_rate_5d float 5-day change rate (%) change_rate_10d float 10-day change rate (%) change_rate_20d float 20-day change rate (%) change_rate_60d float 60-day change rate (%) change_rate_120d float 120-day change rate (%) change_rate_250d float 250-day change rate (%)
- Data format:
Example
from futu import *
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
ret, data = quote_ctx.get_high_dividend_soe_rank(count=2)
if ret == RET_OK:
all_count, df = data
print(f'Total count: {all_count}')
print(df)
else:
print('error:', data)
quote_ctx.close()
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
- Output
总数据量: 98
security name industry cur_price change_ratio turnover volume market_cap pe_ttm pb dividend_yield_ttm turnover_ratio change_rate_5d change_rate_10d change_rate_20d change_rate_60d change_rate_120d change_rate_250d
0 HK.01398 工商银行 银行 6.9 -0.862 325569646.0 46871758 2.459203e+12 5.84745 0.55072 5.072 0.054 -3.894 -0.288 1.917 9.411 16.416 24.292
1 HK.00857 中国石油股份 油气生产商 8.9 -0.447 154397506.0 17228406 1.628887e+12 9.09090 0.88539 5.932 0.081 -6.342 -10.216 -16.217 -14.691 14.209 36.468
1
2
3
4
2
3
4
# Qot_GetHighDividendSOERank.proto
Description
Get below-book-value high-dividend SOE (state-owned enterprise) rank for Hong Kong stocks, returning stocks that meet the default criteria: SOE concept sector, P/B<=1, dividend yield TTM>=5%, P/E>=0. Users can override default thresholds via filter conditions.
Parameters
// Sort direction
enum SortDir {
SortDir_Descending = 0; // Descending (default)
SortDir_Ascending = 1; // Ascending
}
// Sort field
enum SortField {
SortField_Unknown = 0; // Default (market cap descending)
SortField_DividendYieldTTM = 1; // Dividend yield TTM
SortField_PB = 2; // P/B ratio
SortField_PeTTM = 3; // P/E ratio TTM
SortField_Price = 4; // Last price
SortField_ChangeRatio = 5; // Today's change
SortField_MarketCap = 6; // Market cap
}
// Filter condition type
enum IndicatorType {
IndicatorType_Unknown = 0;
IndicatorType_Price = 1; // Price range
IndicatorType_MarketCap = 2; // Market cap range
IndicatorType_PE = 3; // P/E ratio TTM range
IndicatorType_DividendYieldTTM = 4; // Dividend yield TTM range
IndicatorType_ChangeRatio = 5; // Change% range
}
// Filter conditions
message Indicator {
required int32 indicatorType = 1; // IndicatorType
optional Qot_OptionCommon.Interval indicatorValue = 2; // Filter range
}
message C2S {
optional int32 sortField = 1; // SortField, sort field, default market cap
optional int32 sortDir = 2; // SortDir, sort direction, default descending
optional int32 offset = 3; // Start position, default 0
optional int32 count = 4; // Return count [1,200], default 50
repeated Indicator filterList = 5; // Filter conditions (can override default PB/dividend yield conditions)
}
// High-dividend SOE below book value data item
// Default fixed conditions (server hardcoded): concept plate=special valuation SOE + PB<=1 + dividend yield TTM>=5% + PE>=0
message HighDividendSOERankItem {
required Qot_Common.Security security = 1; // Stock
optional string name = 2; // Name
optional string industry = 3; // Industry
optional double curPrice = 10; // Last price
optional double changeRatio = 11; // Change(%)
optional double turnover = 12; // Turnover
optional int64 volume = 13; // Volume
optional double marketCap = 14; // Market cap
optional double peTTM = 20; // P/E ratio TTM
optional double pb = 21; // P/B ratio
optional double dividendYieldTTM = 22; // Dividend yield TTM(%)
optional double turnoverRatio = 23; // Turnover rate(%)
optional double changeRate5D = 30; // 5-day gain(%)
optional double changeRate10D = 31; // 10-day gain(%)
optional double changeRate20D = 32; // 20-day gain(%)
optional double changeRate60D = 33; // 60-day gain(%)
optional double changeRate120D = 34; // 120-day gain(%)
optional double changeRate250D = 35; // 250-day gain(%)
}
message S2C {
repeated HighDividendSOERankItem dataList = 1; // Data list
optional int32 allCount = 2; // Total matching data count
}
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
Protocol ID
3417
uint GetHighDividendSOERank(Qot_GetHighDividendSOERank.Request req);
virtual void OnReply_GetHighDividendSOERank(FTAPI_Conn client, uint nSerialNo, Qot_GetHighDividendSOERank.Response rsp);
Description
Get below-book-value high-dividend SOE (state-owned enterprise) rank for Hong Kong stocks, returning stocks that meet the default criteria: SOE concept sector, P/B<=1, dividend yield TTM>=5%, P/E>=0. Users can override default thresholds via filter conditions.
Parameters
// Sort direction
enum SortDir {
SortDir_Descending = 0; // Descending (default)
SortDir_Ascending = 1; // Ascending
}
// Sort field
enum SortField {
SortField_Unknown = 0; // Default (market cap descending)
SortField_DividendYieldTTM = 1; // Dividend yield TTM
SortField_PB = 2; // P/B ratio
SortField_PeTTM = 3; // P/E ratio TTM
SortField_Price = 4; // Last price
SortField_ChangeRatio = 5; // Today's change
SortField_MarketCap = 6; // Market cap
}
// Filter condition type
enum IndicatorType {
IndicatorType_Unknown = 0;
IndicatorType_Price = 1; // Price range
IndicatorType_MarketCap = 2; // Market cap range
IndicatorType_PE = 3; // P/E ratio TTM range
IndicatorType_DividendYieldTTM = 4; // Dividend yield TTM range
IndicatorType_ChangeRatio = 5; // Change% range
}
// Filter conditions
message Indicator {
required int32 indicatorType = 1; // IndicatorType
optional Qot_OptionCommon.Interval indicatorValue = 2; // Filter range
}
message C2S {
optional int32 sortField = 1; // SortField, sort field, default market cap
optional int32 sortDir = 2; // SortDir, sort direction, default descending
optional int32 offset = 3; // Start position, default 0
optional int32 count = 4; // Return count [1,200], default 50
repeated Indicator filterList = 5; // Filter conditions (can override default PB/dividend yield conditions)
}
// High-dividend SOE below book value data item
// Default fixed conditions (server hardcoded): concept plate=special valuation SOE + PB<=1 + dividend yield TTM>=5% + PE>=0
message HighDividendSOERankItem {
required Qot_Common.Security security = 1; // Stock
optional string name = 2; // Name
optional string industry = 3; // Industry
optional double curPrice = 10; // Last price
optional double changeRatio = 11; // Change(%)
optional double turnover = 12; // Turnover
optional int64 volume = 13; // Volume
optional double marketCap = 14; // Market cap
optional double peTTM = 20; // P/E ratio TTM
optional double pb = 21; // P/B ratio
optional double dividendYieldTTM = 22; // Dividend yield TTM(%)
optional double turnoverRatio = 23; // Turnover rate(%)
optional double changeRate5D = 30; // 5-day gain(%)
optional double changeRate10D = 31; // 10-day gain(%)
optional double changeRate20D = 32; // 20-day gain(%)
optional double changeRate60D = 33; // 60-day gain(%)
optional double changeRate120D = 34; // 120-day gain(%)
optional double changeRate250D = 35; // 250-day gain(%)
}
message S2C {
repeated HighDividendSOERankItem dataList = 1; // Data list
optional int32 allCount = 2; // Total matching data count
}
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
- For interface result, refer to RetType
Protocol ID
3417
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;
QotGetHighDividendSOERank.C2S c2s = QotGetHighDividendSOERank.C2S.CreateBuilder()
.SetCount(3)
.Build();
QotGetHighDividendSOERank.Request req = QotGetHighDividendSOERank.Request.CreateBuilder().SetC2S(c2s).Build();
uint seqNo = qot.GetHighDividendSOERank(req);
Console.Write("Send QotGetHighDividendSOERank: {0}
", seqNo);
}
public void OnDisconnect(FTAPI_Conn client, long errCode) {
Console.Write("Qot onDisConnect: {0}
", errCode);
}
public void OnReply_GetHighDividendSOERank(FTAPI_Conn client, uint nSerialNo, QotGetHighDividendSOERank.Response rsp)
{
Console.Write("Reply: QotGetHighDividendSOERank: {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
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
- Output
Send QotGetHighDividendSOERank: 3
Reply: QotGetHighDividendSOERank: 3
GetHighDividendSOERank: errCode 0, retMsg , retType 0
{
"allCount": 91,
"dataList": [
{ "security": { "market": 1, "code": "01398" }, "name": "工商银行", "dividendYieldTtm": 5.087, "peTtm": 5.83050 },
{ "security": { "market": 1, "code": "00857" }, "name": "中国石油股份", "dividendYieldTtm": 5.764, "peTtm": 9.35648 },
{ "security": { "market": 1, "code": "00386" }, "name": "中国石油化工股份", "dividendYieldTtm": 5.432, "peTtm": 12.27138 }
]
}
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
int getHighDividendSOERank(Qot_GetHighDividendSOERank.Request req);
onReply_GetHighDividendSOERank(FTAPI_Conn client, int nSerialNo, Qot_GetHighDividendSOERank.Response rsp)
Description
Get below-book-value high-dividend SOE (state-owned enterprise) rank for Hong Kong stocks, returning stocks that meet the default criteria: SOE concept sector, P/B<=1, dividend yield TTM>=5%, P/E>=0. Users can override default thresholds via filter conditions.
Parameters
// Sort direction
enum SortDir {
SortDir_Descending = 0; // Descending (default)
SortDir_Ascending = 1; // Ascending
}
// Sort field
enum SortField {
SortField_Unknown = 0; // Default (market cap descending)
SortField_DividendYieldTTM = 1; // Dividend yield TTM
SortField_PB = 2; // P/B ratio
SortField_PeTTM = 3; // P/E ratio TTM
SortField_Price = 4; // Last price
SortField_ChangeRatio = 5; // Today's change
SortField_MarketCap = 6; // Market cap
}
// Filter condition type
enum IndicatorType {
IndicatorType_Unknown = 0;
IndicatorType_Price = 1; // Price range
IndicatorType_MarketCap = 2; // Market cap range
IndicatorType_PE = 3; // P/E ratio TTM range
IndicatorType_DividendYieldTTM = 4; // Dividend yield TTM range
IndicatorType_ChangeRatio = 5; // Change% range
}
// Filter conditions
message Indicator {
required int32 indicatorType = 1; // IndicatorType
optional Qot_OptionCommon.Interval indicatorValue = 2; // Filter range
}
message C2S {
optional int32 sortField = 1; // SortField, sort field, default market cap
optional int32 sortDir = 2; // SortDir, sort direction, default descending
optional int32 offset = 3; // Start position, default 0
optional int32 count = 4; // Return count [1,200], default 50
repeated Indicator filterList = 5; // Filter conditions (can override default PB/dividend yield conditions)
}
// High-dividend SOE below book value data item
// Default fixed conditions (server hardcoded): concept plate=special valuation SOE + PB<=1 + dividend yield TTM>=5% + PE>=0
message HighDividendSOERankItem {
required Qot_Common.Security security = 1; // Stock
optional string name = 2; // Name
optional string industry = 3; // Industry
optional double curPrice = 10; // Last price
optional double changeRatio = 11; // Change(%)
optional double turnover = 12; // Turnover
optional int64 volume = 13; // Volume
optional double marketCap = 14; // Market cap
optional double peTTM = 20; // P/E ratio TTM
optional double pb = 21; // P/B ratio
optional double dividendYieldTTM = 22; // Dividend yield TTM(%)
optional double turnoverRatio = 23; // Turnover rate(%)
optional double changeRate5D = 30; // 5-day gain(%)
optional double changeRate10D = 31; // 10-day gain(%)
optional double changeRate20D = 32; // 20-day gain(%)
optional double changeRate60D = 33; // 60-day gain(%)
optional double changeRate120D = 34; // 120-day gain(%)
optional double changeRate250D = 35; // 250-day gain(%)
}
message S2C {
repeated HighDividendSOERankItem dataList = 1; // Data list
optional int32 allCount = 2; // Total matching data count
}
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
- For interface result, refer to RetType
Protocol ID
3417
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;
QotGetHighDividendSOERank.C2S c2s = QotGetHighDividendSOERank.C2S.newBuilder()
.setCount(3)
.build();
QotGetHighDividendSOERank.Request req = QotGetHighDividendSOERank.Request.newBuilder().setC2S(c2s).build();
int seqNo = qot.getHighDividendSOERank(req);
System.out.printf("Send QotGetHighDividendSOERank: %d
", seqNo);
}
@Override
public void onDisconnect(FTAPI_Conn client, long errCode) {
System.out.printf("Qot onDisConnect: %d
", errCode);
}
@Override
public void onReply_GetHighDividendSOERank(FTAPI_Conn client, int nSerialNo, QotGetHighDividendSOERank.Response rsp) {
if (rsp.getRetType() != 0) {
System.out.printf("QotGetHighDividendSOERank failed: %s
", rsp.getRetMsg());
} else {
try {
String json = JsonFormat.printer().print(rsp);
System.out.printf("Receive QotGetHighDividendSOERank: %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
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
Send QotGetHighDividendSOERank: 3
Receive QotGetHighDividendSOERank: {
"allCount": 91,
"dataList": [
{ "security": { "market": 1, "code": "01398" }, "name": "工商银行", "dividendYieldTtm": 5.087, "peTtm": 5.83050 },
{ "security": { "market": 1, "code": "00857" }, "name": "中国石油股份", "dividendYieldTtm": 5.764, "peTtm": 9.35648 },
{ "security": { "market": 1, "code": "00386" }, "name": "中国石油化工股份", "dividendYieldTtm": 5.432, "peTtm": 12.27138 }
]
}
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
Futu::u32_t GetHighDividendSOERank(const Qot_GetHighDividendSOERank::Request &stReq);
virtual void OnReply_GetHighDividendSOERank(Futu::u32_t nSerialNo, const Qot_GetHighDividendSOERank::Response &stRsp) = 0;
Description
Protocol request and response definition
Parameters
// Sort direction
enum SortDir {
SortDir_Descending = 0; // Descending (default)
SortDir_Ascending = 1; // Ascending
}
// Sort field
enum SortField {
SortField_Unknown = 0; // Default (market cap descending)
SortField_DividendYieldTTM = 1; // Dividend yield TTM
SortField_PB = 2; // P/B ratio
SortField_PeTTM = 3; // P/E ratio TTM
SortField_Price = 4; // Last price
SortField_ChangeRatio = 5; // Today's change
SortField_MarketCap = 6; // Market cap
}
// Filter condition type
enum IndicatorType {
IndicatorType_Unknown = 0;
IndicatorType_Price = 1; // Price range
IndicatorType_MarketCap = 2; // Market cap range
IndicatorType_PE = 3; // P/E ratio TTM range
IndicatorType_DividendYieldTTM = 4; // Dividend yield TTM range
IndicatorType_ChangeRatio = 5; // Change% range
}
// Filter conditions
message Indicator {
required int32 indicatorType = 1; // IndicatorType
optional Qot_OptionCommon.Interval indicatorValue = 2; // Filter range
}
message C2S {
optional int32 sortField = 1; // SortField, sort field, default market cap
optional int32 sortDir = 2; // SortDir, sort direction, default descending
optional int32 offset = 3; // Start position, default 0
optional int32 count = 4; // Return count [1,200], default 50
repeated Indicator filterList = 5; // Filter conditions (can override default PB/dividend yield conditions)
}
// High-dividend SOE below book value data item
// Default fixed conditions (server hardcoded): concept plate=special valuation SOE + PB<=1 + dividend yield TTM>=5% + PE>=0
message HighDividendSOERankItem {
required Qot_Common.Security security = 1; // Stock
optional string name = 2; // Name
optional string industry = 3; // Industry
optional double curPrice = 10; // Last price
optional double changeRatio = 11; // Change(%)
optional double turnover = 12; // Turnover
optional int64 volume = 13; // Volume
optional double marketCap = 14; // Market cap
optional double peTTM = 20; // P/E ratio TTM
optional double pb = 21; // P/B ratio
optional double dividendYieldTTM = 22; // Dividend yield TTM(%)
optional double turnoverRatio = 23; // Turnover rate(%)
optional double changeRate5D = 30; // 5-day gain(%)
optional double changeRate10D = 31; // 10-day gain(%)
optional double changeRate20D = 32; // 20-day gain(%)
optional double changeRate60D = 33; // 60-day gain(%)
optional double changeRate120D = 34; // 120-day gain(%)
optional double changeRate250D = 35; // 250-day gain(%)
}
message S2C {
repeated HighDividendSOERankItem dataList = 1; // Data list
optional int32 allCount = 2; // Total matching data count
}
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
- For interface result, refer to RetType
Protocol ID
3417
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_GetHighDividendSOERank::Request req;
Qot_GetHighDividendSOERank::C2S *c2s = req.mutable_c2s();
c2s->set_count(50);
m_GetHighDividendSOERankSerialNo = m_pQotApi->GetHighDividendSOERank(req);
}
virtual void OnReply_GetHighDividendSOERank(Futu::u32_t nSerialNo, const Qot_GetHighDividendSOERank::Response &stRsp) {
if (nSerialNo != m_GetHighDividendSOERankSerialNo) return;
string resp_str;
ProtoBufToBodyData(stRsp, resp_str);
cout << UTF8ToLocal(resp_str) << endl;
}
protected:
FTAPI_Qot *m_pQotApi;
Futu::u32_t m_GetHighDividendSOERankSerialNo = 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
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
- Output
{
"retType": 0,
"retMsg": "",
"errCode": 0,
"s2c": {
"dataList": [
{
"security": {
"market": 1,
"code": "00939"
},
"name": "CCB",
"industry": "Bank",
"curPrice": 6.58,
"changeRatio": 0.46,
"marketCap": 1643000000000.0
}
],
"allCount": 50
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
getHighDividendSOERank(qotGetHighDividendSOERank)
Description
Get below-book-value high-dividend SOE (state-owned enterprise) rank for Hong Kong stocks, returning stocks that meet the default criteria: SOE concept sector, P/B<=1, dividend yield TTM>=5%, P/E>=0. Users can override default thresholds via filter conditions.
Parameters
// Sort direction
enum SortDir {
SortDir_Descending = 0; // Descending (default)
SortDir_Ascending = 1; // Ascending
}
// Sort field
enum SortField {
SortField_Unknown = 0; // Default (market cap descending)
SortField_DividendYieldTTM = 1; // Dividend yield TTM
SortField_PB = 2; // P/B ratio
SortField_PeTTM = 3; // P/E ratio TTM
SortField_Price = 4; // Last price
SortField_ChangeRatio = 5; // Today's change
SortField_MarketCap = 6; // Market cap
}
// Filter condition type
enum IndicatorType {
IndicatorType_Unknown = 0;
IndicatorType_Price = 1; // Price range
IndicatorType_MarketCap = 2; // Market cap range
IndicatorType_PE = 3; // P/E ratio TTM range
IndicatorType_DividendYieldTTM = 4; // Dividend yield TTM range
IndicatorType_ChangeRatio = 5; // Change% range
}
// Filter conditions
message Indicator {
required int32 indicatorType = 1; // IndicatorType
optional Qot_OptionCommon.Interval indicatorValue = 2; // Filter range
}
message C2S {
optional int32 sortField = 1; // SortField, sort field, default market cap
optional int32 sortDir = 2; // SortDir, sort direction, default descending
optional int32 offset = 3; // Start position, default 0
optional int32 count = 4; // Return count [1,200], default 50
repeated Indicator filterList = 5; // Filter conditions (can override default PB/dividend yield conditions)
}
// High-dividend SOE below book value data item
// Default fixed conditions (server hardcoded): concept plate=special valuation SOE + PB<=1 + dividend yield TTM>=5% + PE>=0
message HighDividendSOERankItem {
required Qot_Common.Security security = 1; // Stock
optional string name = 2; // Name
optional string industry = 3; // Industry
optional double curPrice = 10; // Last price
optional double changeRatio = 11; // Change(%)
optional double turnover = 12; // Turnover
optional int64 volume = 13; // Volume
optional double marketCap = 14; // Market cap
optional double peTTM = 20; // P/E ratio TTM
optional double pb = 21; // P/B ratio
optional double dividendYieldTTM = 22; // Dividend yield TTM(%)
optional double turnoverRatio = 23; // Turnover rate(%)
optional double changeRate5D = 30; // 5-day gain(%)
optional double changeRate10D = 31; // 10-day gain(%)
optional double changeRate20D = 32; // 20-day gain(%)
optional double changeRate60D = 33; // 60-day gain(%)
optional double changeRate120D = 34; // 120-day gain(%)
optional double changeRate250D = 35; // 250-day gain(%)
}
message S2C {
repeated HighDividendSOERankItem dataList = 1; // Data list
optional int32 allCount = 2; // Total matching data count
}
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
- For interface result, refer to RetType
Protocol ID
3417
Example
import ftWebsocket from "futu-api";
import { Common, Qot_Common } from "futu-api/proto";
import beautify from "js-beautify";
function QotGetHighDividendSOERank(){
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: { count: 3 },
};
websocket.GetHighDividendSOERank(req)
.then((res)=>{
let { errCode, retMsg, retType, s2c } = res
console.log("GetHighDividendSOERank: 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);
}
QotGetHighDividendSOERank()
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
GetHighDividendSOERank: errCode 0, retMsg , retType 0
{
"allCount": 91,
"dataList": [
{ "security": { "market": 1, "code": "01398" }, "name": "工商银行", "dividendYieldTtm": 5.087, "peTtm": 5.83050 },
{ "security": { "market": 1, "code": "00857" }, "name": "中国石油股份", "dividendYieldTtm": 5.764, "peTtm": 9.35648 },
{ "security": { "market": 1, "code": "00386" }, "name": "中国石油化工股份", "dividendYieldTtm": 5.432, "peTtm": 12.27138 }
]
}
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
API Limits
- Maximum 60 requests within 30 seconds
- Only the first page of paginated requests counts toward rate limiting
- Python
- Proto
- C#
- Java
- C++
- JavaScript
get_high_dividend_soe_rank(sort_field=None, sort_dir=None, count=10, offset=None, filter_list=None)
Description
Get high dividend SOE rank (HK stocks), returning HK stock ranking data meeting default conditions: SOE value concept sector, PB<=1, dividend yield TTM>=5%, PE>=0. Users can override default thresholds via filter conditions.
Parameters
Parameter Type Description sort_field HighDividendSOESortField Sort field, default market cap sort_dir RankSortDir Sort direction, default descending count int Return count [1, 200], default 10 offset int Start position, default 0 filter_list list[ HighDividendSOERankFilter]Filter condition list (can override default conditions) Input Limits
filter_listFilter Conditions（HighDividendSOERankFilter）：Constructor Parameter Description indicator_typeFilter indicator type ( HighDividendSOEIndicatorType, required)interval_minRange minimum (closed interval) interval_maxRange maximum (closed interval) Server-side default fixed conditions:
- Concept sector = SOE (State-Owned Enterprise) value stocks
- P/B ratio <= 1
- Dividend yield TTM >= 5%
- P/E ratio >= 0
Return
Parameter Type Description ret RET_CODE API call result data pd.DataFrame When ret == RET_OK, returns (all_count, DataFrame) tuple str When ret != RET_OK, returns error description - Data format:
Field Type Description security str Stock code (e.g. 'HK.00857')name str Stock name industry str Industry cur_price float Latest price change_ratio float Change rate (%) turnover float Turnover volume int Volume market_cap float Market cap pe_ttm float P/E ratio TTM pb float P/B ratio dividend_yield_ttm float Dividend yield TTM (%) turnover_ratio float Turnover rate (%) change_rate_5d float 5-day change rate (%) change_rate_10d float 10-day change rate (%) change_rate_20d float 20-day change rate (%) change_rate_60d float 60-day change rate (%) change_rate_120d float 120-day change rate (%) change_rate_250d float 250-day change rate (%)
- Data format:
Example
from futu import *
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
ret, data = quote_ctx.get_high_dividend_soe_rank(count=2)
if ret == RET_OK:
all_count, df = data
print(f'Total count: {all_count}')
print(df)
else:
print('error:', data)
quote_ctx.close()
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
- Output
总数据量: 98
security name industry cur_price change_ratio turnover volume market_cap pe_ttm pb dividend_yield_ttm turnover_ratio change_rate_5d change_rate_10d change_rate_20d change_rate_60d change_rate_120d change_rate_250d
0 HK.01398 工商银行 银行 6.9 -0.862 325569646.0 46871758 2.459203e+12 5.84745 0.55072 5.072 0.054 -3.894 -0.288 1.917 9.411 16.416 24.292
1 HK.00857 中国石油股份 油气生产商 8.9 -0.447 154397506.0 17228406 1.628887e+12 9.09090 0.88539 5.932 0.081 -6.342 -10.216 -16.217 -14.691 14.209 36.468
1
2
3
4
2
3
4
# Qot_GetHighDividendSOERank.proto
Description
Get below-book-value high-dividend SOE (state-owned enterprise) rank for Hong Kong stocks, returning stocks that meet the default criteria: SOE concept sector, P/B<=1, dividend yield TTM>=5%, P/E>=0. Users can override default thresholds via filter conditions.
Parameters
// Sort direction
enum SortDir {
SortDir_Descending = 0; // Descending (default)
SortDir_Ascending = 1; // Ascending
}
// Sort field
enum SortField {
SortField_Unknown = 0; // Default (market cap descending)
SortField_DividendYieldTTM = 1; // Dividend yield TTM
SortField_PB = 2; // P/B ratio
SortField_PeTTM = 3; // P/E ratio TTM
SortField_Price = 4; // Last price
SortField_ChangeRatio = 5; // Today's change
SortField_MarketCap = 6; // Market cap
}
// Filter condition type
enum IndicatorType {
IndicatorType_Unknown = 0;
IndicatorType_Price = 1; // Price range
IndicatorType_MarketCap = 2; // Market cap range
IndicatorType_PE = 3; // P/E ratio TTM range
IndicatorType_DividendYieldTTM = 4; // Dividend yield TTM range
IndicatorType_ChangeRatio = 5; // Change% range
}
// Filter conditions
message Indicator {
required int32 indicatorType = 1; // IndicatorType
optional Qot_OptionCommon.Interval indicatorValue = 2; // Filter range
}
message C2S {
optional int32 sortField = 1; // SortField, sort field, default market cap
optional int32 sortDir = 2; // SortDir, sort direction, default descending
optional int32 offset = 3; // Start position, default 0
optional int32 count = 4; // Return count [1,200], default 50
repeated Indicator filterList = 5; // Filter conditions (can override default PB/dividend yield conditions)
}
// High-dividend SOE below book value data item
// Default fixed conditions (server hardcoded): concept plate=special valuation SOE + PB<=1 + dividend yield TTM>=5% + PE>=0
message HighDividendSOERankItem {
required Qot_Common.Security security = 1; // Stock
optional string name = 2; // Name
optional string industry = 3; // Industry
optional double curPrice = 10; // Last price
optional double changeRatio = 11; // Change(%)
optional double turnover = 12; // Turnover
optional int64 volume = 13; // Volume
optional double marketCap = 14; // Market cap
optional double peTTM = 20; // P/E ratio TTM
optional double pb = 21; // P/B ratio
optional double dividendYieldTTM = 22; // Dividend yield TTM(%)
optional double turnoverRatio = 23; // Turnover rate(%)
optional double changeRate5D = 30; // 5-day gain(%)
optional double changeRate10D = 31; // 10-day gain(%)
optional double changeRate20D = 32; // 20-day gain(%)
optional double changeRate60D = 33; // 60-day gain(%)
optional double changeRate120D = 34; // 120-day gain(%)
optional double changeRate250D = 35; // 250-day gain(%)
}
message S2C {
repeated HighDividendSOERankItem dataList = 1; // Data list
optional int32 allCount = 2; // Total matching data count
}
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
Protocol ID
3417
uint GetHighDividendSOERank(Qot_GetHighDividendSOERank.Request req);
virtual void OnReply_GetHighDividendSOERank(FTAPI_Conn client, uint nSerialNo, Qot_GetHighDividendSOERank.Response rsp);
Description
Get below-book-value high-dividend SOE (state-owned enterprise) rank for Hong Kong stocks, returning stocks that meet the default criteria: SOE concept sector, P/B<=1, dividend yield TTM>=5%, P/E>=0. Users can override default thresholds via filter conditions.
Parameters
// Sort direction
enum SortDir {
SortDir_Descending = 0; // Descending (default)
SortDir_Ascending = 1; // Ascending
}
// Sort field
enum SortField {
SortField_Unknown = 0; // Default (market cap descending)
SortField_DividendYieldTTM = 1; // Dividend yield TTM
SortField_PB = 2; // P/B ratio
SortField_PeTTM = 3; // P/E ratio TTM
SortField_Price = 4; // Last price
SortField_ChangeRatio = 5; // Today's change
SortField_MarketCap = 6; // Market cap
}
// Filter condition type
enum IndicatorType {
IndicatorType_Unknown = 0;
IndicatorType_Price = 1; // Price range
IndicatorType_MarketCap = 2; // Market cap range
IndicatorType_PE = 3; // P/E ratio TTM range
IndicatorType_DividendYieldTTM = 4; // Dividend yield TTM range
IndicatorType_ChangeRatio = 5; // Change% range
}
// Filter conditions
message Indicator {
required int32 indicatorType = 1; // IndicatorType
optional Qot_OptionCommon.Interval indicatorValue = 2; // Filter range
}
message C2S {
optional int32 sortField = 1; // SortField, sort field, default market cap
optional int32 sortDir = 2; // SortDir, sort direction, default descending
optional int32 offset = 3; // Start position, default 0
optional int32 count = 4; // Return count [1,200], default 50
repeated Indicator filterList = 5; // Filter conditions (can override default PB/dividend yield conditions)
}
// High-dividend SOE below book value data item
// Default fixed conditions (server hardcoded): concept plate=special valuation SOE + PB<=1 + dividend yield TTM>=5% + PE>=0
message HighDividendSOERankItem {
required Qot_Common.Security security = 1; // Stock
optional string name = 2; // Name
optional string industry = 3; // Industry
optional double curPrice = 10; // Last price
optional double changeRatio = 11; // Change(%)
optional double turnover = 12; // Turnover
optional int64 volume = 13; // Volume
optional double marketCap = 14; // Market cap
optional double peTTM = 20; // P/E ratio TTM
optional double pb = 21; // P/B ratio
optional double dividendYieldTTM = 22; // Dividend yield TTM(%)
optional double turnoverRatio = 23; // Turnover rate(%)
optional double changeRate5D = 30; // 5-day gain(%)
optional double changeRate10D = 31; // 10-day gain(%)
optional double changeRate20D = 32; // 20-day gain(%)
optional double changeRate60D = 33; // 60-day gain(%)
optional double changeRate120D = 34; // 120-day gain(%)
optional double changeRate250D = 35; // 250-day gain(%)
}
message S2C {
repeated HighDividendSOERankItem dataList = 1; // Data list
optional int32 allCount = 2; // Total matching data count
}
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
- For interface result, refer to RetType
Protocol ID
3417
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;
QotGetHighDividendSOERank.C2S c2s = QotGetHighDividendSOERank.C2S.CreateBuilder()
.SetCount(3)
.Build();
QotGetHighDividendSOERank.Request req = QotGetHighDividendSOERank.Request.CreateBuilder().SetC2S(c2s).Build();
uint seqNo = qot.GetHighDividendSOERank(req);
Console.Write("Send QotGetHighDividendSOERank: {0}
", seqNo);
}
public void OnDisconnect(MMAPI_Conn client, long errCode) {
Console.Write("Qot onDisConnect: {0}
", errCode);
}
public void OnReply_GetHighDividendSOERank(MMAPI_Conn client, uint nSerialNo, QotGetHighDividendSOERank.Response rsp)
{
Console.Write("Reply: QotGetHighDividendSOERank: {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
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
- Output
Send QotGetHighDividendSOERank: 3
Reply: QotGetHighDividendSOERank: 3
GetHighDividendSOERank: errCode 0, retMsg , retType 0
{
"allCount": 91,
"dataList": [
{ "security": { "market": 1, "code": "01398" }, "name": "工商银行", "dividendYieldTtm": 5.087, "peTtm": 5.83050 },
{ "security": { "market": 1, "code": "00857" }, "name": "中国石油股份", "dividendYieldTtm": 5.764, "peTtm": 9.35648 },
{ "security": { "market": 1, "code": "00386" }, "name": "中国石油化工股份", "dividendYieldTtm": 5.432, "peTtm": 12.27138 }
]
}
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
int getHighDividendSOERank(Qot_GetHighDividendSOERank.Request req);
onReply_GetHighDividendSOERank(FTAPI_Conn client, int nSerialNo, Qot_GetHighDividendSOERank.Response rsp)
Description
Get below-book-value high-dividend SOE (state-owned enterprise) rank for Hong Kong stocks, returning stocks that meet the default criteria: SOE concept sector, P/B<=1, dividend yield TTM>=5%, P/E>=0. Users can override default thresholds via filter conditions.
Parameters
// Sort direction
enum SortDir {
SortDir_Descending = 0; // Descending (default)
SortDir_Ascending = 1; // Ascending
}
// Sort field
enum SortField {
SortField_Unknown = 0; // Default (market cap descending)
SortField_DividendYieldTTM = 1; // Dividend yield TTM
SortField_PB = 2; // P/B ratio
SortField_PeTTM = 3; // P/E ratio TTM
SortField_Price = 4; // Last price
SortField_ChangeRatio = 5; // Today's change
SortField_MarketCap = 6; // Market cap
}
// Filter condition type
enum IndicatorType {
IndicatorType_Unknown = 0;
IndicatorType_Price = 1; // Price range
IndicatorType_MarketCap = 2; // Market cap range
IndicatorType_PE = 3; // P/E ratio TTM range
IndicatorType_DividendYieldTTM = 4; // Dividend yield TTM range
IndicatorType_ChangeRatio = 5; // Change% range
}
// Filter conditions
message Indicator {
required int32 indicatorType = 1; // IndicatorType
optional Qot_OptionCommon.Interval indicatorValue = 2; // Filter range
}
message C2S {
optional int32 sortField = 1; // SortField, sort field, default market cap
optional int32 sortDir = 2; // SortDir, sort direction, default descending
optional int32 offset = 3; // Start position, default 0
optional int32 count = 4; // Return count [1,200], default 50
repeated Indicator filterList = 5; // Filter conditions (can override default PB/dividend yield conditions)
}
// High-dividend SOE below book value data item
// Default fixed conditions (server hardcoded): concept plate=special valuation SOE + PB<=1 + dividend yield TTM>=5% + PE>=0
message HighDividendSOERankItem {
required Qot_Common.Security security = 1; // Stock
optional string name = 2; // Name
optional string industry = 3; // Industry
optional double curPrice = 10; // Last price
optional double changeRatio = 11; // Change(%)
optional double turnover = 12; // Turnover
optional int64 volume = 13; // Volume
optional double marketCap = 14; // Market cap
optional double peTTM = 20; // P/E ratio TTM
optional double pb = 21; // P/B ratio
optional double dividendYieldTTM = 22; // Dividend yield TTM(%)
optional double turnoverRatio = 23; // Turnover rate(%)
optional double changeRate5D = 30; // 5-day gain(%)
optional double changeRate10D = 31; // 10-day gain(%)
optional double changeRate20D = 32; // 20-day gain(%)
optional double changeRate60D = 33; // 60-day gain(%)
optional double changeRate120D = 34; // 120-day gain(%)
optional double changeRate250D = 35; // 250-day gain(%)
}
message S2C {
repeated HighDividendSOERankItem dataList = 1; // Data list
optional int32 allCount = 2; // Total matching data count
}
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
- For interface result, refer to RetType
Protocol ID
3417
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;
QotGetHighDividendSOERank.C2S c2s = QotGetHighDividendSOERank.C2S.newBuilder()
.setCount(3)
.build();
QotGetHighDividendSOERank.Request req = QotGetHighDividendSOERank.Request.newBuilder().setC2S(c2s).build();
int seqNo = qot.getHighDividendSOERank(req);
System.out.printf("Send QotGetHighDividendSOERank: %d
", seqNo);
}
@Override
public void onDisconnect(MMAPI_Conn client, long errCode) {
System.out.printf("Qot onDisConnect: %d
", errCode);
}
@Override
public void onReply_GetHighDividendSOERank(MMAPI_Conn client, int nSerialNo, QotGetHighDividendSOERank.Response rsp) {
if (rsp.getRetType() != 0) {
System.out.printf("QotGetHighDividendSOERank failed: %s
", rsp.getRetMsg());
} else {
try {
String json = JsonFormat.printer().print(rsp);
System.out.printf("Receive QotGetHighDividendSOERank: %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
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
Send QotGetHighDividendSOERank: 3
Receive QotGetHighDividendSOERank: {
"allCount": 91,
"dataList": [
{ "security": { "market": 1, "code": "01398" }, "name": "工商银行", "dividendYieldTtm": 5.087, "peTtm": 5.83050 },
{ "security": { "market": 1, "code": "00857" }, "name": "中国石油股份", "dividendYieldTtm": 5.764, "peTtm": 9.35648 },
{ "security": { "market": 1, "code": "00386" }, "name": "中国石油化工股份", "dividendYieldTtm": 5.432, "peTtm": 12.27138 }
]
}
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
moomoo::u32_t GetHighDividendSOERank(const Qot_GetHighDividendSOERank::Request &stReq);
virtual void OnReply_GetHighDividendSOERank(moomoo::u32_t nSerialNo, const Qot_GetHighDividendSOERank::Response &stRsp) = 0;
Description
Protocol request and response definition
Parameters
// Sort direction
enum SortDir {
SortDir_Descending = 0; // Descending (default)
SortDir_Ascending = 1; // Ascending
}
// Sort field
enum SortField {
SortField_Unknown = 0; // Default (market cap descending)
SortField_DividendYieldTTM = 1; // Dividend yield TTM
SortField_PB = 2; // P/B ratio
SortField_PeTTM = 3; // P/E ratio TTM
SortField_Price = 4; // Last price
SortField_ChangeRatio = 5; // Today's change
SortField_MarketCap = 6; // Market cap
}
// Filter condition type
enum IndicatorType {
IndicatorType_Unknown = 0;
IndicatorType_Price = 1; // Price range
IndicatorType_MarketCap = 2; // Market cap range
IndicatorType_PE = 3; // P/E ratio TTM range
IndicatorType_DividendYieldTTM = 4; // Dividend yield TTM range
IndicatorType_ChangeRatio = 5; // Change% range
}
// Filter conditions
message Indicator {
required int32 indicatorType = 1; // IndicatorType
optional Qot_OptionCommon.Interval indicatorValue = 2; // Filter range
}
message C2S {
optional int32 sortField = 1; // SortField, sort field, default market cap
optional int32 sortDir = 2; // SortDir, sort direction, default descending
optional int32 offset = 3; // Start position, default 0
optional int32 count = 4; // Return count [1,200], default 50
repeated Indicator filterList = 5; // Filter conditions (can override default PB/dividend yield conditions)
}
// High-dividend SOE below book value data item
// Default fixed conditions (server hardcoded): concept plate=special valuation SOE + PB<=1 + dividend yield TTM>=5% + PE>=0
message HighDividendSOERankItem {
required Qot_Common.Security security = 1; // Stock
optional string name = 2; // Name
optional string industry = 3; // Industry
optional double curPrice = 10; // Last price
optional double changeRatio = 11; // Change(%)
optional double turnover = 12; // Turnover
optional int64 volume = 13; // Volume
optional double marketCap = 14; // Market cap
optional double peTTM = 20; // P/E ratio TTM
optional double pb = 21; // P/B ratio
optional double dividendYieldTTM = 22; // Dividend yield TTM(%)
optional double turnoverRatio = 23; // Turnover rate(%)
optional double changeRate5D = 30; // 5-day gain(%)
optional double changeRate10D = 31; // 10-day gain(%)
optional double changeRate20D = 32; // 20-day gain(%)
optional double changeRate60D = 33; // 60-day gain(%)
optional double changeRate120D = 34; // 120-day gain(%)
optional double changeRate250D = 35; // 250-day gain(%)
}
message S2C {
repeated HighDividendSOERankItem dataList = 1; // Data list
optional int32 allCount = 2; // Total matching data count
}
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
- For interface result, refer to RetType
Protocol ID
3417
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_GetHighDividendSOERank::Request req;
Qot_GetHighDividendSOERank::C2S *c2s = req.mutable_c2s();
c2s->set_count(50);
m_GetHighDividendSOERankSerialNo = m_pQotApi->GetHighDividendSOERank(req);
}
virtual void OnReply_GetHighDividendSOERank(moomoo::u32_t nSerialNo, const Qot_GetHighDividendSOERank::Response &stRsp) {
if (nSerialNo != m_GetHighDividendSOERankSerialNo) return;
string resp_str;
ProtoBufToBodyData(stRsp, resp_str);
cout << UTF8ToLocal(resp_str) << endl;
}
protected:
MMAPI_Qot *m_pQotApi;
moomoo::u32_t m_GetHighDividendSOERankSerialNo = 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
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
- Output
{
"retType": 0,
"retMsg": "",
"errCode": 0,
"s2c": {
"dataList": [
{
"security": {
"market": 1,
"code": "00939"
},
"name": "CCB",
"industry": "Bank",
"curPrice": 6.58,
"changeRatio": 0.46,
"marketCap": 1643000000000.0
}
],
"allCount": 50
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
getHighDividendSOERank(qotGetHighDividendSOERank)
Description
Get below-book-value high-dividend SOE (state-owned enterprise) rank for Hong Kong stocks, returning stocks that meet the default criteria: SOE concept sector, P/B<=1, dividend yield TTM>=5%, P/E>=0. Users can override default thresholds via filter conditions.
Parameters
// Sort direction
enum SortDir {
SortDir_Descending = 0; // Descending (default)
SortDir_Ascending = 1; // Ascending
}
// Sort field
enum SortField {
SortField_Unknown = 0; // Default (market cap descending)
SortField_DividendYieldTTM = 1; // Dividend yield TTM
SortField_PB = 2; // P/B ratio
SortField_PeTTM = 3; // P/E ratio TTM
SortField_Price = 4; // Last price
SortField_ChangeRatio = 5; // Today's change
SortField_MarketCap = 6; // Market cap
}
// Filter condition type
enum IndicatorType {
IndicatorType_Unknown = 0;
IndicatorType_Price = 1; // Price range
IndicatorType_MarketCap = 2; // Market cap range
IndicatorType_PE = 3; // P/E ratio TTM range
IndicatorType_DividendYieldTTM = 4; // Dividend yield TTM range
IndicatorType_ChangeRatio = 5; // Change% range
}
// Filter conditions
message Indicator {
required int32 indicatorType = 1; // IndicatorType
optional Qot_OptionCommon.Interval indicatorValue = 2; // Filter range
}
message C2S {
optional int32 sortField = 1; // SortField, sort field, default market cap
optional int32 sortDir = 2; // SortDir, sort direction, default descending
optional int32 offset = 3; // Start position, default 0
optional int32 count = 4; // Return count [1,200], default 50
repeated Indicator filterList = 5; // Filter conditions (can override default PB/dividend yield conditions)
}
// High-dividend SOE below book value data item
// Default fixed conditions (server hardcoded): concept plate=special valuation SOE + PB<=1 + dividend yield TTM>=5% + PE>=0
message HighDividendSOERankItem {
required Qot_Common.Security security = 1; // Stock
optional string name = 2; // Name
optional string industry = 3; // Industry
optional double curPrice = 10; // Last price
optional double changeRatio = 11; // Change(%)
optional double turnover = 12; // Turnover
optional int64 volume = 13; // Volume
optional double marketCap = 14; // Market cap
optional double peTTM = 20; // P/E ratio TTM
optional double pb = 21; // P/B ratio
optional double dividendYieldTTM = 22; // Dividend yield TTM(%)
optional double turnoverRatio = 23; // Turnover rate(%)
optional double changeRate5D = 30; // 5-day gain(%)
optional double changeRate10D = 31; // 10-day gain(%)
optional double changeRate20D = 32; // 20-day gain(%)
optional double changeRate60D = 33; // 60-day gain(%)
optional double changeRate120D = 34; // 120-day gain(%)
optional double changeRate250D = 35; // 250-day gain(%)
}
message S2C {
repeated HighDividendSOERankItem dataList = 1; // Data list
optional int32 allCount = 2; // Total matching data count
}
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
- For interface result, refer to RetType
Protocol ID
3417
Example
import mmWebsocket from "moomoo-api";
import { Common, Qot_Common } from "moomoo-api/proto";
import beautify from "js-beautify";
function QotGetHighDividendSOERank(){
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: { count: 3 },
};
websocket.GetHighDividendSOERank(req)
.then((res)=>{
let { errCode, retMsg, retType, s2c } = res
console.log("GetHighDividendSOERank: 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);
}
QotGetHighDividendSOERank()
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
GetHighDividendSOERank: errCode 0, retMsg , retType 0
{
"allCount": 91,
"dataList": [
{ "security": { "market": 1, "code": "01398" }, "name": "工商银行", "dividendYieldTtm": 5.087, "peTtm": 5.83050 },
{ "security": { "market": 1, "code": "00857" }, "name": "中国石油股份", "dividendYieldTtm": 5.764, "peTtm": 9.35648 },
{ "security": { "market": 1, "code": "00386" }, "name": "中国石油化工股份", "dividendYieldTtm": 5.432, "peTtm": 12.27138 }
]
}
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
API Limits
- Maximum 60 requests within 30 seconds
- Only the first page of paginated requests counts toward rate limiting