Skip to content
Longport WhaleLongport Whale
HK IPO

Share List

Queries the subscription share-tier and payable-amount configuration for HK IPOs, used to maintain the fee and group assignment for each subscription quantity tier.

Request parameters

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

Business notes

  • The data is a payable-amount tier table for a stock, sorted by subscription shares ascending.

  • Each record carries the subscription share count, its payable amount, and the group it belongs to (Group A, Group B, etc.).

  • Filter by stock with counter_id to verify that the per-tier amounts and group assignments for that stock are correct.

Returns

On success, returns the matched records with pagination metadata. See the response definition for the meaning of each returned column.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

ipo.subscription_manage

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

Request body application/json

filtersobject

Filters

Child attributes
counter_idstring

Counter ID. Format is {type}/{market}/{code}, for example, stock ST/HK/700 or ST/US/AAPL, and option OP/US/AAPL270319C320000.

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

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

apply_num_substring

Shares

payablestring

Amount

group_idstring

Group

group_id_valstring

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

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