https://api.lbkrs.com/v1/app/be/listRequest body application/json
Query conditions
Child attributes
Page number, starting from 1. The Broker App passes 1
Records per page. The Broker App passes 100
Filters
Child attributes
Market code, such as HK or US. The Broker configures the available values
Event status:
UNSELECTED- Awaiting electionSELECTED- Elected, pending distributionDISTRIBUTED- Distributed
UNSELECTEDSELECTEDDISTRIBUTED
Responses
HTTP 200The request succeeded. The response body contains the result of the “List dividend election events” operation.codemessagedatadataobjectdata structureEvents. Empty when there are no records
Child attributes
Event ID used for calculation and submission
Security ID of the holding, such as ST/HK/700
Ticker of the holding
Name of the holding
Market code, such as HK
Registered shares, that is, the shares eligible for this corporate action
Record date as a Unix timestamp in seconds
Election start time as a Unix timestamp in seconds
Election deadline as a Unix timestamp in seconds. The Client must submit before this time
Expected payment date as a Unix timestamp in seconds
Elected option, present only for events already elected:
CashDividend- All cashScripDividend- All sharesScripAndCash- Shares and cash
Distribution status, used in history:
SELECTED- Elected, pending distributionDISTRIBUTED- Distributed
Cash options. When there is more than one, the Client can choose by currency
Child attributes
Option ID used when submitting the election
Dividend currency, such as HKD
Estimated cash amount if all registered shares elect this option, as a decimal string
Dividend per share, as a decimal string. Submit it as cash_surplus_value when calculating a stock-and-cash split
Whether this is the default cash option. If none is marked, use the first option
Scrip option (shares instead of cash)
Child attributes
Option ID used when submitting the election
Security ID of the shares to be distributed, such as ST/HK/700
Ticker of the shares to be distributed
Name of the shares to be distributed
Currency of the conversion price and per-share value
Conversion price, as a decimal string
Dividend per share for the scrip option, as a decimal string. Submit it as stock_surplus_value when calculating a stock-and-cash split
Estimated shares receivable if all registered shares elect the scrip option. It is also the upper limit of shares that can be allocated in a stock-and-cash split
Current page number
Records per page
Total number of records