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 the monthly institutional rating (buy/hold/sell) distribution timeline, newest first.
Request
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
symbol | string | Required | Security symbol, e.g. `AAPL.US` |
Response
Response properties
| Name | Type | Required | Description |
|---|---|---|---|
elist | object[] | Optional | Monthly rating distribution list, newest first |
└ buy | string | Optional | Number of Buy ratings |
└ over | string | Optional | Number of Outperform ratings |
└ hold | string | Optional | Number of Hold ratings |
└ under | string | Optional | Number of Underperform ratings |
└ sell | string | Optional | Number of Sell ratings |
└ total | string | Optional | Total analyst count |
└ no_opinion | string | Optional | Number of analysts with no opinion. |
└ date | string | Optional | Unix timestamp (seconds) |
tlist | object[] | Optional | Time-series list. |
└ date | string | Optional | Unix timestamp (seconds) |
└ close | string | Optional | Closing price. |
└ high_price | string | Optional | High price. |
└ low_price | string | Optional | Low price. |
Response JSON example
{
"code": 0,
"message": "success",
"data": {
"elist": [
{
"date": 1746057600,
"buy": "18",
"over": "5",
"hold": "17",
"under": "3",
"sell": "4",
"total": "51"
},
{
"date": 1743379200,
"buy": "17",
"over": "6",
"hold": "18",
"under": "3",
"sell": "5",
"total": "53"
}
]
}
}Error code
See the Error Codes page for the full list of error codes.