Skip to content
Dividends

List dividend plans

Returns the security's dividend plans, including the description, ex-dividend date, record date, and payment date, newest first. Use it for the dividend block on the Overview tab (first few items) and the full dividend list page. It also powers the dividend module on the earnings report page and the dividend detail page in the company profile. Date fields are display strings; show them as is.

GEThttps://api.lbkrs.com/v1/stockfeed/dividend

Parameters

counter_idstringqueryRequired

Security ID, such as ST/US/AAPL

sizestringqueryRequired

Number of records as a decimal string. Pass an empty string to get all plans. The Broker App passes 3 for the block and an empty string for the list page

Responses

HTTP 200The request succeeded. The response body contains the result of the “List dividend plans” operation.
Standard response envelopecodemessagedata
dataobjectdata structure

Dividend plans

listarray<object>

Plans. Empty when there are none

Child attributes
counter_idstring

Security ID

descstring

Plan description, such as the dividend per share. Display it as is

ex_datestring

Ex-dividend date as a display string

record_datestring

Record date as a display string

payment_datestring

Payment date as a display string

totalinteger

Total number of plans

Whale Docs