https://api.lbkrs.com/v5/portfolio/transactionhistoryParameters
pagestringqueryRequiredPage number, starting from 1. It is ignored when start and end are passed
sizestringqueryRequiredNumber of records per page. Broker App passes 15
business_typestringqueryProduct filter. Separate multiple values with commas, such as 1,2. Pass an empty string for no filter:
1- Cash2- Stock5- Fund7- Crypto
categorystringqueryCash direction filter. Separate multiple values with commas. Pass an empty string for no filter:
1- Outflow2- Inflow
currenciesstringqueryCurrency filter. Separate multiple values with commas, such as HKD,USD. Use values from currencies returned by Get Cash Flow Record Currencies. Pass an empty string for no filter
startstringqueryStart time as a Unix timestamp in seconds. When Broker App queries by month, it passes 00:00 on the first day of that month. Omit it for no time filter
endstringqueryEnd time as a Unix timestamp in seconds. Pass it together with start. When Broker App queries by month, it passes 00:00 on the first day of the next month
Responses
HTTP 200The request succeeded. The response body contains the result of the “Get cash flow records” operation.codemessagedatadataobjectdata structureCash flow records in the returned order. It is an empty array when there are no records
Child attributes
Record type code, such as cash_in or cash_out. Use type_name for Client-facing display
Localized record type name in the request language. Broker App displays it as the record title
Direction prefix for the amount. Broker App prepends it to amount as is; when it is empty, only the amount is displayed
Cash change amount as a decimal string. An empty value or 0 means the record only involves a change in share quantity
Currency of the amount, such as HKD or USD
Change in share quantity. When it is not empty, quantity_description provides the Client-facing text
Localized description of the share quantity change. Broker App shows it as the main value when the record only changes shares, and as secondary text when an amount is also present
Localized supplementary text for the record. Broker App shows it after the date when it is not empty
Record creation time as a Unix timestamp in seconds. Broker App groups the list by the year and month of this time
Record completion time as a Unix timestamp in seconds. Broker App displays this date in the list