Fundamental
Authorization
Signed mode: every request is signed with your App Key/Secret. Header set:
| Name | Type | Required | Description |
|---|---|---|---|
Authorization | string · header | Required | The account Access Token from the OpenAPI dashboard — passed as the raw token (no Bearer prefix) and included in the signature calculation. |
X-Api-Key | string · header | Required | Your App Key. |
X-Timestamp | string · header | Required | Request timestamp in seconds (Unix epoch). |
X-Api-Signature | string · header | Required | HMAC-SHA256 signature. Format: HMAC-SHA256 SignedHeaders=authorization;x-api-key;x-timestamp, Signature=. |
Get analyst institution rating snapshot (rating distribution and average target price).
Request
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
symbol | string | Required | Security symbol, e.g. `TSLA.US` |
Response
Response properties
| Name | Type | Required | Description |
|---|---|---|---|
evaluate | object | Optional | Analyst rating distribution. |
└ buy | integer | Optional | Number of Buy ratings. |
└ over | integer | Optional | Number of Overweight ratings. |
└ hold | integer | Optional | Number of Hold ratings. |
└ under | integer | Optional | Number of Underweight ratings. |
└ sell | integer | Optional | Number of Sell ratings. |
└ total | integer | Optional | Total number of ratings. |
└ start_date | string | Optional | Statistics start time (Unix seconds). |
└ end_date | string | Optional | Statistics end time (Unix seconds). |
└ no_opinion | integer | Optional | Number of analysts with no opinion. |
target | object | Optional | Target-price consensus. |
└ highest_price | string | Optional | Highest target price. |
└ lowest_price | string | Optional | Lowest target price. |
└ prev_close | string | Optional | Previous close price. |
└ start_date | string | Optional | Statistics start time (Unix seconds). |
└ end_date | string | Optional | Statistics end time (Unix seconds). |
industry_id | integer | Optional | Industry ID. |
industry_name | string | Optional | Industry name. |
industry_rank | integer | Optional | The security's rank within its industry. |
industry_total | integer | Optional | Number of securities in the industry. |
industry_mean | integer | Optional | Industry mean rating rank. |
industry_median | integer | Optional | Industry median rating rank. |
Response JSON example
{
"code": 0,
"message": "success",
"data": {
"latest": {
"evaluate": {
"buy": 18,
"hold": 17,
"sell": 4,
"no_opinion": 4,
"over": 5,
"under": 3,
"total": 51,
"start_date": "1778198400",
"end_date": "0"
},
"industry_id": 87676,
"industry_mean": 10,
"industry_median": 4,
"industry_name": "Automobiles",
"industry_rank": 1,
"industry_total": 30,
"target": {
"highest_price": "600.000",
"lowest_price": "123.000",
"prev_close": "428.35",
"start_date": "1778198400",
"end_date": "0"
}
},
"summary": {
"ccy_symbol": "$",
"change": "0",
"recommend": "Buy",
"updated_at": "1778198400",
"evaluate": {
"buy": 18,
"hold": 17,
"sell": 4
},
"target": {
"average_target": "350.00",
"highest_price": "600.000",
"lowest_price": "123.000"
}
}
}
}Error code
See the Error Codes page for the full list of error codes.