Skip to content
Market Widgets

Get the earnings and dividend calendar widget

Returns upcoming earnings or dividend events for the Calendar widget on the Markets page, selected by the source priority in sort_fields (holdings, watchlist, popular). Results depend on the current user’s holdings and watchlist. Request again when switching between earnings and dividends.

For earnings events, show estimate_revenue and estimate_eps from data_kv. For dividend events, show the ex-dividend date or payment date by activity_type, and the dividend per share from the data_kv item of the same type. Use datetime to add an event to the device calendar.

POSThttps://api.lbkrs.com/v1/stock_info/finance_calendar/widget

Request body application/json

countintegerrequired

Number of events to return. The Broker App passes 4

calendar_typestringrequired

Calendar type:

  • earning - Earnings
  • dividend - Dividend
Values
earning
dividend
sort_fieldsarray<string>

Source priority, used in array order to select events. Defaults to ["1", "2", "3"]:

  • 1 - Holdings
  • 2 - Watchlist
  • 3 - Popular

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get the earnings and dividend calendar widget” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
timezonestring

Time zone of the event times

itemsarray<object>

Calendar events

Child attributes
typestring

Calendar type:

  • earning - Earnings
  • dividend - Dividend
Values
earning
dividend
counter_idstring

Security ID

counter_namestring

Security name

marketstring

Market, such as HK or US

iconstring

Security icon URL

contentstring

Event title, such as the fiscal period name

datestring

Date text for display

datetimestring

Event time as a Unix timestamp string in seconds. Use it to add the event to the device calendar

activity_typestring

Event type:

  • report - Earnings release
  • ex-dividend - Ex-dividend
  • payment - Dividend payment
financial_market_timestring

Earnings release session:

  • before - Pre-market
  • during - During trading hours
  • after - After-hours
source_typeinteger

Why the event is included:

  • 1 - Holding
  • 2 - Watchlist
  • 3 - Popular
Values
1
2
3
data_kvarray<object>

Event data items

Child attributes
typestring

Data type:

  • estimate_revenue - Revenue estimate
  • estimate_eps - EPS estimate
  • ex-dividend, payment - Dividend per share (use the item that matches activity_type)
valuestring

Display value, already formatted

value_rawstring

Raw value

Whale Docs