Get IPO Subscription Info

GEThttps://api.lbkrs.com/v3/ipo/info

Parameters

counter_idstringqueryRequired

IPO security id, for example ST/HK/2636. If omitted, a parameter validation failure is returned; if a non-IPO security is passed, "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 “Get IPO subscription info” operation.

Standard response envelopecodemessagedata

dataobjectdata structure

namestring

IPO name

codestring

IPO code, for example "02636"

marketstring

Market, for example HK or US

currencystring

Subscription currency, for example HKD or USD

deadlinestring

Subscription deadline, Unix timestamp (in seconds)

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

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.

itemarray<object>

List of subscription tiers (a flat, ungrouped list). When group_item contains grouped data, Broker App uses group_item instead.

Child attributes

serial_numberinteger

Tier sequence number

apply_num_substring

Number of shares subscribed

payablestring

Amount payable

currencystring

Currency

group_itemobject

Subscription tiers grouped by Pool A / Pool B. The key is the group type: 10 Pool A, 20 Pool B, 0 ungrouped / other. When only group 0 exists, display the tiers as ungrouped.

borrowing_ratestring

Annual interest rate of broker financing (currency borrowing), for example "0.0575". Used to estimate the borrowing interest.

borrow_enableboolean

Whether currency borrowing (broker financing) is supported. When true, cash in other currencies converted at the exchange rate, stock collateral, and similar assets can be used as subscription principal.

min_subscribestring

Minimum number of shares to subscribe, used for US stock subscriptions. Empty string for HK stocks.

deduction_pricestring

Pre-deduction price, used for US stock subscriptions. Empty string for HK stocks.

available_card_countsinteger

Number of available benefit cards

card_typesarray<string>

Benefit card types supported by this IPO: ipo_interest IPO financing interest card, ipo_commission IPO fee card

frozen_ratiointeger

Frozen ratio of subscription funds (percentage), for example 120. When 0, Broker App displays it as 100.

same_kind_orderobject

The user's existing same-kind orders for this IPO, used to warn about duplicate subscriptions

Child attributes

stateinteger

Existing order status:

-1: No same-kind order (subscription allowed)
0: A regular reservation order already exists
1: An international placing reservation order already exists
2: A subscription order already exists

Values

-1
0
1
2

account_channelstring

Tenant channel of the existing order. When it differs from the current tenant channel, remind the user that another account has already participated.

order_idinteger

Existing order id. 0 when there is no same-kind order.

docobject

Subscription page copy

Child attributes

subscription_methodstring

Subscription method explanation

buying_powerstring

IPO buying power explanation

financing_intereststring

Financing interest explanation

cut_off_timestring

Subscription cut-off time explanation

financing_estimatestring

Broker financing estimate explanation

noticestring

Notice, in HTML rich text

subscription_statementstring

Subscription statement explanation

declarationobject

Multilingual subscription declaration text. When not empty, the user must confirm it before submitting the subscription. May be null.

Child attributes

zh_cnstring

Simplified Chinese

zh_hkstring

Traditional Chinese

enstring

English

piinteger

Whether this IPO requires PI (Professional Investor) certification: 0 not required, 1 required

Values

0
1

pi_statusinteger

User PI certification restriction status:

0: Unknown
1: No PI restriction
2: PI restriction applies and the user has not passed PI certification; guide the user to complete PI certification
3: PI restriction applies and the user has passed PI certification

Values

0
1
2
3

aiinteger

Whether this IPO requires AI (Accredited Investor) certification: 0 not required, 1 required

Values

0
1

ai_statusinteger

User AI certification review status:

0: Not submitted
1: Pending review
2: Approved
3: Rejected

Values

0
1
2
3

certificationinteger

Certification type required by this IPO:

0: No certification required
1: PI certification
2: AI certification

Values

0
1
2

min_cashstring

