高股息 / 股息增長榜
GET/api/v1.0/quote/rank/dividend高股息 / 股息增長榜。返回現價、漲跌、市值、股息率 TTM、5 年平均股息率、派息頻率、連續增長年數、股息 TTM、派息率 LFY。 rank_type=HIGH_YIELD 按股息率排序;DIVIDEND_GROWTH 按最大連續增長年數排序;sort_field 可覆蓋。 支持市場 HK/US/SH/SZ/SG/JP/AU/CA/MY。
請求參數
| 參數 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
market | string | 查詢 | 是 | 市場代碼 |
rank_type | string | 查詢 | 是 | 榜單類型。HIGH_YIELD=高股息 / DIVIDEND_GROWTH=股息增長 |
sort_field | string | 查詢 | 否 | 覆蓋排序字段;NONE 則 HIGH_YIELD 用股息率、DIVIDEND_GROWTH 用增長年數 |
sort_dir | string | 查詢 | 否 | 排序方向,默認 DESCENDING |
page_flag | string | 查詢 | 否 | 翻頁標記。首頁不傳或傳空串;下一頁回傳上一頁響應 pagination.page_flag。只有 pagination.completed 為 true 時停止 |
page_size | int | 查詢 | 否 | 返回條數,默認 10,最大 200 |
market_cap_min | number | 查詢 | 否 | 最小市值(元),不傳不限制 |
market_cap_max | number | 查詢 | 否 | 最大市值(元),不傳不限制 |
請求示例
bash
curl -X GET 'https://webapi.moomoo.com/api/v1.0/quote/rank/dividend?market=HK&rank_type=HIGH_YIELD' \
-H 'Authorization: Bearer <AccessToken>' | jq響應參數
| 參數 | 類型 | 說明 |
|---|---|---|
data.items | object[] | |
data.items[].code | string | 標的代碼 |
data.items[].name | string | 標的名稱 |
data.items[].industry | string | 所屬行業(選股器不回傳,佔位為空串) |
data.items[].cur_price | string | 最新價 |
data.items[].change_rate | number | 漲跌幅(百分數) |
data.items[].change_amount | string | 漲跌額 |
data.items[].market_cap | number | 市值 |
data.items[].dividend_yield_ttm | number | 股息率 TTM(百分數) |
data.items[].avg_dividend_yield_5y | string | 5 年平均股息率(選股器無對應因子,佔位 0) |
data.items[].distribution_frequency | string | 派息頻率(選股器無對應因子,佔位 N/A) |
data.items[].dividend_grow_year | string | 股息連續增長年數(選股器無對應因子,佔位 0) |
data.items[].dividends_ttm | string | 股息 TTM(選股器無對應因子,佔位 0) |
data.items[].payout_ratio_lfy | string | 派息率 LFY(選股器無對應因子,佔位 0) |
pagination.total | int | |
pagination.completed | bool | 是否已到末頁。只有 true 時停止翻頁 |
pagination.page_flag | string | 下一頁標記。completed 為 false 時回傳為下一次請求的 page_flag;末頁為空串 |
錯誤碼
| ret_code | error.code | 說明 |
|---|---|---|
| 0 | — | 成功 |
| -3 | invalid_parameter | 參數不合法 |
| -8 | unsupported | 不支持 |
| -10 | no_data | 沒有數據 |
響應示例
json
{
"ret_code": 0,
"ret_msg": "success",
"data": {
"items": [
{
"code": "US.AAPL",
"name": "example",
"industry": "example",
"cur_price": "example",
"change_rate": 1.2,
"change_amount": "example",
"market_cap": 1.2,
"dividend_yield_ttm": 1.2,
"avg_dividend_yield_5y": "example",
"distribution_frequency": "example",
"dividend_grow_year": "example",
"dividends_ttm": "example",
"payout_ratio_lfy": "example"
}
]
},
"pagination": {
"page_flag": "",
"completed": true,
"total": 0
}
}