Skip to content
Other Product Holdings

Get Fund Dividend Records

Returns, with pagination, the dividend records of a fund in the specified time range (dividend date, dividend method, and amount) and the total dividends in the range. Use it for the Dividend Records page in fund holding details. Results are paged by page and size; fewer than size records means there are no more pages. Dividend amounts are converted to the requested currency.

When you call it through WhaleCore requestService(), declare the trade token requirement by setting requiresTradeToken to true.

GEThttps://api.lbkrs.com/v2/portfolio/ut/divcashlist

Parameters

account_channelstringqueryRequired

Account channel. Use the account_channel of the current account

counter_idstringqueryRequired

Fund ID (counter_id)

currencystringquery

Currency to convert dividend amounts into, such as USD. Pass an empty string if not specified

pagestringqueryRequired

Page number, starting from 1

sizestringqueryRequired

Number of records per page. Broker App passes 20

startstringquery

Start time as a Unix timestamp in seconds

endstringquery

End time as a Unix timestamp in seconds

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get fund dividend records” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
currencystring

Currency of the dividend amounts

total_div_cashstring

Total dividends in the range

div_cash_infosarray<object>

Dividend records on this page

Child attributes
datestring

Dividend date as a Unix timestamp in seconds

counter_idstring

Fund ID (counter_id)

namestring

Fund name

div_methodstring

Display text of the dividend method. Show it as is

amountstring

Dividend amount

currencystring

Dividend currency, which matches the requested currency

Whale Docs