Minimum subscription amount for users without AI certification. When AI certification is required, the user has not passed it, and this value is greater than 0, guide the user to complete AI certification.

has_trade_permissionboolean

Whether the user has trading permission for this IPO. When false, the user is not allowed to enter the subscription page.

require_derivatives_knowledgeinteger

Whether a derivatives trading knowledge assessment is required: 0 not required, 1 required

Values

0
1

virtual_assetinteger

Virtual asset risk assessment requirement:

0: Not required
1: Confirmation only
2: Questionnaire required

Values

0
1
2

vaetf_flagboolean

Whether the user already has virtual asset trading permission (has completed the virtual asset risk assessment)

notify_titlestring

Reminder title (deprecated)

notify_messagestring

Reminder content (deprecated)

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.

Request

let request = WhaleCoreHTTPRequest(
    method: .get,
    path: "/v3/ipo/info"
)
request.query = [
    "counter_id": "ST/HK/2636"
]

let response = try await WhaleCoreService.requestService.send(request)
print(response.bodyString)

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "name": "Transsion Holdings",
    "code": "02636",
    "deadline": "1791766800",
    "methods": [
      {
        "key": "cash",
        "value": 2,
        "fee": "49.00",
        "currency": "HKD",
        "deadline": "1791766800",
        "multiple": "1",
        "tag": "",
        "finance_fee_rate": "0",
        "remaining_amount": "",
        "min": "1",
        "max": "1",
        "tag_color": "",
        "is_enough": true,
        "batch_id": "0",
        "tags": [],
        "is_ended": true,
        "ratio": "0",
        "bz_types": [
          2
        ],
        "card_types": [
          "ipo_commission"
        ],
        "start_at": "0",
        "upper_limit": -1,
        "mmf_t2_trade_day": "0",
        "mmf_status": 1,
        "min_cash": "0.00",
        "display_name": "Cash",
        "remark": "",
        "financing_base_type": 0
      }
    ],
    "currency": "HKD",
    "item": [
      {
        "serial_number": 1,
        "apply_num_sub": "100",
        "payable": "3919.13",
        "currency": "HKD"
      },
      {
        "serial_number": 2,
        "apply_num_sub": "200",
        "payable": "7838.26",
        "currency": "HKD"
      },
      {
        "serial_number": 3,
        "apply_num_sub": "300",
        "payable": "11757.39",
        "currency": "HKD"
      }
    ],
    "notify_title": "",
    "notify_message": "",
    "borrowing_rate": "0.0575",
    "min_subscribe": "",
    "market": "HK",
    "deduction_price": "",
    "available_card_counts": 0,
    "card_types": [
      "ipo_interest",
      "ipo_commission"
    ],
    "frozen_ratio": 0,
    "same_kind_order": {
      "state": -1,
      "account_channel": "",
      "order_id": 0
    },
    "borrow_enable": true,
    "doc": {
      "subscription_method": "Bank financed subscription: The maximum multiple of the broker's bank financing (\"up to 10x leverage\") varies by stock. Some popular stocks have quota limits, and some stocks do not support this bank financing method.\nRegular subscription: You can use the withdrawable HKD in your account for cash subscription, or use your account assets (including stock market value as collateral, available HKD cash, and cash in other currencies converted at the exchange rate) for IPO subscription with currency borrowing.",
      "buying_power": "Taking HKD as an example (the same rules apply to other currencies), the broker supports using available cash and stock collateral in your account as principal for IPO subscription.\nPrincipal available for IPO subscription is defined as: the market value of held stocks converted at a certain margin ratio + the available cash in the account.\nBroker financed IPO subscription means borrowing currency against pledged stocks, and automatically converting cash in currencies other than HKD into HKD for IPO subscription. If the withdrawable HKD is insufficient when the payment is deducted at the end of the subscription, broker financing is used by default and \"financing interest\" is charged.\nNote: Cash accounts do not have the broker financing service, so the IPO buying power of a cash account does not include broker financing. The broker financing portion can be repaid at any time through a deposit or currency exchange.",
      "financing_interest": "Taking HKD as an example (the same rules apply to other currencies).\nFor margin accounts, daily IPO subscription financing interest = IPO subscription bank financing interest + IPO subscription broker financing interest = IPO subscription bank financing amount * bank financing interest rate / 365 + HKD broker financing amount * broker financing interest rate / 365.\nNote: Cash accounts do not have the broker financing service, so the IPO subscription financing interest calculation does not include a broker financing interest portion.\nIPO subscription bank financing interest rate: Refer to the subscription page; it varies by stock.\nBroker financing interest rate: Check it under \"Assets - My Rates\".\nDaily financing interest is for reference only; the statement prevails.",
      "cut_off_time": "Cash and broker financed subscription: The deadline is 09:00 on the date announced by the exchange.\n\"Up to 10x\" bank financed subscription: Because the subscription procedures need to be processed, the subscription period ends 1 business day before the date announced by the exchange, usually at 16:00. Refer to the subscription page for details.\nTo make sure your IPO subscription succeeds, deposit funds in advance.",
      "financing_estimate": "If the withdrawable amount in the corresponding currency of the account is insufficient when the payment is deducted at the end of the subscription, broker financing is used by default. The value here is an estimate; \"financing interest\" is charged based on the actual funds in the account on each trading day after the deduction.\nNote: The broker financing portion can be repaid at any time through a deposit or currency exchange. Note: The broker financing portion can be repaid at any time through a deposit or currency exchange. Note: The broker financing portion can be repaid at any time through a deposit or currency exchange.",
      "notice": "<p>1. The subscription amount is frozen in real time after the application is submitted and is deducted on the deadline date (the exact time is subject to the order status change). Subscription orders can only be canceled before the deadline. Regular subscription closes at 09:00 on the deadline date. Because the subscription procedures need to be processed, bank financed subscription ends 1 business day before the date announced by the exchange, usually at 16:00. Refer to the financed subscription page for details.</p><p>2. When a regular subscription amount exceeds the value of your HKD cash, currency borrowing financing is incurred, which in turn incurs interest. Keep an eye on your account assets.</p><p>3. IPOs are subject to the risk of delayed or canceled listing. In the event of a delay or cancellation, financing interest and subscription handling fees already charged are not refunded.</p><p>4. After the allotment results are announced, allotment information is updated in the subscription records or pushed as an in-app message. If you use financed subscription, keep an eye on your account funds. If the account margin is insufficient on the first day of listing, the allotted IPO shares may be force-liquidated.</p><p>5. For other questions about IPO subscription, see the <a href=\"https://support.longbridgeapp.com/topics/hk-trade/3gzpxjc\">Securities IPO Subscription Statement</a> and <a href=\"https://support.longbridge.hk/topics/hk-trade/1lii2n0\">IPO Subscription FAQ</a>, or contact customer service.</p>",
      "subscription_statement": ""
    },
    "pi_status": 1,
    "ai_status": 1,
    "certification": 0,
    "min_cash": "0.00",
    "declaration": {
      "zh_cn": "",
      "zh_hk": "",
      "en": ""
    },
    "has_trade_permission": true,
    "pi": 0,
    "ai": 0,
    "require_derivatives_knowledge": 0,
    "virtual_asset": 0,
    "group_item": {
      "0": {
        "items": [
          {
            "serial_number": 1,
            "apply_num_sub": "100",
            "payable": "3919.13",
            "currency": "HKD"
          },
          {
            "serial_number": 2,
            "apply_num_sub": "200",
            "payable": "7838.26",
            "currency": "HKD"
          },
          {
            "serial_number": 3,
            "apply_num_sub": "300",
            "payable": "11757.39",
            "currency": "HKD"
          }
        ]
      }
    },
    "vaetf_flag": false
  }
}