Skip to content
Money Market Fund (MMF)

Get MMF Subscription Settings

Returns the money market fund (MMF) subscription settings of a Client with an opened account: the subscription mode (automatic or manual selection), and for each currency the available money market funds, the current subscription fund, and whether auto-subscription is paused. The MMF plan page and the subscription management page call it on load to show the current settings and to prepare the data for POST /portfolio/mmf/save_mmf_purchase.

pending_auth_funds lists funds that were newly added to the fund pool and still need the Client to confirm authorization. A fund that is not in this list is treated as authorized. In automatic mode, show only authorized funds.

For a Client without an opened account, use GET /ut/mmf/fund/list to browse the available funds instead.

GEThttps://api.lbkrs.com/portfolio/mmf/get_mmf_purchase

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get MMF Subscription Settings” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
is_auto_purchaseboolean

Subscription mode: true selects the subscription fund automatically; false means the Client picks one subscription fund per currency

currency_fundsarray<object>

Subscription settings grouped by currency

Child attributes
currencystring

Currency, such as USD

currency_namestring

Display name of the currency

is_pausedboolean

Whether MMF auto-subscription is paused for this currency

purchase_fundobject

Basic information of a money market fund used by MMF

Child attributes
counter_idstring

Fund security code, such as UT/HK/...

currencystring

Fund currency, such as USD, HKD, or SGD

isinstring

Fund ISIN

namestring

Fund name

seven_day_annualized_yieldstring

7-day annualized yield as a decimal, such as 0.0412 for 4.12%. It can be an empty string when no yield data is available

fundsarray<object>

Money market funds available in this currency

Child attributes
fund_detailobject

Basic information of a money market fund used by MMF

Child attributes
counter_idstring

Fund security code, such as UT/HK/...

currencystring

Fund currency, such as USD, HKD, or SGD

isinstring

Fund ISIN

namestring

Fund name

seven_day_annualized_yieldstring

7-day annualized yield as a decimal, such as 0.0412 for 4.12%. It can be an empty string when no yield data is available

is_holdingboolean

Whether the current account holds this fund

is_selectedboolean

In manual mode, whether this fund is the selected subscription fund of the currency

pending_auth_fundsarray<object>

Funds awaiting authorization by the Client

Child attributes
counter_idstring

Fund security code, such as UT/HK/...

currencystring

Fund currency, such as USD, HKD, or SGD

isinstring

Fund ISIN

namestring

Fund name

seven_day_annualized_yieldstring

7-day annualized yield as a decimal, such as 0.0412 for 4.12%. It can be an empty string when no yield data is available

Whale Docs