Skip to content
Transaction History

Get Cash Flow Records

Queries the cash flow records of the current account with pagination. Each record includes the record type, amount and currency, direction prefix, share quantity change text, supplementary text, and creation and completion times. Use it for the list on the Funds Details page. You can filter by product, cash direction, currency, and time range. Localized text such as the record type name follows the request's Accept-Language.

Without start and end, results are paged by page and size; fewer than size records means there are no more pages. With start and end, the operation returns all records in that range and ignores page. Some Brokers' customized cash flow record pages also use this operation.

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

GEThttps://api.lbkrs.com/v5/portfolio/transactionhistory

Parameters

pagestringqueryRequired

Page number, starting from 1. It is ignored when start and end are passed

sizestringqueryRequired

Number of records per page. Broker App passes 15

business_typestringquery

Product filter. Separate multiple values with commas, such as 1,2. Pass an empty string for no filter:

  • 1 - Cash
  • 2 - Stock
  • 5 - Fund
  • 7 - Crypto
categorystringquery

Cash direction filter. Separate multiple values with commas. Pass an empty string for no filter:

  • 1 - Outflow
  • 2 - Inflow
currenciesstringquery

Currency 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

startstringquery

Start 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

endstringquery

End 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.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>

Cash flow records in the returned order. It is an empty array when there are no records

Child attributes
tx_typestring

Record type code, such as cash_in or cash_out. Use type_name for Client-facing display

type_namestring

Localized record type name in the request language. Broker App displays it as the record title

categorystring

Direction prefix for the amount. Broker App prepends it to amount as is; when it is empty, only the amount is displayed

amountstring

Cash change amount as a decimal string. An empty value or 0 means the record only involves a change in share quantity

currencystring

Currency of the amount, such as HKD or USD

stock_quantitystring

Change in share quantity. When it is not empty, quantity_description provides the Client-facing text

quantity_descriptionstring

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

descriptionstring

Localized supplementary text for the record. Broker App shows it after the date when it is not empty

created_atstring

Record creation time as a Unix timestamp in seconds. Broker App groups the list by the year and month of this time

done_atstring

Record completion time as a Unix timestamp in seconds. Broker App displays this date in the list

Whale Docs