Skip to content
Revenue Breakdown

Get historical revenue breakdown

Query the revenue breakdown of a security across multiple reporting periods by report period type and dimension (business or region). Used for the historical bar chart and detail table on the revenue breakdown detail page. bus_ids gives a fixed order of segment IDs for the dimension, which keeps segment colors consistent across periods.

GEThttps://api.lbkrs.com/v2/stock-info/business-historical

Parameters

counter_idstringqueryRequired

Security code, such as ST/US/AAPL

reportstringqueryRequired

Report period type:

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

Breakdown dimension:

  • business - By business
  • regional - By region

businessregional

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get historical revenue breakdown” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
bus_idsarray<string>

Fixed order of segment IDs for the selected dimension

historicalarray<object>

Revenue breakdown by reporting period

Child attributes
totalstring

Total revenue in currency

currencystring

Currency of the amounts, such as USD

yoystring

Year-over-year change rate of total revenue

reportstring

Report period type, such as af (annual), saf (semi-annual), or qf (single quarter)

report_txtstring

Display text of the reporting period

fp_startstring

Start date of the reporting period, as display text

fp_endstring

End date of the reporting period, as display text

rpt_datestring

Earnings disclosure date, as display text

bus_idsarray<string>

Ordered business segment IDs, used to keep segment colors consistent across periods

reg_idsarray<string>

Ordered regional segment IDs

businessarray<object>

Revenue breakdown by business

Child attributes
idstring

Segment ID, matching a value in bus_ids or reg_ids

namestring

Segment name, such as a business line or region

valuestring

Segment revenue in currency

percentstring

Share of the segment in total revenue

yoystring

Year-over-year change rate of segment revenue

regionalsarray<object>

Revenue breakdown by region

Child attributes
idstring

Segment ID, matching a value in bus_ids or reg_ids

namestring

Segment name, such as a business line or region

valuestring

Segment revenue in currency

percentstring

Share of the segment in total revenue

yoystring

Year-over-year change rate of segment revenue

Whale Docs