Skip to content
Longport WhaleLongport Whale
Trading

Refresh IPO Subscription Methods

Re-fetches the list of subscription methods currently available for the specified IPO (including the latest state of each financing pool, such as the financing multiple, interest rate, remaining quota, and quota label). Use it to refresh the subscription methods manually on the subscription page, and to refresh them after a subscription fails because the financing pool quota is insufficient or the selected financing method has ended. The response structure is the same as methods in /v3/ipo/info.

GEThttps://api.lbkrs.com/v1/ipo/fetch_pool

Parameters

counter_idstringqueryRequired

IPO security id, such as ST/HK/2636. If omitted, or if the security is not an IPO, the error "Failed to get IPO security information" is returned.

account_channelstringquery

Broker channel

Responses

HTTP 200The request succeeded. The response body contains the result of the “Refresh IPO subscription methods” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
methodsarray<object>

List of available subscription methods (including each financing pool batch). Broker App distinguishes subscription methods by value, and distinguishes different financing pools under the same subscription method by batch_id.

Child attributes
keystring

Subscription method key, for example cash (cash subscription), financing (financed subscription), or financingHK (Hong Kong channel financed subscription)

valueinteger

Subscription method, passed as method when submitting a subscription:

  • 1: Financed subscription
  • 2: Cash subscription
  • 3: Hong Kong channel financed subscription
  • 5: Zero-principal subscription
  • 6: Dynamic financed subscription
Values
1
2
3
5
6
display_namestring

Display name of the subscription method, for example "Cash"

feestring

Subscription handling fee

currencystring

Currency

deadlinestring

Deadline of this subscription method, Unix timestamp (in seconds). Different subscription methods may have different deadlines.

start_atstring

Start time of this subscription method, Unix timestamp (in seconds). "0" means no restriction. The method cannot be selected before the start time.

is_endedboolean

Whether this subscription method has closed

multiplestring

Financing multiple. "1" for cash subscription.

minstring

Minimum financing multiple

maxstring

Maximum financing multiple

ratiostring

Financing ratio or maximum financing ratio. "0" for cash subscription. Broker App calculates the financing amount as "subscription amount × ratio".

finance_fee_ratestring

Annualized financing interest rate, for example "0.0398" means 3.98%

min_cashstring

Minimum subscription principal. "0.00" means no restriction; when greater than 0, the subscription principal cannot be lower than this value.

remaining_amountstring

Remaining quota of the financing pool

total_amountstring

Total quota of the financing pool; empty string for subscription methods that do not use a financing pool

is_enoughboolean

Whether the financing pool quota is sufficient. When false, this subscription method cannot be selected.

batch_idstring

Financing pool batch id, passed as is when submitting a subscription. "0" for subscription methods without a financing pool.

tagstring

Quota status text (for example Sufficient quota, Limited quota, Quota exhausted)

tag_colorstring

Color of the quota status text

tagsarray<object>

List of subscription method tags

Child attributes
textstring

Tag text

typeinteger

Tag type:

  • 0: User
  • 1: Quota
Values
0
1
styleinteger

Tag style:

  • 0: No style
  • 1: Sufficient quota
  • 2: Limited quota
  • 3: Quota exhausted
  • 4: User exclusive
Values
0
1
2
3
4
bz_typesarray<integer>

Business types. When querying or claiming IPO fee cards, pass the first value as bz_type: 1 financed IPO subscription, 2 cash IPO subscription

card_typesarray<string>

Benefit card types usable with this subscription method: ipo_interest IPO financing interest card, ipo_commission IPO fee card

upper_limitinteger

Maximum number of shares that can be subscribed. -1 means no restriction. For zero-principal subscription, only tiers not exceeding this value can be selected.

mmf_statusinteger

MMF redemption status, used to display MMF related hints:

  • 1: Auto-redemption available
  • 2: Auto-redemption unavailable (advance funding not enabled)
  • 3: Auto-redemption unavailable (advance funding enabled)
Values
1
2
3
mmf_t2_trade_daystring

MMF T-2 trading day time, Unix timestamp (in seconds)

financing_base_typeinteger

Financing calculation base type. Determines which amount returned by /v1/ipo/inventory/cash Broker App uses as the available principal:

  • 0: Default (uses total_amount)
  • 1: Cash based (uses cash_withdraw)
  • 2: Buying power based (uses ipo_buy_limit)
Values
0
1
2
remarkstring

Remark text of the subscription method. When not empty, it is displayed below the subscription method card.

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