Skip to content
Longport WhaleLongport Whale
HK IPO

Get IPO Document

Get IPO Document.

Request parameters

  • Required: counter_id (Counter ID)
  • Optional: account_channels (Account Channels)
  • See each field for its format, allowed values, and business meaning.

Result

Returns the query result; see the 200 response schema for the fields.

GEThttps://b-api.longbridge.xyz/ipo/get-doc

Authorization

Authorizationstringheaderipo.subscription_manageRequired

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

Parameters

counter_idstringRequired

Specifies Counter ID. This field is required.

account_channelsstring

Specifies Account Channels.

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. Specifies Subscription Method.

Child attributes
zh_cnstring

Simplified Chinese. Specifies Simplified Chinese.

zh_hkstring

Traditional Chinese. Specifies Traditional Chinese.

enstring

English. Specifies English.

buying_powerobject

Buying Power. Specifies Buying Power.

Child attributes
zh_cnstring

Simplified Chinese. Specifies Simplified Chinese.

zh_hkstring

Traditional Chinese. Specifies Traditional Chinese.

enstring

English. Specifies English.

financing_interestobject

Financing Interest. Specifies Financing Interest.

Child attributes
zh_cnstring

Simplified Chinese. Specifies Simplified Chinese.

zh_hkstring

Traditional Chinese. Specifies Traditional Chinese.

enstring

English. Specifies English.

cut_off_timeobject

Cut-off Time. Specifies Cut-off Time.

Child attributes
zh_cnstring

Simplified Chinese. Specifies Simplified Chinese.

zh_hkstring

Traditional Chinese. Specifies Traditional Chinese.

enstring

English. Specifies English.

financing_estimateobject

Financing Estimate. Specifies Financing Estimate.

Child attributes
zh_cnstring

Simplified Chinese. Specifies Simplified Chinese.

zh_hkstring

Traditional Chinese. Specifies Traditional Chinese.

enstring

English. Specifies English.

noticeobject

Notice. Specifies Notice.

Child attributes
zh_cnstring

Simplified Chinese. Specifies Simplified Chinese.

zh_hkstring

Traditional Chinese. Specifies Traditional Chinese.

enstring

English. Specifies 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