Skip to content
Longport WhaleLongport Whale
Batch Subscription

Batch subscription details

Queries the per-order details under a batch subscription, used to inspect each client's subscription within a batch order run.

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

  • Each record is a single client order in the batch, carrying the batch number, stock code, securities account, subscription method, subscription quantity, financing channel, financing ratio, subscription status, order ID, and remark.

  • Filter by account_no (client), method (subscription method), and status (subscription status) to locate specific orders.

  • Used for execution reconciliation and troubleshooting of batch subscriptions.

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_batch_order_details

Authorization

AuthorizationstringheaderRequired

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

Permission

ipo.batch_ipo_order

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

Request body application/json

filtersobject

Filters

Child attributes
account_nostring

A/C No.

methodstring

Subscription Method

Allowed values: 1 Margin financing, 2 Cash, 4 International placing, 5 Zero-cost IPO subscription

Values
1
2
4
5
statusstring

Status

Allowed values: 1 Processing, 2 Subscription succeeded, 3 Subscription failed

Values
1
2
3
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.

batch_nostring

Batch No.

counter_idstring

Counter Id

account_nostring

A/C No.

methodstring

Subscription Method

method_valstring

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

sub_qty_intstring

Quantity

channelstring

Financing Channel

ratiostring

Financing Ratio

statusstring

Status

status_valstring

Status (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.

order_idstring

Order Id

remarkstring

Remark

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