Docs/Reference/Earnings/Get Earnings Surprise
GET/v1/companies/{code}/earnings/surpriseTier · Institutional

Get Earnings Surprise

Compare actual earnings against prior management forecasts.

For each earnings snapshot, finds the most recent prior snapshot that contained a forecast, then computes the surprise (beat/miss) percentage.

Path parameters · 1

Variables interpolated into the URL path.

codestringrequired

Request headers · 1

Authentication.

Authorizationstringrequired

Production API key. Pass it as Bearer ax_live_…

Returns · 200

The standard { data, meta } envelope. data contains an array of EarningsSurpriseOut.

Envelope

dataEarningsSurpriseOut[]

Array of result objects.

metaMeta

Pagination and request metadata, including request_id, data_as_of, and ontology_version.

ontology_version 2.1.0replay meta.as_of · ?as_of=<token>

EarningsSurpriseOut

securities_codestring | null
company_namestring | null
company_name_enstring | null
fiscal_year_endstring | null
period_typestring | null
filing_datestring | null
accounting_standardstring | null
is_consolidatedboolean | null
tdnet_pdf_urlstring | null

URL of the source 決算短信 PDF on TDNet. Every number traces back here.

revenueinteger | null
operating_incomeinteger | null
ordinary_incomeinteger | null
net_incomeinteger | null
comprehensive_incomeinteger | null
revenue_change_pctnumber | null
operating_income_change_pctnumber | null
net_income_change_pctnumber | null
epsnumber | null
diluted_epsnumber | null
bpsnumber | null
dps_annualnumber | null
total_assetsinteger | null
net_assetsinteger | null
equity_ratio_pctnumber | null
operating_cfinteger | null
investing_cfinteger | null
financing_cfinteger | null
cash_endinteger | null
roe_pctnumber | null
roa_pctnumber | null
operating_margin_pctnumber | null
surpriseobject

Errors

Standard HTTP status codes plus a typed error.code in the { error: { code, message } } envelope.

Every endpoint returns the same typed error envelope ({ error: { code, message } }). For the full list of codes, see the Errors reference.