Skip to content
Longport WhaleLongport Whale
US IPO

US IPO

Queries the list of US IPO securities and their subscription schedule, used to maintain the display and subscription windows of US new-share offerings.

Request parameters

Combine business filters through filters (see the filter field descriptions below), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

The data comes from the US IPO securities catalog; each record represents one US new-share offering.

Each record carries the security code, security name, IPO date, subscription start and cut-off times, allotment-announcement time, subscription status, tenant IPO date, and display order.

It is typically used to maintain US IPO subscription windows and display info, narrowable to a single security with counter_id.

Returns

On success, returns the matched record list with pagination info. See the response definition for column meanings.

POSThttps://b-api.lbkrs.com/v1/datasets/ipo_us_securities

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_ipo.gemini_ipo_us_subscription_query

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

Request body application/json

filtersobject

Filters. Combines business filters. Omit a filter field to disable that filter.

Child attributes
counter_idstring

Securities Code. Filters results by Securities Code. Format is {type}/{market}/{code}, for example, stock ST/HK/700 or ST/US/AAPL, and option OP/US/AAPL270319C320000.

pageinteger

Page. Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

orderByarray<object>

Order By. Array of sorting rules. Each item defines a sort field and direction.

Responses

HTTP 200On success, returns paginated US IPO List records together with pagination metadata such as the page number, page size, and total record count.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

List. Returned value: List of list.

Child attributes
idstring

Record ID. Returned value: Record ID (row primary key); write operations on this record take it as their id.

counter_idstring

Counter Id. Returned value: Counter Id.

counter_id_valstring

Counter Id (raw value). Raw value of counter_id. The counter_id field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

ipo_datestring

IPO Date. Returned value: IPO Date. The date or time format follows the value returned by the API.

name_localesstring

Securities Name. Returned value: Securities Name.

start_datestring

Subscription Starting Time. Returned value: Subscription Starting Time. The date or time format follows the value returned by the API.

cash_end_datestring

Subscription Closing Time. Returned value: Subscription Closing Time. The date or time format follows the value returned by the API.

result_datestring

Allotment Time. Returned value: Allotment Time. The date or time format follows the value returned by the API.

can_subscribestring

Status. Returned value: Indicates whether status.

can_subscribe_valstring

Status (raw value). Raw value of can_subscribe. The can_subscribe field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

totalintegerrequired

Total. Returned value: Total number of matching records, used for pagination.

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