Approximate high-dividend SOE rank matching OpenD

GET /api/v1.0/quote/rank/high-dividend-soe

Approximate high-dividend SOE rank matching OpenD Qot_GetHighDividendSOERank: HK, PB<=1, TTM yield>=5%, PE>=0, sorted by the given field (default market cap). Returns last price, change, market cap, PE/PB, yield and multi-period ratios. Test environments may return an empty list. count defaults to 10 (max 300).

Parameters

Name	Type	In	Required	Description
sort_field	string	query	no	Sort field, default MARKET_CAP
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 300

Example

curl -X GET 'https://webapi.moomoo.com/api/v1.0/quote/rank/high-dividend-soe' \
  -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_ratio	string	Change ratio in percent
data.items[].market_cap	number	Market cap
data.items[].pe_ttm	number	PE TTM
data.items[].pb	number	PB
data.items[].dividend_yield_ttm	number	TTM dividend yield in percent
data.items[].change_rate_5d	number	5-day change ratio in percent
data.items[].change_rate_10d	number	10-day change ratio in percent
data.items[].change_rate_20d	number	20-day change ratio in percent
data.items[].change_rate_60d	number	60-day change ratio in percent
data.items[].change_rate_120d	number	120-day change ratio in percent
data.items[].change_rate_250d	number	250-day change ratio in percent
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_ratio": "example",
        "market_cap": 1.2,
        "pe_ttm": 1.2,
        "pb": 1.2,
        "dividend_yield_ttm": 1.2,
        "change_rate_5d": 1.2,
        "change_rate_10d": 1.2,
        "change_rate_20d": 1.2,
        "change_rate_60d": 1.2,
        "change_rate_120d": 1.2,
        "change_rate_250d": 1.2
      }
    ]
  },
  "pagination": {
    "page_flag": "",
    "completed": true,
    "total": 0
  }
}