Rating Summary

GET /api/v1.0/quote/{symbol}/research/rating-summary

Get an analyst rating summary for a single stock, aggregated by institution or by analyst. Returns: inst_rating_summary_list (populated when rating_dimension_type=1) with institution_info (institution ID, logo URL, localized and English names, source, update time) and rating_item_list (analyst ID, institution ID, rating 1-5, target price, recommendation date, report URL, update time); analyst_rating_summary_list (populated when rating_dimension_type=2) with analyst_info (analyst ID, name, avatar, star rating, overall/per-symbol success rate and returns, owning institution info) and rating_item_list of the same structure. rating_dimension_type=1 (institution) / 2 (analyst); opaque next_key cursor pagination, limit per page (default 10, max 20), top-level pagination has total+has_more+next_key; the unselected dimension's list is empty. For overall consensus and target price use quote.research_analyst_consensus; for Morningstar reports use quote.research_morningstar_report.

Parameters

Name	Type	In	Required	Description
symbol	string	path	yes	Stock symbol (path parameter), e.g. US.AAPL / HK.00700
rating_dimension_type	int	query	no	Rating dimension, default 1. 1=institution dimension (aggregated by institution) / 2=analyst dimension (aggregated by analyst)
next_key	string	query	no	Pagination cursor (empty for first page). Pass back pagination.next_key; stop when pagination.has_more=false
limit	int	query	no	Page size, default 10, max 20

Example

curl 'https://webapi.moomoo.com/api/v1.0/quote/US.AAPL/research/rating-summary' | jq

Response

