Skip to content
Asset Overview and Cash

Get Cash Status Labels

Returns, by currency, the number of cash items that are frozen, unsettled, in fund subscription, or in IPO subscription, and the amounts in fund and IPO subscription for the current account. Use it to show status labels such as "N frozen" on the cash card and to add the IPO and fund withholding amounts to each currency's details. You can hide a label when its count is 0. Call it together with Get Cash Details by Currency when the Client opens the cash details page.

GEThttps://api.lbkrs.com/v4/portfolio/asset/cashlabels

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get cash status labels” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>

Status counts by currency. It is an empty array when there is no data

Child attributes
currencystring

Currency code, such as HKD or USD

frozen_countinteger

Number of frozen items

outstanding_countstring

Number of unsettled items

fund_request_countstring

Number of fund subscriptions in progress

fund_request_amountstring

Amount in fund subscriptions in progress (fund withholding)

ipo_request_countstring

Number of IPO subscriptions in progress

ipo_request_amountstring

Amount in IPO subscriptions in progress (IPO withholding)

Whale Docs