Skip to content
Longport WhaleLongport Whale
HK IPO

Get HK IPO Subscription Detail

Returns the subscription information detail for a specified Hong Kong IPO security.

Request parameters

  • Required: counter_id (security ID)
  • See each field description for its format, value range, and business meaning.

Returns

On success, returns the subscription configuration and display information for the security. See the response definition below for field meanings.

GEThttps://b-api.lbkrs.com/v2/ipo/subscription/detail

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Permission

ipo.subscription_manage

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Parameters

counter_idstringRequired

This field is required. Format is {type}/{market}/{code}, for example, stock ST/HK/700 or ST/US/AAPL, and option OP/US/AAPL270319C320000.

Responses

HTTP 200The request was processed successfully. data is the HK IPO subscription configuration for the counter.
Standard response envelopecodemessagedata
dataobjectdata structure
idinteger

ID.

counter_idstring

Counter ID.

can_subscribeinteger

Can Subscribe.

apply_start_datestring

Apply Start Date.

cash_end_datestring

Cash End Date.

margin_end_datestring

Margin End Date.

charge_datestring

Charge Date.

tagsobject

Tags.

Child attributes
zh_cnarray<string>

Simplified Chinese.

zh_hkarray<string>

Traditional Chinese.

enarray<string>

English.

subscription_methodobject

Subscription Method.

Child attributes
zh_cnstring

Simplified Chinese.

zh_hkstring

Traditional Chinese.

enstring

English.

buying_powerobject

Buying Power.

Child attributes
zh_cnstring

Simplified Chinese.

zh_hkstring

Traditional Chinese.

enstring

English.

financing_interestobject

Financing Interest.

Child attributes
zh_cnstring

Simplified Chinese.

zh_hkstring

Traditional Chinese.

enstring

English.

cut_off_timeobject

Cut-off Time.

Child attributes
zh_cnstring

Simplified Chinese.

zh_hkstring

Traditional Chinese.

enstring

English.

financing_estimateobject

Financing Estimate.

Child attributes
zh_cnstring

Simplified Chinese.

zh_hkstring

Traditional Chinese.

enstring

English.

noticeobject

Notice.

Child attributes
zh_cnstring

Simplified Chinese.

zh_hkstring

Traditional Chinese.

enstring

English.

user_group_idsarray<integer>

User Group IDs.

pi_certificationinteger

PI Certification.

rate_idinteger

Rate ID.

cash_channelstring

Cash Channel.

aiinteger

AI flag. Integer flag related to subscription eligibility; value meanings are defined by the backend.

piinteger

PI flag. Integer flag related to professional investors (PI); value meanings are defined by the backend.

require_derivatives_knowledgeinteger

Derivatives knowledge requirement. Integer flag for whether subscribers must have derivatives knowledge.

virtual_assetinteger

Virtual asset flag. Integer flag related to virtual assets; value meanings are defined by the backend.

declarationobject

Declaration. Declaration text as a multilingual object (same shape as the other text fields); null when not configured.

HTTP 400Bad request. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs