Skip to content
Longport WhaleLongport Whale
Trading

Get IPO Subscription Buying Power

Queries the funds available to the user for subscribing to a specified IPO. Returns the IPO buying power (the total principal available for subscription, including stock collateral and cash in other currencies converted at the exchange rate), the withdrawable amount in the current currency, the money market fund (MMF) amount, the cash amount, and more. Use it on the subscription page to display buying power / broker financing / withdrawable amount in the current currency, and as the basis for determining whether the subscription principal is sufficient and for calculating the maximum subscribable tier.

GEThttps://api.lbkrs.com/v1/ipo/inventory/cash

Parameters

counter_idstringqueryRequired

IPO security id, for example ST/HK/2636. If omitted, a parameter validation failure is returned.

currencystringqueryRequired

Subscription currency, taken from the currency returned by /v3/ipo/info. Only HKD and USD are supported; if omitted or set to another value, a parameter validation failure is returned.

HKDUSD

flagintegerquery

Subscription type: 0 public offering subscription, 2 international placing subscription. If omitted, it is treated as public offering.

02

account_channelstringquery

Broker channel

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get IPO subscription buying power” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
total_amountstring

IPO buying power, that is, the total principal available for subscription (including the withdrawable amount in the current currency, cash in other currencies converted at the exchange rate, and the converted value of stock collateral). This is the "Buying power" value displayed on the subscription page, and is used as the available principal when the subscription method's financing_base_type is 0.

current_amountstring

Withdrawable amount in the current currency (including MMF), for example withdrawable HKD. The difference between total_amount and this value is the broker financing portion (other currencies converted at the exchange rate).

mmf_amountstring

Money market fund (MMF) amount, included in current_amount

cash_amountstring

Cash amount in the current currency (excluding MMF)

cash_withdrawstring

Withdrawable cash amount in the current currency. Used as the available principal when the subscription method's financing_base_type is 1 (cash based).

ipo_buy_limitstring

IPO buying power limit. Used as the available principal when the subscription method's financing_base_type is 2 (buying power based).

HTTP 400The service rejected the request because a business rule or input validation failed. Review the business codes and correct the request before retrying.
codeintegerrequired

Business status code, 0 indicates success

messagestringrequired

Human-readable result or error message.

Whale Docs