Returns analyst estimates for the specified financial statement field
(fsFieldId) compared against actual published values for the same
period. Useful for building earnings-surprise charts and consensus
beat/miss dashboards.
Common fsFieldId values
| ID | Field |
|---|---|
54 (default) |
Net Income |
1 |
Revenue |
3 |
Operating Income |
8 |
EPS |
Period values — year (default), quarter, interim.
Tip: For ID-based estimates use
GET /companies/{id}/analyst-estimates.
Fiscal year to query (e.g. 2024).
Example:2024
Fiscal period type: year (default), quarter, or interim. Defaults to year.
Default:year
Example:year
Financial statement field ID to query. Default 54 (Net Income). Defaults to 54.
Default:54
Example:54
Company trading symbol / ticker (e.g. 2222 for Saudi Aramco).
Success
Returns the analyst opinions for the company identified by stockSymbol.
Paginated: use page and pageSize.
Numeric market identifier (e.g. 1 = Tadawul / Saudi main market). Use GET /api/v1.1/markets to list valid values. Defaults to 3.
Default:3
Example:3
1-based page number. Defaults to 1.
Default:1
Example:1
Maximum number of records to return. Defaults to 10.
Default:10
Example:10
Tadawul stock symbol of the company, e.g. 2222 (Saudi Aramco).
Example:2222
Success
Returns the market-level ratio identified by marketSymbol.
Numeric fiscal period type identifier (quarterly / half-yearly / annual). Defaults to 1.
Default:1
Example:1
When true, excludes Saudi Aramco (2222) from aggregates so a single mega-cap does not dominate market-level figures. Defaults to 0.
Default:0
Example:0
Numeric market identifier (e.g. 1 = Tadawul / Saudi main market). Use GET /api/v1.1/markets to list valid values.
Example:3
Success
Standardized successful API response wrapper for v1.0.0 endpoints.
Always true for successful responses.
Semantic API version (e.g., “1.0.0”).
UTC timestamp when the response was generated.
Unique request identifier for tracing.
The response payload.
Pagination and metadata information for collection responses.
Rate limit information returned with each response.
Returns companies in the market ranked highest-first by the requested metric.
Numeric market identifier (e.g. 1 = Tadawul / Saudi main market). Use GET /api/v1.1/markets to list valid values.
Example:3
Ranking metric to sort by (e.g. pe, market-cap, dividend-yield).
Success
Returns the twenty lowest-ranked companies in the market for the requested metric.
Time window for the series, e.g. 1d, 1m, 3m, 1y, 5y. Defaults to quarter.
Default:quarter
Example:year
Numeric market identifier (e.g. 1 = Tadawul / Saudi main market). Use GET /api/v1.1/markets to list valid values.
Example:3
Ranking metric to sort by (e.g. pe, market-cap, dividend-yield).
Success