Skip to content
Fundamentals

Get IPO Prospectus

Queries the prospectus information of the specified IPO. Depending on the market, either the HK stocks (hk) or the US stocks (us) data set is returned. HK data includes the company profile, offer price and offer price range, shares per board lot, prospectus, industry, use of proceeds, sponsors, underwriters, cornerstone investors, grey market time and more. US data includes the company profile, offer price, minimum subscription quantity, expected offering size, fundraising amount, prospectus, industry, underwriters and more. Used for the "Offering" tab of the IPO prospectus page and for the intermediaries and use of proceeds detail pages.

GEThttps://api.lbkrs.com/v1/stock-info/ipo-profile

Parameters

counter_idstringqueryRequired

IPO security id, for example ST/HK/1256 or ST/US/LTGO. If omitted, no error is returned, but both hk and us are null

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get IPO prospectus” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
hkobject

Prospectus information of an HK IPO. null if the IPO is not an HK IPO

Child attributes
ipo_dateinteger

Listing time, Unix timestamp (in seconds)

issue_pricestring

Offer price (display string; may be price range text before pricing)

issue_currencystring

Currency of the offer price, for example HKD

show_martboolean

Whether grey market trading is available

mart_begininteger

Grey market start time, Unix timestamp (in seconds). 0 if there is no grey market

mart_endinteger

Grey market end time, Unix timestamp (in seconds). 0 if there is no grey market

recommend_urlstring

Link to the IPO research report (PDF)

trade_unitinteger

Shares per board lot

prospectusstring

Link to the prospectus (PDF). An empty string when no data is available

rec_purposesstring

Full text of the use of proceeds. May contain newlines

sponsorarray<string>

List of sponsors

underwriterarray<string>

List of underwriters

share_plannedstring

Planned number of shares offered. An empty string when no data is available

sub_applystring

Number of public offering subscription applications. An empty string when no data is available

sub_multiplestring

Public offering subscription multiple. An empty string when no data is available

investorsarray<object>

List of cornerstone investors

Child attributes
namestring

Cornerstone investor name

subscribe_valuestring

Subscription amount

capital_ratiostring

Subscription proportion as a percentage value (for example, 14.43 means 14.43%)

proceeds_plannedstring

Planned fundraising amount. An empty string when no data is available

margin_substring

Margin (financed) subscription amount. An empty string when no data is available

margin_multiplestring

Margin (financed) subscription multiple. An empty string when no data is available

tagsarray<string>

IPO tags

profilestring

Company profile

industrystring

Industry name

counter_idstring

Security id. May be an empty string

offer_price_minstring

Lower bound of the offer price range as a raw decimal string. An empty string when missing

offer_price_maxstring

Upper bound of the offer price range as a raw decimal string. An empty string when missing

offer_pricestring

Final offer price as a raw decimal string. An empty string before pricing. Unlike this field, issue_price is the composed display text

usobject

Prospectus information of a US IPO. null if the IPO is not a US IPO

Child attributes
namestring

IPO name

profilestring

Company profile. An empty string when no data is available

issue_pricestring

Offer price (display string). A price range before pricing, for example "40.000 ~ 44.000"

min_sub_numinteger

Minimum subscription quantity (shares). Broker App does not display it when can_subscribe is 0

total_sharesstring

Expected offering size with the unit M (million shares), for example "0M"

prospectusstring

Link to the prospectus. An empty string when no data is available

industrystring

Industry name. An empty string when no data is available

agentstring

Underwriters. An empty string when no data is available

ipo_dateinteger

Listing time, Unix timestamp (in seconds)

shares_valuestring

Fundraising amount with the unit M (million). A range before pricing, for example "0M ~ 0M"

issue_currencystring

Currency of the offer price, for example USD

can_subscribeinteger

Whether subscription is available:

  • 0: Not available for subscription
  • 1: Available for subscription
Values
0
1
offer_price_minstring

Lower bound of the offer price range as a raw decimal string. An empty string when missing

offer_price_maxstring

Upper bound of the offer price range as a raw decimal string. An empty string when missing

offer_pricestring

Final offer price as a raw decimal string. An empty string before pricing

Whale Docs