Skip to content
Longport WhaleLongport Whale
International Placing

IPO placement order export templates

Returns the full details of Hong Kong international placement (placing) subscription orders, used to produce the placing list reported to underwriters.

Request parameters

  • 通过 filters 组合业务筛选条件（可选字段见下方 filters 字段说明），并使用 page、page_size、orderBy 控制分页与排序。

Business notes

The data comes from subscription orders placed through the international-placement method (subscription_method = 4); each row represents one customer's placing subscription.

Each record carries the subscription order number, order status, account, the customer's full Chinese and English names, account-opening date, security name and code, subscribed quantity, subscription source and time, customer channel, plus customer particulars such as ID number, mobile number, residential address, country, employer, and occupation.

Filter by customer (aaid) and order status (status); it is mainly used to export the customer and order information required for placement reporting.

Returns

成功时返回匹配的记录列表及分页信息。返回列含义见响应定义。

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

Authorization

AuthorizationstringheaderRequired

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

Permission

placement.manager

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

Request body application/json

filtersobject

Filters

Child attributes
aaidstring

Client

Pass the internal numeric ID of the customer's securities account (aaid), not the securities account number account_no (such as H00000000) or the customer ID member_id. One customer can have multiple aaid values.

statusstring

Status

Allowed values: 1 Pending deduction (funds frozen), 2 Deduction failed, 3 Deducted (awaiting allotment results), 4 Announced (allotted), 5 Announced (not allotted), 6 Revoked, 7 Canceled, 8 Rejected, 100

Values
1
2
3
4
5
6
7
8
100
pageinteger

Page

page_sizeinteger

Page Size

orderByarray<object>

Order By

Responses

HTTP 200Paginated list result.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

List

Child attributes
idstring

Order No.

statusstring

EnStatus

status_valstring

EnStatus (raw value). Raw value behind field status: status returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

origin_idstring

Account Number

member_en_namestring

Full Name (English)

member_real_namestring

Full Name (Chinese)

opened_atstring

OpenedAt

name_localesstring

Stock Name

counter_idstring

Stock Code

counter_id_valstring

Stock Code (raw value). Raw value behind field counter_id: counter_id returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

sub_qtystring

Subscription Quantity

refstring

Source

created_atstring

Subscription Time

card_idstring

ID Number

country_codestring

Telephone Code

contactstring

Telephone Number

addressstring

Residential Address

locationstring

Country

companystring

Employer

occupationstring

Occupation

totalintegerrequired

Total

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