Skip to content
Financials and Earnings

Get earnings consensus details

Query actual values, market consensus estimates, and comparison results of key earnings indicators for recent periods by report period type. Used for the consensus detail page opened from the latest earnings card. Unreleased periods have is_released set to false and contain only estimates. When the user switches the report period type, query again with a value from opt_periods as period_type.

GEThttps://api.lbkrs.com/v1/stock-info/financial-consensus-detail

Parameters

counter_idstringqueryRequired

Security code, such as ST/US/AAPL

period_typestringqueryRequired

Report period type:

  • af - Annual report
  • saf - Semi-annual report
  • qf - Single-quarter report

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get earnings consensus details” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
currencystring

Currency of the amounts, such as USD

cur_periodstring

Report period type of the returned data

opt_periodsarray<string>

Available report period types

listarray<object>

Consensus comparisons by reporting period

Child attributes
ff_yearstring

Fiscal year

ff_periodinteger

Fiscal period number

period_textstring

Display text of the reporting period

detailsarray<object>

Indicator comparisons for this period

Child attributes
namestring

Indicator name

descstring

Indicator description

actualstring

Actual value. Empty when is_released is false

estimatestring

Consensus estimate

compstring

Comparison of the actual value with the market consensus estimate:

  • beat_est - Beat the estimate
  • met_est - Met the estimate
  • miss_est - Missed the estimate

May be an empty string when results are not yet released or no estimate is available.

Values
beat_est
met_est
miss_est
comp_valuestring

Formatted difference between the actual value and the estimate, such as 100.3M

comp_descstring

Display text of the comparison result

is_releasedboolean

Whether the earnings for this period have been released

Whale Docs