Name	Type	Description
data.inst_rating_summary_list	object[]	Institution-dimension summary list (populated only when rating_dimension_type=1; otherwise empty array)
data.inst_rating_summary_list[].institution_info	object	Institution info object
data.inst_rating_summary_list[].institution_info.institution_uid	string	Institution unique ID
data.inst_rating_summary_list[].institution_info.institution_picture_url	string	Institution logo image URL
data.inst_rating_summary_list[].institution_info.institution_name	string	Institution name (localized)
data.inst_rating_summary_list[].institution_info.update_time	int	Institution info update time, millisecond timestamp
data.inst_rating_summary_list[].institution_info.update_time_str	int	Institution info update time string (ISO8601)
data.inst_rating_summary_list[].institution_info.institution_source_name	string	Institution source name (data source identifier)
data.inst_rating_summary_list[].institution_info.institution_en_name	string	Institution English name
data.inst_rating_summary_list[].rating_item_list	object[]	Rating items list under this institution
data.inst_rating_summary_list[].rating_item_list[].analyst_uid	string	Analyst unique ID
data.inst_rating_summary_list[].rating_item_list[].institution_uid	string	Owning institution ID
data.inst_rating_summary_list[].rating_item_list[].rating	string	Analyst rating : 1=Sell / 2=Hold / 3=Buy
data.inst_rating_summary_list[].rating_item_list[].target_price	number	Target price (in report currency)
data.inst_rating_summary_list[].rating_item_list[].recommendation_date	int	Rating recommendation date, millisecond timestamp
data.inst_rating_summary_list[].rating_item_list[].recommendation_date_str	int	Rating recommendation date string (ISO8601)
data.inst_rating_summary_list[].rating_item_list[].rating_url	string	Rating report URL
data.inst_rating_summary_list[].rating_item_list[].update_time	int	Rating item update time, millisecond timestamp
data.inst_rating_summary_list[].rating_item_list[].update_time_str	int	Rating item update time string (ISO8601)
data.analyst_rating_summary_list	object[]	Analyst-dimension summary list (populated only when rating_dimension_type=2; otherwise empty array)
data.analyst_rating_summary_list[].analyst_info	object	Analyst info object
data.analyst_rating_summary_list[].analyst_info.analyst_uid	string	Analyst unique ID
data.analyst_rating_summary_list[].analyst_info.analyst_name	string	Analyst name
data.analyst_rating_summary_list[].analyst_info.analyst_picture_url	string	Analyst avatar URL
data.analyst_rating_summary_list[].analyst_info.num_of_stars	number	Analyst star rating (1-5 stars), e.g. 4.9
data.analyst_rating_summary_list[].analyst_info.success_rate	number	Overall recommendation success rate (percentage), e.g. 58.6
data.analyst_rating_summary_list[].analyst_info.excess_return	number	Average return rate (percentage), e.g. 19.2
data.analyst_rating_summary_list[].analyst_info.stock_success_rate	number	Recommendation success rate for this symbol (percentage)
data.analyst_rating_summary_list[].analyst_info.stock_avg_return	number	Average return rate for this symbol (percentage)
data.analyst_rating_summary_list[].analyst_info.update_time	int	Analyst info update time, millisecond timestamp
data.analyst_rating_summary_list[].analyst_info.update_time_str	int	Analyst info update time string (ISO8601)
data.analyst_rating_summary_list[].analyst_info.institution_info	object	Institution info that the analyst belongs to (nested object)
data.analyst_rating_summary_list[].analyst_info.institution_info.institution_uid	string	Institution unique ID
data.analyst_rating_summary_list[].analyst_info.institution_info.institution_picture_url	string	Institution logo image URL
data.analyst_rating_summary_list[].analyst_info.institution_info.institution_name	string	Institution name
data.analyst_rating_summary_list[].analyst_info.institution_info.update_time	int	Institution info update time, millisecond timestamp
data.analyst_rating_summary_list[].analyst_info.institution_info.update_time_str	int	Institution info update time string (ISO8601)
data.analyst_rating_summary_list[].analyst_info.institution_info.institution_source_name	string	Institution source name
data.analyst_rating_summary_list[].analyst_info.institution_info.institution_en_name	string	Institution English name
data.analyst_rating_summary_list[].rating_item_list	object[]	Rating items list under this analyst
data.analyst_rating_summary_list[].rating_item_list[].analyst_uid	string	Analyst unique ID
data.analyst_rating_summary_list[].rating_item_list[].institution_uid	string	Institution unique ID
data.analyst_rating_summary_list[].rating_item_list[].rating	string	Analyst rating : 1=Sell / 2=Hold / 3=Buy
data.analyst_rating_summary_list[].rating_item_list[].target_price	number	Target price (in report currency)
data.analyst_rating_summary_list[].rating_item_list[].recommendation_date	int	Rating recommendation date, millisecond timestamp
data.analyst_rating_summary_list[].rating_item_list[].recommendation_date_str	int	Rating recommendation date string (ISO8601)
data.analyst_rating_summary_list[].rating_item_list[].rating_url	string	Rating report URL
data.analyst_rating_summary_list[].rating_item_list[].update_time	int	Rating item update time, millisecond timestamp
data.analyst_rating_summary_list[].rating_item_list[].update_time_str	int	Rating item update time string (ISO8601)
pagination.total	int
pagination.has_more	bool
pagination.next_key	string

Errors

ret_code	error.code	When
0	—	Success
-3	invalid_parameter	A parameter is missing or not in the allowed set
-7	invalid_symbol	Symbol is not in the security master
-8	unsupported	Market or instrument is outside this API
-9	permission_denied	Authenticated, but without quote permission
-10	no_data	Nothing is returned
-11	rate_limited	Per-user rate limit

Response example

{
  "ret_code": 0,
  "ret_msg": "success",
  "data": {
    "inst_rating_summary_list": [
      {
        "institution_info": {
          "institution_uid": "example",
          "institution_picture_url": "example",
          "institution_name": "example",
          "update_time": 1710000000000000,
          "update_time_str": 1710000000000000,
          "institution_source_name": "example",
          "institution_en_name": "example"
        },
        "rating_item_list": "example"
      }
    ],
    "analyst_rating_summary_list": [
      {
        "analyst_info": {
          "analyst_uid": "example",
          "analyst_name": "example",
          "analyst_picture_url": "example",
          "num_of_stars": 1.2,
          "success_rate": 1.2,
          "excess_return": 1.2,
          "stock_success_rate": 1.2,
          "stock_avg_return": 1.2,
          "update_time": 1710000000000000,
          "update_time_str": 1710000000000000,
          "institution_info": "example"
        },
        "rating_item_list": "example"
      }
    ]
  },
  "pagination": {
    "total": 0,
    "has_more": false,
    "next_key": "example"
  }
}