High-yield / dividend-growth rank

GET /api/v1.0/quote/rank/dividend

High-yield / dividend-growth rank. Returns last price, change, market cap, TTM yield, 5Y average yield, distribution frequency, grow years, TTM dividends and LFY payout ratio. HIGH_YIELD sorts by yield; DIVIDEND_GROWTH sorts by consecutive grow years; sort_field overrides. Markets: HK/US/SH/SZ/SG/JP/AU/CA/MY.

Parameters

Name	Type	In	Required	Description
market	string	query	yes	Market code
rank_type	string	query	yes	Rank type. HIGH_YIELD / DIVIDEND_GROWTH
sort_field	string	query	no	Override sort field; NONE uses yield for HIGH_YIELD and grow-years for DIVIDEND_GROWTH
sort_dir	string	query	no	Sort direction, default DESCENDING
page_flag	string	query	no	Page cursor. Omit or pass empty on the first page; pass back pagination.page_flag. Stop only when pagination.completed is true
page_size	int	query	no	Page size, default 10, max 200
market_cap_min	number	query	no	Minimum market cap; omit for no lower bound
market_cap_max	number	query	no	Maximum market cap; omit for no upper bound

Example

curl -X GET 'https://webapi.futunn.com/api/v1.0/quote/rank/dividend?market=HK&rank_type=HIGH_YIELD' \
  -H 'Authorization: Bearer <AccessToken>' | jq

Response parameters

Name	Type	Description
data.items	object[]
data.items[].code	string	Symbol
data.items[].name	string	Security name
data.items[].industry	string	Industry (empty; screener does not return it)
data.items[].cur_price	string	Last price
data.items[].change_rate	number	Change ratio in percent
data.items[].change_amount	string	Change amount
data.items[].market_cap	number	Market cap
data.items[].dividend_yield_ttm	number	TTM dividend yield in percent
data.items[].avg_dividend_yield_5y	string	5-year average yield (placeholder 0; screener has no factor)
data.items[].distribution_frequency	string	Distribution frequency (placeholder N/A)
data.items[].dividend_grow_year	string	Consecutive grow years (placeholder 0)
data.items[].dividends_ttm	string	TTM dividends (placeholder 0)
data.items[].payout_ratio_lfy	string	LFY payout ratio (placeholder 0)
pagination.total	int
pagination.completed	bool	True when this is the last page. Stop paging only when completed is true
pagination.page_flag	string	Next page cursor. Pass it back as page_flag while completed is false; empty on the last page

Errors

ret_code	error.code	Description
0	—	Success
-3	invalid_parameter	Missing or invalid parameter
-8	unsupported	Not supported
-10	no_data	No data

Response example

{
  "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
  }
}