Skip to content
Longport WhaleLongport Whale
Subscription Records

File download summary

Queries a grouped order-count summary of a stock's valid subscription orders, used to batch-generate subscription order files by subscription method, channel, and financing ratio.

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 counts the stock's valid subscription orders (in-flight states) grouped by subscription method, origin channel, and financing ratio.

  • Each record carries the subscription-method type, channel, financing ratio, and the order count for that group.

  • Users pick target groups from this summary to batch-generate or download the corresponding subscription order files.

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_file_summaries

Authorization

AuthorizationstringheaderRequired

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

Permission

ipo.order_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
subscription_methodstring

Type

subscription_method_valstring

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

origin_channelstring

Channel

ratiostring

Financing Ratio

cntstring

Count

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