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 financial consensus estimates including revenue, EPS, and net income forecasts.
Request
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
symbol | string | Required | Security symbol, e.g. `TSLA.US` |
Response
Response properties
| Name | Type | Required | Description |
|---|---|---|---|
list | object[] | Optional | List of consensus forecast periods |
└ fiscal_year | integer | Optional | Fiscal year |
└ fiscal_period | string | Optional | Fiscal period number within the fiscal year |
└ period_text | string | Optional | Display period label (e.g. Q1 2027) |
└ details | object[] | Optional | List of financial indicator details |
└ ∟ key | string | Optional | Indicator key (e.g. `eps`, `revenue`) |
└ ∟ name | string | Optional | Security name. |
└ ∟ description | string | Optional | Full description |
└ ∟ estimate | string | Optional | Consensus estimate |
└ ∟ is_released | boolean | Optional | Whether actual has been released |
└ ∟ actual | string | Optional | Actual reported value |
└ ∟ comp_value | string | Optional | Comparison percentage value |
└ ∟ comp_desc | string | Optional | Comparison description |
└ ∟ comp | string | Optional | Comparison result (e.g. `beat`, `miss`) |
current_index | integer | Optional | Index of the current period in opt_periods |
currency | string | Optional | Reporting currency |
opt_periods | array | Optional | Available period options |
current_period | string | Optional | Current period code (e.g. `qf`) |
Response JSON example
{
"code": 0,
"message": "success",
"data": {
"currency": "USD",
"current_index": 3,
"current_period": "qf",
"opt_periods": [
"qf",
"af",
"saf"
],
"list": [
{
"fiscal_year": 2026,
"fiscal_period": "Q2 FY2026",
"period_text": "Q2 FY2026",
"details": [
{
"key": "revenue",
"name": "Revenue",
"estimate": "95000000000",
"actual": "",
"comp": "",
"comp_value": null,
"comp_desc": "",
"description": "",
"is_released": false
}
]
}
]
}
}Error code
See the Error Codes page for the full list of error codes.