# 获取股息排行
- Python
- Proto
- C#
- Java
- C++
- JavaScript
get_dividend_rank(market, rank_type, count=None, filter_list=None, sort_field=None)
介绍
获取股息排行，返回指定市场中高股息率或股息持续增长的股票排行列表，包含股息率、派息频率、连续增长年数等维度数据。
参数
参数 类型 说明 market Market 市场类型（支持 HK/US/MY/SG/JP）（必填） rank_type DividendRankType 排行类型（必填） count int 返回数量 [1, 300]，默认 10 filter_list list[ DividendRankFilter]筛选条件列表（多条件为 AND 关系，支持范围型和枚举型） sort_field DividendRankSortField 排序字段（固定降序），默认由 rankType 决定 输入限制
filter_list筛选条件（DividendRankFilter）：通过
DividendRankFilter构造筛选条件，支持范围型和枚举型两种筛选：构造参数 说明 indicator_type筛选因子类型（ DividendRankIndicatorType，必填）value_list枚举值列表（用于枚举型筛选，如派息频率） interval_min范围最小值（闭区间，用于范围型筛选） interval_max范围最大值（闭区间，用于范围型筛选） 注意：
value_list和interval_min/interval_max至少提供一种。
返回
参数 类型 说明 ret RET_CODE 接口调用结果 data pd.DataFrame 当 ret == RET_OK，返回数据 str 当 ret != RET_OK，返回错误描述 - 数据格式如下：
字段 类型 说明 security str 股票代码（如 'HK.00005'）name str 股票名称 industry str 所属行业 cur_price float 最新价 change_rate float 今日涨跌幅（%） change_amount float 今日涨跌额 market_cap float 市值 dividend_yield_ttm float 股息率 TTM（%） avg_dividend_yield_5y float 5年平均股息率（%） distribution_frequency str 派息频率（ANNUAL/SEMI_ANNUAL/QUARTERLY/MONTHLY），不支持HK市场 dividend_grow_year int 股息连续增长年数 dividends_ttm float 股息 TTM（金额） payout_ratio_lfy float 股息支付率 LFY（%） next_payable_date str 下次派息日（如 '2025-09-15'）
- 数据格式如下：
Example
from futu import *
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
ret, data = quote_ctx.get_dividend_rank(market=Market.HK, rank_type=DividendRankType.HIGH_YIELD, count=2)
if ret == RET_OK:
print(data)
else:
print('error:', data)
quote_ctx.close()
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
- Output
security name industry cur_price change_rate change_amount market_cap dividend_yield_ttm avg_dividend_yield_5y distribution_frequency dividend_grow_year dividends_ttm payout_ratio_lfy next_payable_date
0 HK.00288 万洲国际 包装食品 8.54 -0.582 -0.05 1.095701e+11 10.655 10.855 SEMI_ANNUAL 2 0.910 116.44 N/A
1 HK.01919 中远海控 航运及港口 13.20 -1.123 -0.15 2.021314e+11 8.522 38.168 SEMI_ANNUAL 0 1.125 49.67 N/A
1
2
3
2
3
# Qot_GetDividendRank.proto
介绍
获取股息排行，返回指定市场中高股息率或股息持续增长的股票排行列表，包含股息率、派息频率、连续增长年数等维度数据。
参数
// 股息排行类型
enum DividendRankType {
DividendRankType_Unknown = 0;
DividendRankType_HighYield = 1; // 高股息率
DividendRankType_DividendGrowth = 2; // 股息保持增长
}
// 筛选条件类型
enum IndicatorType {
IndicatorType_Unknown = 0;
IndicatorType_DividendYieldTTM = 1; //【范围】股息率TTM (%)
IndicatorType_AvgDividendYield5Y = 2; //【范围】5年平均股息率 (%)
IndicatorType_DistributionFrequency = 3; //【枚举】派息频率 (1:年派, 2:半年派, 3:季派, 4:月派)
IndicatorType_DividendGrowYear = 4; //【范围】股息连续增长年数
IndicatorType_DividendsTTM = 5; //【范围】股息TTM (金额)
IndicatorType_PayoutRatioLFY = 6; //【范围】股息支付率LFY (%)
IndicatorType_NextPayableDate = 7; //【范围】下次派息日 (相对天数)
IndicatorType_Price = 8; //【范围】最新价
IndicatorType_MarketCap = 9; //【范围】市值
}
// 排序字段 (固定降序)
enum SortField {
SortField_Unknown = 0; // 默认: HighYield→股息率TTM, DividendGrowth→连续增长年数
SortField_DividendYieldTTM = 1; // 股息率TTM
SortField_AvgDividendYield5Y = 2; // 5年平均股息率
SortField_DistributionFrequency = 3; // 派息频率
SortField_DividendGrowYear = 4; // 股息连续增长年数
SortField_DividendsTTM = 5; // 股息TTM
SortField_PayoutRatioLFY = 6; // 股息支付率LFY
SortField_Price = 7; // 价格
SortField_MarketCap = 8; // 市值
SortField_ChangeRate = 9; // 今日涨跌幅
SortField_ChangeAmount = 10; // 今日涨跌额
}
// 筛选条件
message Indicator {
required int32 indicatorType = 1; // IndicatorType
optional Qot_OptionCommon.IndicatorValue indicatorValue = 2; // 筛选值(枚举型用valueList, 范围型用valueInterval)
}
message C2S {
required int32 market = 1; // Qot_Common.QotMarket (仅支持 HK=1, US=11, MY=61, SG=31, JP=41)
required int32 rankType = 2; // DividendRankType
optional int32 count = 3; // 返回数量 [1,300], 默认10
repeated Indicator filterList = 4; // 可选筛选条件(AND关系)
optional int32 sortField = 5; // SortField, 排序字段(固定降序), 默认由rankType决定
}
// 股息排行数据项
message DividendRankItem {
required Qot_Common.Security security = 1; // 股票
optional string name = 2; // 名称
optional string industry = 3; // 行业
// 行情
optional double curPrice = 10; // 最新价
optional double changeRate = 11; // 今日涨跌幅 (%)
optional double changeAmount = 12; // 今日涨跌额
optional double marketCap = 13; // 市值
// 股息
optional double dividendYieldTTM = 20; // 股息率TTM (%)
optional double avgDividendYield5Y = 21; // 5年平均股息率 (%)
optional int32 distributionFrequency = 22; // 派息频率 (1:年派, 2:半年派, 3:季派, 4:月派)，不支持HK市场
optional int32 dividendGrowYear = 23; // 股息连续增长年数
optional double dividendsTTM = 24; // 股息TTM (金额)
optional double payoutRatioLFY = 25; // 股息支付率LFY (%)
optional string nextPayableDate = 26; // 下次派息日 ("YYYY-MM-DD")
}
message S2C {
repeated DividendRankItem dataList = 1; // 数据列表
}
message Request {
required C2S c2s = 1;
}
message Response {
required int32 retType = 1 [default = -400]; // RetType, 返回结果
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
83
84
85
86
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
83
84
85
86
协议 ID
3407
uint GetDividendRank(Qot_GetDividendRank.Request req);
virtual void OnReply_GetDividendRank(FTAPI_Conn client, uint nSerialNo, Qot_GetDividendRank.Response rsp);
介绍
获取股息排行，返回指定市场中高股息率或股息持续增长的股票排行列表，包含股息率、派息频率、连续增长年数等维度数据。
参数
// 股息排行类型
enum DividendRankType {
DividendRankType_Unknown = 0;
DividendRankType_HighYield = 1; // 高股息率
DividendRankType_DividendGrowth = 2; // 股息保持增长
}
// 筛选条件类型
enum IndicatorType {
IndicatorType_Unknown = 0;
IndicatorType_DividendYieldTTM = 1; //【范围】股息率TTM (%)
IndicatorType_AvgDividendYield5Y = 2; //【范围】5年平均股息率 (%)
IndicatorType_DistributionFrequency = 3; //【枚举】派息频率 (1:年派, 2:半年派, 3:季派, 4:月派)
IndicatorType_DividendGrowYear = 4; //【范围】股息连续增长年数
IndicatorType_DividendsTTM = 5; //【范围】股息TTM (金额)
IndicatorType_PayoutRatioLFY = 6; //【范围】股息支付率LFY (%)
IndicatorType_NextPayableDate = 7; //【范围】下次派息日 (相对天数)
IndicatorType_Price = 8; //【范围】最新价
IndicatorType_MarketCap = 9; //【范围】市值
}
// 排序字段 (固定降序)
enum SortField {
SortField_Unknown = 0; // 默认: HighYield→股息率TTM, DividendGrowth→连续增长年数
SortField_DividendYieldTTM = 1; // 股息率TTM
SortField_AvgDividendYield5Y = 2; // 5年平均股息率
SortField_DistributionFrequency = 3; // 派息频率
SortField_DividendGrowYear = 4; // 股息连续增长年数
SortField_DividendsTTM = 5; // 股息TTM
SortField_PayoutRatioLFY = 6; // 股息支付率LFY
SortField_Price = 7; // 价格
SortField_MarketCap = 8; // 市值
SortField_ChangeRate = 9; // 今日涨跌幅
SortField_ChangeAmount = 10; // 今日涨跌额
}
// 筛选条件
message Indicator {
required int32 indicatorType = 1; // IndicatorType
optional Qot_OptionCommon.IndicatorValue indicatorValue = 2; // 筛选值(枚举型用valueList, 范围型用valueInterval)
}
message C2S {
required int32 market = 1; // Qot_Common.QotMarket (仅支持 HK=1, US=11, MY=61, SG=31, JP=41)
required int32 rankType = 2; // DividendRankType
optional int32 count = 3; // 返回数量 [1,300], 默认10
repeated Indicator filterList = 4; // 可选筛选条件(AND关系)
optional int32 sortField = 5; // SortField, 排序字段(固定降序), 默认由rankType决定
}
// 股息排行数据项
message DividendRankItem {
required Qot_Common.Security security = 1; // 股票
optional string name = 2; // 名称
optional string industry = 3; // 行业
// 行情
optional double curPrice = 10; // 最新价
optional double changeRate = 11; // 今日涨跌幅 (%)
optional double changeAmount = 12; // 今日涨跌额
optional double marketCap = 13; // 市值
// 股息
optional double dividendYieldTTM = 20; // 股息率TTM (%)
optional double avgDividendYield5Y = 21; // 5年平均股息率 (%)
optional int32 distributionFrequency = 22; // 派息频率 (1:年派, 2:半年派, 3:季派, 4:月派)，不支持HK市场
optional int32 dividendGrowYear = 23; // 股息连续增长年数
optional double dividendsTTM = 24; // 股息TTM (金额)
optional double payoutRatioLFY = 25; // 股息支付率LFY (%)
optional string nextPayableDate = 26; // 下次派息日 ("YYYY-MM-DD")
}
message S2C {
repeated DividendRankItem dataList = 1; // 数据列表
}
message Request {
required C2S c2s = 1;
}
message Response {
required int32 retType = 1 [default = -400]; // RetType, 返回结果
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
83
84
85
86
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
83
84
85
86
- 接口调用结果，结构参见 RetType
协议 ID
3407
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;
QotGetDividendRank.C2S c2s = QotGetDividendRank.C2S.CreateBuilder()
.SetMarket(1)
.SetRankType(1)
.SetCount(3)
.Build();
QotGetDividendRank.Request req = QotGetDividendRank.Request.CreateBuilder().SetC2S(c2s).Build();
uint seqNo = qot.GetDividendRank(req);
Console.Write("Send QotGetDividendRank: {0}
", seqNo);
}
public void OnDisconnect(FTAPI_Conn client, long errCode) {
Console.Write("Qot onDisConnect: {0}
", errCode);
}
public void OnReply_GetDividendRank(FTAPI_Conn client, uint nSerialNo, QotGetDividendRank.Response rsp)
{
Console.Write("Reply: QotGetDividendRank: {0}
", nSerialNo);
if (rsp.RetType == 0 && rsp.HasS2C)
Console.Write("{0}
", rsp.ToString());
}
public static void Main(String[] args) {
FTAPI.Init();
Program program = new Program();
program.Start();
while (true)
Thread.Sleep(1000 * 600);
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
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
- Output
Send QotGetDividendRank: 3
Reply: QotGetDividendRank: 3
GetDividendRank: errCode 0, retMsg , retType 0
{
"dataList": [
{ "security": { "market": 1, "code": "00288" }, "name": "万洲国际", "dividendYieldTtm": 10.569, "dividendsTtm": 0.910 },
{ "security": { "market": 1, "code": "01919" }, "name": "中远海控", "dividendYieldTtm": 8.302, "dividendsTtm": 1.125 },
{ "security": { "market": 1, "code": "01088" }, "name": "中国神华", "dividendYieldTtm": 7.578, "dividendsTtm": 3.227 }
]
}
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
int getDividendRank(Qot_GetDividendRank.Request req);
onReply_GetDividendRank(FTAPI_Conn client, int nSerialNo, Qot_GetDividendRank.Response rsp)
介绍
获取股息排行，返回指定市场中高股息率或股息持续增长的股票排行列表，包含股息率、派息频率、连续增长年数等维度数据。
参数
// 股息排行类型
enum DividendRankType {
DividendRankType_Unknown = 0;
DividendRankType_HighYield = 1; // 高股息率
DividendRankType_DividendGrowth = 2; // 股息保持增长
}
// 筛选条件类型
enum IndicatorType {
IndicatorType_Unknown = 0;
IndicatorType_DividendYieldTTM = 1; //【范围】股息率TTM (%)
IndicatorType_AvgDividendYield5Y = 2; //【范围】5年平均股息率 (%)
IndicatorType_DistributionFrequency = 3; //【枚举】派息频率 (1:年派, 2:半年派, 3:季派, 4:月派)
IndicatorType_DividendGrowYear = 4; //【范围】股息连续增长年数
IndicatorType_DividendsTTM = 5; //【范围】股息TTM (金额)
IndicatorType_PayoutRatioLFY = 6; //【范围】股息支付率LFY (%)
IndicatorType_NextPayableDate = 7; //【范围】下次派息日 (相对天数)
IndicatorType_Price = 8; //【范围】最新价
IndicatorType_MarketCap = 9; //【范围】市值
}
// 排序字段 (固定降序)
enum SortField {
SortField_Unknown = 0; // 默认: HighYield→股息率TTM, DividendGrowth→连续增长年数
SortField_DividendYieldTTM = 1; // 股息率TTM
SortField_AvgDividendYield5Y = 2; // 5年平均股息率
SortField_DistributionFrequency = 3; // 派息频率
SortField_DividendGrowYear = 4; // 股息连续增长年数
SortField_DividendsTTM = 5; // 股息TTM
SortField_PayoutRatioLFY = 6; // 股息支付率LFY
SortField_Price = 7; // 价格
SortField_MarketCap = 8; // 市值
SortField_ChangeRate = 9; // 今日涨跌幅
SortField_ChangeAmount = 10; // 今日涨跌额
}
// 筛选条件
message Indicator {
required int32 indicatorType = 1; // IndicatorType
optional Qot_OptionCommon.IndicatorValue indicatorValue = 2; // 筛选值(枚举型用valueList, 范围型用valueInterval)
}
message C2S {
required int32 market = 1; // Qot_Common.QotMarket (仅支持 HK=1, US=11, MY=61, SG=31, JP=41)
required int32 rankType = 2; // DividendRankType
optional int32 count = 3; // 返回数量 [1,300], 默认10
repeated Indicator filterList = 4; // 可选筛选条件(AND关系)
optional int32 sortField = 5; // SortField, 排序字段(固定降序), 默认由rankType决定
}
// 股息排行数据项
message DividendRankItem {
required Qot_Common.Security security = 1; // 股票
optional string name = 2; // 名称
optional string industry = 3; // 行业
// 行情
optional double curPrice = 10; // 最新价
optional double changeRate = 11; // 今日涨跌幅 (%)
optional double changeAmount = 12; // 今日涨跌额
optional double marketCap = 13; // 市值
// 股息
optional double dividendYieldTTM = 20; // 股息率TTM (%)
optional double avgDividendYield5Y = 21; // 5年平均股息率 (%)
optional int32 distributionFrequency = 22; // 派息频率 (1:年派, 2:半年派, 3:季派, 4:月派)，不支持HK市场
optional int32 dividendGrowYear = 23; // 股息连续增长年数
optional double dividendsTTM = 24; // 股息TTM (金额)
optional double payoutRatioLFY = 25; // 股息支付率LFY (%)
optional string nextPayableDate = 26; // 下次派息日 ("YYYY-MM-DD")
}
message S2C {
repeated DividendRankItem dataList = 1; // 数据列表
}
message Request {
required C2S c2s = 1;
}
message Response {
required int32 retType = 1 [default = -400]; // RetType, 返回结果
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
83
84
85
86
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
83
84
85
86
- 接口调用结果，结构参见 RetType
协议 ID
3407
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;
QotGetDividendRank.C2S c2s = QotGetDividendRank.C2S.newBuilder()
.setMarket(1)
.setRankType(1)
.setCount(3)
.build();
QotGetDividendRank.Request req = QotGetDividendRank.Request.newBuilder().setC2S(c2s).build();
int seqNo = qot.getDividendRank(req);
System.out.printf("Send QotGetDividendRank: %d
", seqNo);
}
@Override
public void onDisconnect(FTAPI_Conn client, long errCode) {
System.out.printf("Qot onDisConnect: %d
", errCode);
}
@Override
public void onReply_GetDividendRank(FTAPI_Conn client, int nSerialNo, QotGetDividendRank.Response rsp) {
if (rsp.getRetType() != 0) {
System.out.printf("QotGetDividendRank failed: %s
", rsp.getRetMsg());
} else {
try {
String json = JsonFormat.printer().print(rsp);
System.out.printf("Receive QotGetDividendRank: %s
", json);
} catch (InvalidProtocolBufferException e) {
e.printStackTrace();
}
}
}
public static void main(String[] args) {
FTAPI.init();
QotDemo qot = new QotDemo();
qot.start();
while (true) {
try {
Thread.sleep(1000 * 600);
} catch (InterruptedException exc) {
}
}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
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
- Output
Send QotGetDividendRank: 3
Receive QotGetDividendRank: {
"dataList": [
{ "security": { "market": 1, "code": "00288" }, "name": "万洲国际", "dividendYieldTtm": 10.569, "dividendsTtm": 0.910 },
{ "security": { "market": 1, "code": "01919" }, "name": "中远海控", "dividendYieldTtm": 8.302, "dividendsTtm": 1.125 },
{ "security": { "market": 1, "code": "01088" }, "name": "中国神华", "dividendYieldTtm": 7.578, "dividendsTtm": 3.227 }
]
}
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
`Futu::u32_t GetDividendRank(const Qot_GetDividendRank::Request &stReq);`
`virtual void OnReply_GetDividendRank(Futu::u32_t nSerialNo, const Qot_GetDividendRank::Response &stRsp) = 0;`
介绍
获取股息排行，返回指定市场中高股息率或股息持续增长的股票排行列表，包含股息率、派息频率、连续增长年数等维度数据。
参数
// 股息排行类型
enum DividendRankType {
DividendRankType_Unknown = 0;
DividendRankType_HighYield = 1; // 高股息率
DividendRankType_DividendGrowth = 2; // 股息保持增长
}
// 筛选条件类型
enum IndicatorType {
IndicatorType_Unknown = 0;
IndicatorType_DividendYieldTTM = 1; //【范围】股息率TTM (%)
IndicatorType_AvgDividendYield5Y = 2; //【范围】5年平均股息率 (%)
IndicatorType_DistributionFrequency = 3; //【枚举】派息频率 (1:年派, 2:半年派, 3:季派, 4:月派)
IndicatorType_DividendGrowYear = 4; //【范围】股息连续增长年数
IndicatorType_DividendsTTM = 5; //【范围】股息TTM (金额)
IndicatorType_PayoutRatioLFY = 6; //【范围】股息支付率LFY (%)
IndicatorType_NextPayableDate = 7; //【范围】下次派息日 (相对天数)
IndicatorType_Price = 8; //【范围】最新价
IndicatorType_MarketCap = 9; //【范围】市值
}
// 排序字段 (固定降序)
enum SortField {
SortField_Unknown = 0; // 默认: HighYield→股息率TTM, DividendGrowth→连续增长年数
SortField_DividendYieldTTM = 1; // 股息率TTM
SortField_AvgDividendYield5Y = 2; // 5年平均股息率
SortField_DistributionFrequency = 3; // 派息频率
SortField_DividendGrowYear = 4; // 股息连续增长年数
SortField_DividendsTTM = 5; // 股息TTM
SortField_PayoutRatioLFY = 6; // 股息支付率LFY
SortField_Price = 7; // 价格
SortField_MarketCap = 8; // 市值
SortField_ChangeRate = 9; // 今日涨跌幅
SortField_ChangeAmount = 10; // 今日涨跌额
}
// 筛选条件
message Indicator {
required int32 indicatorType = 1; // IndicatorType
optional Qot_OptionCommon.IndicatorValue indicatorValue = 2; // 筛选值(枚举型用valueList, 范围型用valueInterval)
}
message C2S {
required int32 market = 1; // Qot_Common.QotMarket (仅支持 HK=1, US=11, MY=61, SG=31, JP=41)
required int32 rankType = 2; // DividendRankType
optional int32 count = 3; // 返回数量 [1,300], 默认10
repeated Indicator filterList = 4; // 可选筛选条件(AND关系)
optional int32 sortField = 5; // SortField, 排序字段(固定降序), 默认由rankType决定
}
// 股息排行数据项
message DividendRankItem {
required Qot_Common.Security security = 1; // 股票
optional string name = 2; // 名称
optional string industry = 3; // 行业
// 行情
optional double curPrice = 10; // 最新价
optional double changeRate = 11; // 今日涨跌幅 (%)
optional double changeAmount = 12; // 今日涨跌额
optional double marketCap = 13; // 市值
// 股息
optional double dividendYieldTTM = 20; // 股息率TTM (%)
optional double avgDividendYield5Y = 21; // 5年平均股息率 (%)
optional int32 distributionFrequency = 22; // 派息频率 (1:年派, 2:半年派, 3:季派, 4:月派)，不支持HK市场
optional int32 dividendGrowYear = 23; // 股息连续增长年数
optional double dividendsTTM = 24; // 股息TTM (金额)
optional double payoutRatioLFY = 25; // 股息支付率LFY (%)
optional string nextPayableDate = 26; // 下次派息日 ("YYYY-MM-DD")
}
message S2C {
repeated DividendRankItem dataList = 1; // 数据列表
}
message Request {
required C2S c2s = 1;
}
message Response {
required int32 retType = 1 [default = -400]; // RetType, 返回结果
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
83
84
85
86
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
83
84
85
86
- 接口调用结果，结构参见 RetType
协议 ID
3407
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_GetDividendRank::Request req;
Qot_GetDividendRank::C2S *c2s = req.mutable_c2s();
c2s->set_market(Qot_Common::QotMarket::QotMarket_US_Security);
c2s->set_ranktype(1); // DividendRankType_HighYield
c2s->set_count(10);
m_GetDividendRankSerialNo = m_pQotApi->GetDividendRank(req);
}
virtual void OnReply_GetDividendRank(Futu::u32_t nSerialNo, const Qot_GetDividendRank::Response &stRsp) {
if (nSerialNo != m_GetDividendRankSerialNo) return;
string resp_str;
ProtoBufToBodyData(stRsp, resp_str);
cout << UTF8ToLocal(resp_str) << endl;
}
protected:
FTAPI_Qot *m_pQotApi;
Futu::u32_t m_GetDividendRankSerialNo = 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
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
- Output
{
"retType": 0,
"retMsg": "",
"errCode": 0,
"s2c": {
"dataList": [
{
"security": {
"market": 11,
"code": "T"
},
"name": "AT&T",
"industry": "Communication",
"curPrice": 18.5,
"changeRate": 0.54,
"marketCap": 132500000000.0,
"dividendYieldTTM": 6.8
}
]
}
}
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
getDividendRank(qotGetDividendRank)
介绍
协议请求与返回定义
参数
// 股息排行类型
enum DividendRankType {
DividendRankType_Unknown = 0;
DividendRankType_HighYield = 1; // 高股息率
DividendRankType_DividendGrowth = 2; // 股息保持增长
}
// 筛选条件类型
enum IndicatorType {
IndicatorType_Unknown = 0;
IndicatorType_DividendYieldTTM = 1; //【范围】股息率TTM (%)
IndicatorType_AvgDividendYield5Y = 2; //【范围】5年平均股息率 (%)
IndicatorType_DistributionFrequency = 3; //【枚举】派息频率 (1:年派, 2:半年派, 3:季派, 4:月派)
IndicatorType_DividendGrowYear = 4; //【范围】股息连续增长年数
IndicatorType_DividendsTTM = 5; //【范围】股息TTM (金额)
IndicatorType_PayoutRatioLFY = 6; //【范围】股息支付率LFY (%)
IndicatorType_NextPayableDate = 7; //【范围】下次派息日 (相对天数)
IndicatorType_Price = 8; //【范围】最新价
IndicatorType_MarketCap = 9; //【范围】市值
}
// 排序字段 (固定降序)
enum SortField {
SortField_Unknown = 0; // 默认: HighYield→股息率TTM, DividendGrowth→连续增长年数
SortField_DividendYieldTTM = 1; // 股息率TTM
SortField_AvgDividendYield5Y = 2; // 5年平均股息率
SortField_DistributionFrequency = 3; // 派息频率
SortField_DividendGrowYear = 4; // 股息连续增长年数
SortField_DividendsTTM = 5; // 股息TTM
SortField_PayoutRatioLFY = 6; // 股息支付率LFY
SortField_Price = 7; // 价格
SortField_MarketCap = 8; // 市值
SortField_ChangeRate = 9; // 今日涨跌幅
SortField_ChangeAmount = 10; // 今日涨跌额
}
// 筛选条件
message Indicator {
required int32 indicatorType = 1; // IndicatorType
optional Qot_OptionCommon.IndicatorValue indicatorValue = 2; // 筛选值(枚举型用valueList, 范围型用valueInterval)
}
message C2S {
required int32 market = 1; // Qot_Common.QotMarket (仅支持 HK=1, US=11, MY=61, SG=31, JP=41)
required int32 rankType = 2; // DividendRankType
optional int32 count = 3; // 返回数量 [1,300], 默认10
repeated Indicator filterList = 4; // 可选筛选条件(AND关系)
optional int32 sortField = 5; // SortField, 排序字段(固定降序), 默认由rankType决定
}
// 股息排行数据项
message DividendRankItem {
required Qot_Common.Security security = 1; // 股票
optional string name = 2; // 名称
optional string industry = 3; // 行业
// 行情
optional double curPrice = 10; // 最新价
optional double changeRate = 11; // 今日涨跌幅 (%)
optional double changeAmount = 12; // 今日涨跌额
optional double marketCap = 13; // 市值
// 股息
optional double dividendYieldTTM = 20; // 股息率TTM (%)
optional double avgDividendYield5Y = 21; // 5年平均股息率 (%)
optional int32 distributionFrequency = 22; // 派息频率 (1:年派, 2:半年派, 3:季派, 4:月派)，不支持HK市场
optional int32 dividendGrowYear = 23; // 股息连续增长年数
optional double dividendsTTM = 24; // 股息TTM (金额)
optional double payoutRatioLFY = 25; // 股息支付率LFY (%)
optional string nextPayableDate = 26; // 下次派息日 ("YYYY-MM-DD")
}
message S2C {
repeated DividendRankItem dataList = 1; // 数据列表
}
message Request {
required C2S c2s = 1;
}
message Response {
required int32 retType = 1 [default = -400]; // RetType, 返回结果
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
83
84
85
86
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
83
84
85
86
- 接口调用结果，结构参见 RetType
协议 ID
3407
Example
import ftWebsocket from "futu-api";
import { Common, Qot_Common } from "futu-api/proto";
import beautify from "js-beautify";
function QotGetDividendRank(){
const { RetType } = Common
let [addr, port, enable_ssl, key] = ["127.0.0.1", 11111, false, "xxxxxx"];
let websocket = new ftWebsocket();
websocket.onlogin = (ret, msg)=>{
if (ret) {
const req = {
c2s: { market: 1, rankType: 1, count: 3 },
};
websocket.GetDividendRank(req)
.then((res)=>{
let { errCode, retMsg, retType, s2c } = res
console.log("GetDividendRank: 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);
}
QotGetDividendRank()
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
GetDividendRank: errCode 0, retMsg , retType 0
{
"dataList": [
{ "security": { "market": 1, "code": "00288" }, "name": "万洲国际", "dividendYieldTtm": 10.569, "dividendsTtm": 0.910 },
{ "security": { "market": 1, "code": "01919" }, "name": "中远海控", "dividendYieldTtm": 8.302, "dividendsTtm": 1.125 },
{ "security": { "market": 1, "code": "01088" }, "name": "中国神华", "dividendYieldTtm": 7.578, "dividendsTtm": 3.227 }
]
}
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
接口限制
- 30 秒内最多 60 次请求
- 分页请求仅首页计入限频统计
- Python
- Proto
- C#
- Java
- C++
- JavaScript
get_dividend_rank(market, rank_type, count=None, filter_list=None, sort_field=None)
介绍
获取股息排行，返回指定市场中高股息率或股息持续增长的股票排行列表，包含股息率、派息频率、连续增长年数等维度数据。
参数
参数 类型 说明 market Market 市场类型（支持 HK/US/MY/SG/JP）（必填） rank_type DividendRankType 排行类型（必填） count int 返回数量 [1, 300]，默认 10 filter_list list[ DividendRankFilter]筛选条件列表（多条件为 AND 关系，支持范围型和枚举型） sort_field DividendRankSortField 排序字段（固定降序），默认由 rankType 决定 输入限制
filter_list筛选条件（DividendRankFilter）：通过
DividendRankFilter构造筛选条件，支持范围型和枚举型两种筛选：构造参数 说明 indicator_type筛选因子类型（ DividendRankIndicatorType，必填）value_list枚举值列表（用于枚举型筛选，如派息频率） interval_min范围最小值（闭区间，用于范围型筛选） interval_max范围最大值（闭区间，用于范围型筛选） 注意：
value_list和interval_min/interval_max至少提供一种。
返回
参数 类型 说明 ret RET_CODE 接口调用结果 data pd.DataFrame 当 ret == RET_OK，返回数据 str 当 ret != RET_OK，返回错误描述 - 数据格式如下：
字段 类型 说明 security str 股票代码（如 'HK.00005'）name str 股票名称 industry str 所属行业 cur_price float 最新价 change_rate float 今日涨跌幅（%） change_amount float 今日涨跌额 market_cap float 市值 dividend_yield_ttm float 股息率 TTM（%） avg_dividend_yield_5y float 5年平均股息率（%） distribution_frequency str 派息频率（ANNUAL/SEMI_ANNUAL/QUARTERLY/MONTHLY），不支持HK市场 dividend_grow_year int 股息连续增长年数 dividends_ttm float 股息 TTM（金额） payout_ratio_lfy float 股息支付率 LFY（%） next_payable_date str 下次派息日（如 '2025-09-15'）
- 数据格式如下：
Example
from futu import *
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
ret, data = quote_ctx.get_dividend_rank(market=Market.HK, rank_type=DividendRankType.HIGH_YIELD, count=2)
if ret == RET_OK:
print(data)
else:
print('error:', data)
quote_ctx.close()
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
- Output
security name industry cur_price change_rate change_amount market_cap dividend_yield_ttm avg_dividend_yield_5y distribution_frequency dividend_grow_year dividends_ttm payout_ratio_lfy next_payable_date
0 HK.00288 万洲国际 包装食品 8.54 -0.582 -0.05 1.095701e+11 10.655 10.855 SEMI_ANNUAL 2 0.910 116.44 N/A
1 HK.01919 中远海控 航运及港口 13.20 -1.123 -0.15 2.021314e+11 8.522 38.168 SEMI_ANNUAL 0 1.125 49.67 N/A
1
2
3
2
3
# Qot_GetDividendRank.proto
介绍
获取股息排行，返回指定市场中高股息率或股息持续增长的股票排行列表，包含股息率、派息频率、连续增长年数等维度数据。
参数
// 股息排行类型
enum DividendRankType {
DividendRankType_Unknown = 0;
DividendRankType_HighYield = 1; // 高股息率
DividendRankType_DividendGrowth = 2; // 股息保持增长
}
// 筛选条件类型
enum IndicatorType {
IndicatorType_Unknown = 0;
IndicatorType_DividendYieldTTM = 1; //【范围】股息率TTM (%)
IndicatorType_AvgDividendYield5Y = 2; //【范围】5年平均股息率 (%)
IndicatorType_DistributionFrequency = 3; //【枚举】派息频率 (1:年派, 2:半年派, 3:季派, 4:月派)
IndicatorType_DividendGrowYear = 4; //【范围】股息连续增长年数
IndicatorType_DividendsTTM = 5; //【范围】股息TTM (金额)
IndicatorType_PayoutRatioLFY = 6; //【范围】股息支付率LFY (%)
IndicatorType_NextPayableDate = 7; //【范围】下次派息日 (相对天数)
IndicatorType_Price = 8; //【范围】最新价
IndicatorType_MarketCap = 9; //【范围】市值
}
// 排序字段 (固定降序)
enum SortField {
SortField_Unknown = 0; // 默认: HighYield→股息率TTM, DividendGrowth→连续增长年数
SortField_DividendYieldTTM = 1; // 股息率TTM
SortField_AvgDividendYield5Y = 2; // 5年平均股息率
SortField_DistributionFrequency = 3; // 派息频率
SortField_DividendGrowYear = 4; // 股息连续增长年数
SortField_DividendsTTM = 5; // 股息TTM
SortField_PayoutRatioLFY = 6; // 股息支付率LFY
SortField_Price = 7; // 价格
SortField_MarketCap = 8; // 市值
SortField_ChangeRate = 9; // 今日涨跌幅
SortField_ChangeAmount = 10; // 今日涨跌额
}
// 筛选条件
message Indicator {
required int32 indicatorType = 1; // IndicatorType
optional Qot_OptionCommon.IndicatorValue indicatorValue = 2; // 筛选值(枚举型用valueList, 范围型用valueInterval)
}
message C2S {
required int32 market = 1; // Qot_Common.QotMarket (仅支持 HK=1, US=11, MY=61, SG=31, JP=41)
required int32 rankType = 2; // DividendRankType
optional int32 count = 3; // 返回数量 [1,300], 默认10
repeated Indicator filterList = 4; // 可选筛选条件(AND关系)
optional int32 sortField = 5; // SortField, 排序字段(固定降序), 默认由rankType决定
}
// 股息排行数据项
message DividendRankItem {
required Qot_Common.Security security = 1; // 股票
optional string name = 2; // 名称
optional string industry = 3; // 行业
// 行情
optional double curPrice = 10; // 最新价
optional double changeRate = 11; // 今日涨跌幅 (%)
optional double changeAmount = 12; // 今日涨跌额
optional double marketCap = 13; // 市值
// 股息
optional double dividendYieldTTM = 20; // 股息率TTM (%)
optional double avgDividendYield5Y = 21; // 5年平均股息率 (%)
optional int32 distributionFrequency = 22; // 派息频率 (1:年派, 2:半年派, 3:季派, 4:月派)，不支持HK市场
optional int32 dividendGrowYear = 23; // 股息连续增长年数
optional double dividendsTTM = 24; // 股息TTM (金额)
optional double payoutRatioLFY = 25; // 股息支付率LFY (%)
optional string nextPayableDate = 26; // 下次派息日 ("YYYY-MM-DD")
}
message S2C {
repeated DividendRankItem dataList = 1; // 数据列表
}
message Request {
required C2S c2s = 1;
}
message Response {
required int32 retType = 1 [default = -400]; // RetType, 返回结果
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
83
84
85
86
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
83
84
85
86
协议 ID
3407
uint GetDividendRank(Qot_GetDividendRank.Request req);
virtual void OnReply_GetDividendRank(FTAPI_Conn client, uint nSerialNo, Qot_GetDividendRank.Response rsp);
介绍
获取股息排行，返回指定市场中高股息率或股息持续增长的股票排行列表，包含股息率、派息频率、连续增长年数等维度数据。
参数
// 股息排行类型
enum DividendRankType {
DividendRankType_Unknown = 0;
DividendRankType_HighYield = 1; // 高股息率
DividendRankType_DividendGrowth = 2; // 股息保持增长
}
// 筛选条件类型
enum IndicatorType {
IndicatorType_Unknown = 0;
IndicatorType_DividendYieldTTM = 1; //【范围】股息率TTM (%)
IndicatorType_AvgDividendYield5Y = 2; //【范围】5年平均股息率 (%)
IndicatorType_DistributionFrequency = 3; //【枚举】派息频率 (1:年派, 2:半年派, 3:季派, 4:月派)
IndicatorType_DividendGrowYear = 4; //【范围】股息连续增长年数
IndicatorType_DividendsTTM = 5; //【范围】股息TTM (金额)
IndicatorType_PayoutRatioLFY = 6; //【范围】股息支付率LFY (%)
IndicatorType_NextPayableDate = 7; //【范围】下次派息日 (相对天数)
IndicatorType_Price = 8; //【范围】最新价
IndicatorType_MarketCap = 9; //【范围】市值
}
// 排序字段 (固定降序)
enum SortField {
SortField_Unknown = 0; // 默认: HighYield→股息率TTM, DividendGrowth→连续增长年数
SortField_DividendYieldTTM = 1; // 股息率TTM
SortField_AvgDividendYield5Y = 2; // 5年平均股息率
SortField_DistributionFrequency = 3; // 派息频率
SortField_DividendGrowYear = 4; // 股息连续增长年数
SortField_DividendsTTM = 5; // 股息TTM
SortField_PayoutRatioLFY = 6; // 股息支付率LFY
SortField_Price = 7; // 价格
SortField_MarketCap = 8; // 市值
SortField_ChangeRate = 9; // 今日涨跌幅
SortField_ChangeAmount = 10; // 今日涨跌额
}
// 筛选条件
message Indicator {
required int32 indicatorType = 1; // IndicatorType
optional Qot_OptionCommon.IndicatorValue indicatorValue = 2; // 筛选值(枚举型用valueList, 范围型用valueInterval)
}
message C2S {
required int32 market = 1; // Qot_Common.QotMarket (仅支持 HK=1, US=11, MY=61, SG=31, JP=41)
required int32 rankType = 2; // DividendRankType
optional int32 count = 3; // 返回数量 [1,300], 默认10
repeated Indicator filterList = 4; // 可选筛选条件(AND关系)
optional int32 sortField = 5; // SortField, 排序字段(固定降序), 默认由rankType决定
}
// 股息排行数据项
message DividendRankItem {
required Qot_Common.Security security = 1; // 股票
optional string name = 2; // 名称
optional string industry = 3; // 行业
// 行情
optional double curPrice = 10; // 最新价
optional double changeRate = 11; // 今日涨跌幅 (%)
optional double changeAmount = 12; // 今日涨跌额
optional double marketCap = 13; // 市值
// 股息
optional double dividendYieldTTM = 20; // 股息率TTM (%)
optional double avgDividendYield5Y = 21; // 5年平均股息率 (%)
optional int32 distributionFrequency = 22; // 派息频率 (1:年派, 2:半年派, 3:季派, 4:月派)，不支持HK市场
optional int32 dividendGrowYear = 23; // 股息连续增长年数
optional double dividendsTTM = 24; // 股息TTM (金额)
optional double payoutRatioLFY = 25; // 股息支付率LFY (%)
optional string nextPayableDate = 26; // 下次派息日 ("YYYY-MM-DD")
}
message S2C {
repeated DividendRankItem dataList = 1; // 数据列表
}
message Request {
required C2S c2s = 1;
}
message Response {
required int32 retType = 1 [default = -400]; // RetType, 返回结果
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
83
84
85
86
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
83
84
85
86
- 接口调用结果，结构参见 RetType
协议 ID
3407
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;
QotGetDividendRank.C2S c2s = QotGetDividendRank.C2S.CreateBuilder()
.SetMarket(1)
.SetRankType(1)
.SetCount(3)
.Build();
QotGetDividendRank.Request req = QotGetDividendRank.Request.CreateBuilder().SetC2S(c2s).Build();
uint seqNo = qot.GetDividendRank(req);
Console.Write("Send QotGetDividendRank: {0}
", seqNo);
}
public void OnDisconnect(MMAPI_Conn client, long errCode) {
Console.Write("Qot onDisConnect: {0}
", errCode);
}
public void OnReply_GetDividendRank(MMAPI_Conn client, uint nSerialNo, QotGetDividendRank.Response rsp)
{
Console.Write("Reply: QotGetDividendRank: {0}
", nSerialNo);
if (rsp.RetType == 0 && rsp.HasS2C)
Console.Write("{0}
", rsp.ToString());
}
public static void Main(String[] args) {
MMAPI.Init();
Program program = new Program();
program.Start();
while (true)
Thread.Sleep(1000 * 600);
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
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
- Output
Send QotGetDividendRank: 3
Reply: QotGetDividendRank: 3
GetDividendRank: errCode 0, retMsg , retType 0
{
"dataList": [
{ "security": { "market": 1, "code": "00288" }, "name": "万洲国际", "dividendYieldTtm": 10.569, "dividendsTtm": 0.910 },
{ "security": { "market": 1, "code": "01919" }, "name": "中远海控", "dividendYieldTtm": 8.302, "dividendsTtm": 1.125 },
{ "security": { "market": 1, "code": "01088" }, "name": "中国神华", "dividendYieldTtm": 7.578, "dividendsTtm": 3.227 }
]
}
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
int getDividendRank(Qot_GetDividendRank.Request req);
onReply_GetDividendRank(FTAPI_Conn client, int nSerialNo, Qot_GetDividendRank.Response rsp)
介绍
获取股息排行，返回指定市场中高股息率或股息持续增长的股票排行列表，包含股息率、派息频率、连续增长年数等维度数据。
参数
// 股息排行类型
enum DividendRankType {
DividendRankType_Unknown = 0;
DividendRankType_HighYield = 1; // 高股息率
DividendRankType_DividendGrowth = 2; // 股息保持增长
}
// 筛选条件类型
enum IndicatorType {
IndicatorType_Unknown = 0;
IndicatorType_DividendYieldTTM = 1; //【范围】股息率TTM (%)
IndicatorType_AvgDividendYield5Y = 2; //【范围】5年平均股息率 (%)
IndicatorType_DistributionFrequency = 3; //【枚举】派息频率 (1:年派, 2:半年派, 3:季派, 4:月派)
IndicatorType_DividendGrowYear = 4; //【范围】股息连续增长年数
IndicatorType_DividendsTTM = 5; //【范围】股息TTM (金额)
IndicatorType_PayoutRatioLFY = 6; //【范围】股息支付率LFY (%)
IndicatorType_NextPayableDate = 7; //【范围】下次派息日 (相对天数)
IndicatorType_Price = 8; //【范围】最新价
IndicatorType_MarketCap = 9; //【范围】市值
}
// 排序字段 (固定降序)
enum SortField {
SortField_Unknown = 0; // 默认: HighYield→股息率TTM, DividendGrowth→连续增长年数
SortField_DividendYieldTTM = 1; // 股息率TTM
SortField_AvgDividendYield5Y = 2; // 5年平均股息率
SortField_DistributionFrequency = 3; // 派息频率
SortField_DividendGrowYear = 4; // 股息连续增长年数
SortField_DividendsTTM = 5; // 股息TTM
SortField_PayoutRatioLFY = 6; // 股息支付率LFY
SortField_Price = 7; // 价格
SortField_MarketCap = 8; // 市值
SortField_ChangeRate = 9; // 今日涨跌幅
SortField_ChangeAmount = 10; // 今日涨跌额
}
// 筛选条件
message Indicator {
required int32 indicatorType = 1; // IndicatorType
optional Qot_OptionCommon.IndicatorValue indicatorValue = 2; // 筛选值(枚举型用valueList, 范围型用valueInterval)
}
message C2S {
required int32 market = 1; // Qot_Common.QotMarket (仅支持 HK=1, US=11, MY=61, SG=31, JP=41)
required int32 rankType = 2; // DividendRankType
optional int32 count = 3; // 返回数量 [1,300], 默认10
repeated Indicator filterList = 4; // 可选筛选条件(AND关系)
optional int32 sortField = 5; // SortField, 排序字段(固定降序), 默认由rankType决定
}
// 股息排行数据项
message DividendRankItem {
required Qot_Common.Security security = 1; // 股票
optional string name = 2; // 名称
optional string industry = 3; // 行业
// 行情
optional double curPrice = 10; // 最新价
optional double changeRate = 11; // 今日涨跌幅 (%)
optional double changeAmount = 12; // 今日涨跌额
optional double marketCap = 13; // 市值
// 股息
optional double dividendYieldTTM = 20; // 股息率TTM (%)
optional double avgDividendYield5Y = 21; // 5年平均股息率 (%)
optional int32 distributionFrequency = 22; // 派息频率 (1:年派, 2:半年派, 3:季派, 4:月派)，不支持HK市场
optional int32 dividendGrowYear = 23; // 股息连续增长年数
optional double dividendsTTM = 24; // 股息TTM (金额)
optional double payoutRatioLFY = 25; // 股息支付率LFY (%)
optional string nextPayableDate = 26; // 下次派息日 ("YYYY-MM-DD")
}
message S2C {
repeated DividendRankItem dataList = 1; // 数据列表
}
message Request {
required C2S c2s = 1;
}
message Response {
required int32 retType = 1 [default = -400]; // RetType, 返回结果
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
83
84
85
86
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
83
84
85
86
- 接口调用结果，结构参见 RetType
协议 ID
3407
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;
QotGetDividendRank.C2S c2s = QotGetDividendRank.C2S.newBuilder()
.setMarket(1)
.setRankType(1)
.setCount(3)
.build();
QotGetDividendRank.Request req = QotGetDividendRank.Request.newBuilder().setC2S(c2s).build();
int seqNo = qot.getDividendRank(req);
System.out.printf("Send QotGetDividendRank: %d
", seqNo);
}
@Override
public void onDisconnect(MMAPI_Conn client, long errCode) {
System.out.printf("Qot onDisConnect: %d
", errCode);
}
@Override
public void onReply_GetDividendRank(MMAPI_Conn client, int nSerialNo, QotGetDividendRank.Response rsp) {
if (rsp.getRetType() != 0) {
System.out.printf("QotGetDividendRank failed: %s
", rsp.getRetMsg());
} else {
try {
String json = JsonFormat.printer().print(rsp);
System.out.printf("Receive QotGetDividendRank: %s
", json);
} catch (InvalidProtocolBufferException e) {
e.printStackTrace();
}
}
}
public static void main(String[] args) {
MMAPI.init();
QotDemo qot = new QotDemo();
qot.start();
while (true) {
try {
Thread.sleep(1000 * 600);
} catch (InterruptedException exc) {
}
}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
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
- Output
Send QotGetDividendRank: 3
Receive QotGetDividendRank: {
"dataList": [
{ "security": { "market": 1, "code": "00288" }, "name": "万洲国际", "dividendYieldTtm": 10.569, "dividendsTtm": 0.910 },
{ "security": { "market": 1, "code": "01919" }, "name": "中远海控", "dividendYieldTtm": 8.302, "dividendsTtm": 1.125 },
{ "security": { "market": 1, "code": "01088" }, "name": "中国神华", "dividendYieldTtm": 7.578, "dividendsTtm": 3.227 }
]
}
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
`moomoo::u32_t GetDividendRank(const Qot_GetDividendRank::Request &stReq);`
`virtual void OnReply_GetDividendRank(moomoo::u32_t nSerialNo, const Qot_GetDividendRank::Response &stRsp) = 0;`
介绍
获取股息排行，返回指定市场中高股息率或股息持续增长的股票排行列表，包含股息率、派息频率、连续增长年数等维度数据。
参数
// 股息排行类型
enum DividendRankType {
DividendRankType_Unknown = 0;
DividendRankType_HighYield = 1; // 高股息率
DividendRankType_DividendGrowth = 2; // 股息保持增长
}
// 筛选条件类型
enum IndicatorType {
IndicatorType_Unknown = 0;
IndicatorType_DividendYieldTTM = 1; //【范围】股息率TTM (%)
IndicatorType_AvgDividendYield5Y = 2; //【范围】5年平均股息率 (%)
IndicatorType_DistributionFrequency = 3; //【枚举】派息频率 (1:年派, 2:半年派, 3:季派, 4:月派)
IndicatorType_DividendGrowYear = 4; //【范围】股息连续增长年数
IndicatorType_DividendsTTM = 5; //【范围】股息TTM (金额)
IndicatorType_PayoutRatioLFY = 6; //【范围】股息支付率LFY (%)
IndicatorType_NextPayableDate = 7; //【范围】下次派息日 (相对天数)
IndicatorType_Price = 8; //【范围】最新价
IndicatorType_MarketCap = 9; //【范围】市值
}
// 排序字段 (固定降序)
enum SortField {
SortField_Unknown = 0; // 默认: HighYield→股息率TTM, DividendGrowth→连续增长年数
SortField_DividendYieldTTM = 1; // 股息率TTM
SortField_AvgDividendYield5Y = 2; // 5年平均股息率
SortField_DistributionFrequency = 3; // 派息频率
SortField_DividendGrowYear = 4; // 股息连续增长年数
SortField_DividendsTTM = 5; // 股息TTM
SortField_PayoutRatioLFY = 6; // 股息支付率LFY
SortField_Price = 7; // 价格
SortField_MarketCap = 8; // 市值
SortField_ChangeRate = 9; // 今日涨跌幅
SortField_ChangeAmount = 10; // 今日涨跌额
}
// 筛选条件
message Indicator {
required int32 indicatorType = 1; // IndicatorType
optional Qot_OptionCommon.IndicatorValue indicatorValue = 2; // 筛选值(枚举型用valueList, 范围型用valueInterval)
}
message C2S {
required int32 market = 1; // Qot_Common.QotMarket (仅支持 HK=1, US=11, MY=61, SG=31, JP=41)
required int32 rankType = 2; // DividendRankType
optional int32 count = 3; // 返回数量 [1,300], 默认10
repeated Indicator filterList = 4; // 可选筛选条件(AND关系)
optional int32 sortField = 5; // SortField, 排序字段(固定降序), 默认由rankType决定
}
// 股息排行数据项
message DividendRankItem {
required Qot_Common.Security security = 1; // 股票
optional string name = 2; // 名称
optional string industry = 3; // 行业
// 行情
optional double curPrice = 10; // 最新价
optional double changeRate = 11; // 今日涨跌幅 (%)
optional double changeAmount = 12; // 今日涨跌额
optional double marketCap = 13; // 市值
// 股息
optional double dividendYieldTTM = 20; // 股息率TTM (%)
optional double avgDividendYield5Y = 21; // 5年平均股息率 (%)
optional int32 distributionFrequency = 22; // 派息频率 (1:年派, 2:半年派, 3:季派, 4:月派)，不支持HK市场
optional int32 dividendGrowYear = 23; // 股息连续增长年数
optional double dividendsTTM = 24; // 股息TTM (金额)
optional double payoutRatioLFY = 25; // 股息支付率LFY (%)
optional string nextPayableDate = 26; // 下次派息日 ("YYYY-MM-DD")
}
message S2C {
repeated DividendRankItem dataList = 1; // 数据列表
}
message Request {
required C2S c2s = 1;
}
message Response {
required int32 retType = 1 [default = -400]; // RetType, 返回结果
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
83
84
85
86
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
83
84
85
86
- 接口调用结果，结构参见 RetType
协议 ID
3407
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_GetDividendRank::Request req;
Qot_GetDividendRank::C2S *c2s = req.mutable_c2s();
c2s->set_market(Qot_Common::QotMarket::QotMarket_US_Security);
c2s->set_ranktype(1); // DividendRankType_HighYield
c2s->set_count(10);
m_GetDividendRankSerialNo = m_pQotApi->GetDividendRank(req);
}
virtual void OnReply_GetDividendRank(moomoo::u32_t nSerialNo, const Qot_GetDividendRank::Response &stRsp) {
if (nSerialNo != m_GetDividendRankSerialNo) return;
string resp_str;
ProtoBufToBodyData(stRsp, resp_str);
cout << UTF8ToLocal(resp_str) << endl;
}
protected:
MMAPI_Qot *m_pQotApi;
moomoo::u32_t m_GetDividendRankSerialNo = 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
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
- Output
{
"retType": 0,
"retMsg": "",
"errCode": 0,
"s2c": {
"dataList": [
{
"security": {
"market": 11,
"code": "T"
},
"name": "AT&T",
"industry": "Communication",
"curPrice": 18.5,
"changeRate": 0.54,
"marketCap": 132500000000.0,
"dividendYieldTTM": 6.8
}
]
}
}
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
getDividendRank(qotGetDividendRank)
介绍
协议请求与返回定义
参数
// 股息排行类型
enum DividendRankType {
DividendRankType_Unknown = 0;
DividendRankType_HighYield = 1; // 高股息率
DividendRankType_DividendGrowth = 2; // 股息保持增长
}
// 筛选条件类型
enum IndicatorType {
IndicatorType_Unknown = 0;
IndicatorType_DividendYieldTTM = 1; //【范围】股息率TTM (%)
IndicatorType_AvgDividendYield5Y = 2; //【范围】5年平均股息率 (%)
IndicatorType_DistributionFrequency = 3; //【枚举】派息频率 (1:年派, 2:半年派, 3:季派, 4:月派)
IndicatorType_DividendGrowYear = 4; //【范围】股息连续增长年数
IndicatorType_DividendsTTM = 5; //【范围】股息TTM (金额)
IndicatorType_PayoutRatioLFY = 6; //【范围】股息支付率LFY (%)
IndicatorType_NextPayableDate = 7; //【范围】下次派息日 (相对天数)
IndicatorType_Price = 8; //【范围】最新价
IndicatorType_MarketCap = 9; //【范围】市值
}
// 排序字段 (固定降序)
enum SortField {
SortField_Unknown = 0; // 默认: HighYield→股息率TTM, DividendGrowth→连续增长年数
SortField_DividendYieldTTM = 1; // 股息率TTM
SortField_AvgDividendYield5Y = 2; // 5年平均股息率
SortField_DistributionFrequency = 3; // 派息频率
SortField_DividendGrowYear = 4; // 股息连续增长年数
SortField_DividendsTTM = 5; // 股息TTM
SortField_PayoutRatioLFY = 6; // 股息支付率LFY
SortField_Price = 7; // 价格
SortField_MarketCap = 8; // 市值
SortField_ChangeRate = 9; // 今日涨跌幅
SortField_ChangeAmount = 10; // 今日涨跌额
}
// 筛选条件
message Indicator {
required int32 indicatorType = 1; // IndicatorType
optional Qot_OptionCommon.IndicatorValue indicatorValue = 2; // 筛选值(枚举型用valueList, 范围型用valueInterval)
}
message C2S {
required int32 market = 1; // Qot_Common.QotMarket (仅支持 HK=1, US=11, MY=61, SG=31, JP=41)
required int32 rankType = 2; // DividendRankType
optional int32 count = 3; // 返回数量 [1,300], 默认10
repeated Indicator filterList = 4; // 可选筛选条件(AND关系)
optional int32 sortField = 5; // SortField, 排序字段(固定降序), 默认由rankType决定
}
// 股息排行数据项
message DividendRankItem {
required Qot_Common.Security security = 1; // 股票
optional string name = 2; // 名称
optional string industry = 3; // 行业
// 行情
optional double curPrice = 10; // 最新价
optional double changeRate = 11; // 今日涨跌幅 (%)
optional double changeAmount = 12; // 今日涨跌额
optional double marketCap = 13; // 市值
// 股息
optional double dividendYieldTTM = 20; // 股息率TTM (%)
optional double avgDividendYield5Y = 21; // 5年平均股息率 (%)
optional int32 distributionFrequency = 22; // 派息频率 (1:年派, 2:半年派, 3:季派, 4:月派)，不支持HK市场
optional int32 dividendGrowYear = 23; // 股息连续增长年数
optional double dividendsTTM = 24; // 股息TTM (金额)
optional double payoutRatioLFY = 25; // 股息支付率LFY (%)
optional string nextPayableDate = 26; // 下次派息日 ("YYYY-MM-DD")
}
message S2C {
repeated DividendRankItem dataList = 1; // 数据列表
}
message Request {
required C2S c2s = 1;
}
message Response {
required int32 retType = 1 [default = -400]; // RetType, 返回结果
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
83
84
85
86
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
83
84
85
86
- 接口调用结果，结构参见 RetType
协议 ID
3407
Example
import mmWebsocket from "moomoo-api";
import { Common, Qot_Common } from "moomoo-api/proto";
import beautify from "js-beautify";
function QotGetDividendRank(){
const { RetType } = Common
let [addr, port, enable_ssl, key] = ["127.0.0.1", 11111, false, "xxxxxx"];
let websocket = new mmWebsocket();
websocket.onlogin = (ret, msg)=>{
if (ret) {
const req = {
c2s: { market: 1, rankType: 1, count: 3 },
};
websocket.GetDividendRank(req)
.then((res)=>{
let { errCode, retMsg, retType, s2c } = res
console.log("GetDividendRank: 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);
}
QotGetDividendRank()
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
GetDividendRank: errCode 0, retMsg , retType 0
{
"dataList": [
{ "security": { "market": 1, "code": "00288" }, "name": "万洲国际", "dividendYieldTtm": 10.569, "dividendsTtm": 0.910 },
{ "security": { "market": 1, "code": "01919" }, "name": "中远海控", "dividendYieldTtm": 8.302, "dividendsTtm": 1.125 },
{ "security": { "market": 1, "code": "01088" }, "name": "中国神华", "dividendYieldTtm": 7.578, "dividendsTtm": 3.227 }
]
}
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
接口限制
- 30 秒内最多 60 次请求
- 分页请求仅首页计入限频统计