Skip to content
Longport WhaleLongport Whale
HK IPO

Get IPO Document

Retrieves the subscription display copy for a specified IPO security.

Request parameters

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

Business notes

When account_channels is provided, the copy is returned for the matching channels; otherwise the default copy is returned.

Returns

On success, returns the subscription copy for the security. See the response definition below for field meanings.

GEThttps://b-api.lbkrs.com/ipo/get-doc

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.

account_channelsstring

Responses

HTTP 200The request was processed successfully. data.result maps each account channel to its subscription document text (key is the channel, value is the localized text).
Standard response envelopecodemessagedata
dataobjectdata structure
resultobject

Document Map. Map from account channel to subscription document text; the key is the channel identifier.

Child attributes
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.

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