Analyst estimates

Parameters#

company_idsstringoptional · query

Filter by issuer IDs. May be combined with instrument selectors; filters intersect, except on issuer-level datasets (statements, segments, estimates, earnings, insider transactions), where an instrument selector is read as its company and takes the place of company_ids, so results cover every share class.

instrument_idsstringoptional · query

Filter by stable instrument IDs. IDs and symbols may not be combined.

symbolsstringoptional · query

Convenience lookup for exchange-listed instruments as MIC:TICKER or a bare ticker, which resolves to the exchange listing that ticker; resolves at symbol_at. The MIC and the ticker are case-insensitive, and two spellings of one listing (AAPL and XNAS:AAPL) count as a repeated value. A bare ticker that names no listing as written is also read in the common vendor spellings: with an exchange suffix (RY.TO, SHEL.L, VOD.LSE, BHP.AX), ^GSPC for INDEX:GSPC, and EURUSD=X or EURUSD for FOREX:EUR-USD. A ticker may contain a space (BAC PRL) but not start or end with one. A request in which no symbol resolves returns 404 symbol-not-resolved; otherwise each symbol that does not resolve, or resolves to a listing with no rows for the request (no-data), is an entry of meta.errors. IDs and symbols may not be combined.

symbol_atstringoptional · query

Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date. Only valid with symbols.

metricstringoptional · query

Estimated metric: eps or revenue; ebitda matches nothing, as the connected source gives no EBITDA consensus.

epsrevenueebitda

periodstringoptional · query

Forecast fiscal period.

quarterlyannual

fromstringoptional · query

Inclusive lower bound on period_end.

tostringoptional · query

Inclusive upper bound on period_end; must be on or after from, so from equal to to selects one day.

effective_datestringoptional · query

Effective date, defaults to the UTC date of as_of. Returns the latest eligible snapshot on or before this date; response retains its actual snapshot date.

as_ofstringoptional · query

Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.

known_fromstringoptional · query

First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.

known_tostringoptional · query

Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.

orderstringoptional · query

Direction on period_end; ties use ID ascending.

ascdesc

Default: asc

limitintegeroptional · query

Maximum records per page.Default: 100

cursorstringoptional · query

Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.

formatstringoptional · query

Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.

jsoncsv

Response fields#

Returns data as an array of records. All example values are illustrative.

idstring

Record identifier, stable across revisions.

company_idstring

Opaque stable public identifier; never an internal database key.

period_startstring · null

Null when the source does not establish the fiscal start.

period_endstring

period end

fiscal_yearinteger · null

Issuer fiscal year; null when not supplied.

fiscal_quarterinteger · null

fiscal quarter

periodstring

Issuer fiscal period, not calendar quarter.

quarterlyannual

metricstring

Estimated metric: eps or revenue. The connected source gives no EBITDA consensus, so ebitda never occurs.

epsrevenueebitda

observed_onstring

observed on

analyst_countinteger · null

Contributing estimates.

meanobject

currency_code is required when unit=currency and null otherwise. Null value means unavailable, not zero.

lowobject

currency_code is required when unit=currency and null otherwise. Null value means unavailable, not zero.

highobject

currency_code is required when unit=currency and null otherwise. Null value means unavailable, not zero.

medianobject

currency_code is required when unit=currency and null otherwise. Null value means unavailable, not zero.

revisions_upinteger · null

Upward revisions during revision_window_days.

revisions_downinteger · null

Downward revisions during revision_window_days.

revision_window_daysinteger · null

Revision lookback days.

Response metadata#

Responses include meta.timezone. Dataset responses include next_cursor; health and exports have their own metadata. Request tracing uses the X-Request-ID header.

When something goes wrong#

An empty data: [] is a successful query with no matching records. Invalid symbols, permissions and malformed parameters produce an RFC 9457 problem with an actionable detail.

Plans#

Requires estimates.read. Access, recency and history depth come from the plan definitions the API enforces.

History is how far back a plan may request. How far records actually go for a symbol is history_from in dataset coverage. Nothing is real-time. Compare plans