Skip to content
US IPO

Get IPO Timeline (Generic)

Returns the general IPO timeline (key subscription and listing milestones) for a specified security.

Request parameters

  • Required: counter_id (security ID)
  • Optional: market, account_channel, flag (subscription type)
  • See each field description for its format, value range, and business meaning.

Returns

On success, returns the IPO timeline milestones for the security. See the response definition below for field meanings.

GEThttps://b-api.lbkrs.com/ipo/timeline

Authorization

AuthorizationstringheaderRequired

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

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.

marketstring
account_channelstring
flaginteger

Specifies the subscription type.

Allowed values: 0 Ordinary subscription, 2 International placing

Responses

HTTP 200The request was processed successfully. data is the subscription timeline for the counter.
Standard response envelopecodemessagedata
dataobjectdata structure
timelinearray<object>

Timeline Nodes.

Child attributes
namestring

Name.

lightboolean

Light.

timestring

Time.

descstring

Description.

can_subscribeboolean

Can Subscribe.

pay_end_datestring

Pay End Date.

beginboolean

Begin.

tagsarray<string>

Tags.

issue_pricestring

Issue Price.

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