Earnings Screener
Query reported earnings and estimates by reporting period for a single stock.
Available data
- Returns
- Query reported earnings and estimates by reporting period for a single stock
- What each request returns
- Use schema_version=earnings_screener.v1 and entity_id or market-prefixed symbol. The verified example returns partial: inspect coverage and comparison_status; missing values are not zero. REST-only.
Authentication
Query Parameters
schema_versionstringqueryrequiredSchema version; use earnings_screener.v1. · earnings_screener.v1
request_idstringqueryoptionalRequest identifier
Provide entity_id or a market-prefixed symbol, such as US.AAPL
entity_idstringqueryoptionalEntity identifier; provide entity_id or a market-prefixed symbol
symbolstringqueryExampleUS.AAPLoptionalSymbol with market prefix, e.g. US.AAPL; alternative to entity_id
marketstringqueryoptionalEquity market code. · us_equity / hk_equity / kr_equity
period_typestringqueryoptionalPeriod type: quarterly, annual or both (all). · quarterly / annual / all · Default: quarterly
period_limitintegerqueryoptionalMaximum reporting periods; default 15, range 1–15. · ≥ 1, ≤ 15
include_actualbooleanqueryoptionalInclude reported actual values. · Default: true
include_forecastbooleanqueryoptionalInclude forecast values. · Default: true
Response
schema_versionstringSchema version; use earnings_screener.v1
request_idstringRequest identifier
data_statusDataStatusData status
empty_reasonunknown | nullReason for an empty result
marketMarketMarket code
entity_idstringentity_id
available_period_types[]string[]Available period types
available_metrics[]string[]Available metrics
selected_period_typestringSelected period type
latest_periodstringLatest reporting period
period_countnumberReturned period count
Reporting periods
period_keystringReporting period identifier
period_labelstringReporting period label
period_typestringPeriod type: quarterly, annual or both (all)
fiscal_yearnumberFiscal year
fiscal_quarternumberFiscal quarter
report_datedatetimeReport date
report_statusstringReport status
revenue_actualnumberReported revenue
revenue_estimatenumberEstimated revenue
revenue_actual_yoynumberActual revenue year-over-year change (ratio)
revenue_estimate_yoynumberEstimated revenue year-over-year change (ratio)
revenue_surprise_absnumberRevenue minus estimate
revenue_surprise_pctnumberRevenue surprise ratio
eps_actualnumberReported EPS
eps_estimatenumberEstimated EPS
eps_actual_yoynumberActual EPS year-over-year change (ratio)
eps_estimate_yoynumberEstimated EPS year-over-year change (ratio)
eps_surprise_absnumberEPS minus estimate
eps_surprise_pctnumberEPS surprise ratio
currencystringCurrency
eps_basisstringEPS basis
announcement_cutoff_utcunknown | nullAnnouncement cutoff in UTC; null if unavailable
comparison_statusstringActual/estimate comparability
data_statusDataStatusData status
empty_reasonunknown | nullReason for an empty result
Summary
period_keystringReporting period identifier
revenue_actualnumberReported revenue
eps_actualnumberReported EPS
revenue_surprise_pctnumberRevenue surprise ratio
eps_surprise_pctnumberEPS surprise ratio
Coverage and missing-data details
requested_period_limitnumberrequested_period_limit
available_period_countnumberavailable_period_count
returned_period_countnumberreturned_period_count
history_insufficientbooleanhistory_insufficient
period_continuitystringperiod_continuity
history_startstringhistory_start
history_endstringhistory_end
source_statusstringsource_status
source_refs
source_tables[]string[]source_tables
actual_ownerstringactual_owner
generated_atdatetimegenerated_at