Skip to content
Longport WhaleLongport Whale
Batch Subscription

Batch Subscription Records

Queries Batch Subscription Records data. Combine business filters in filters, and use page, page_size, and orderBy to control pagination and sorting.

Response

On success, the API returns the matching records and pagination metadata. See each filter field for its purpose, allowed values, and dynamic value source.

GEThttps://b-api.longbridge.xyz/v1/datasets/ipo_batch_order_summaries

Dataset endpoints are available on the Test host only (https://b-api.longbridge.xyz); the Production host returns 404.

This Dataset query is read-only. Use GET by default. If the encoded query parameters are too large, send the same parameters as a JSON body with POST to the same path.

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 below, or the call will be rejected.

Query parameters

filtersobject

Filters. Combines business filters. Omit a filter field to disable that filter.

Child attributes
counter_idstring

Counter Id. Filters results by Counter Id.

batch_nostring

Batch No.. Filters results by Batch No..

pageinteger

Page. Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

orderByarray<object>

Order By. Array of sorting rules. Each item defines a sort field and direction.

Responses

HTTP 200On success, returns paginated Batch Subscription Records records together with pagination metadata such as the page number, page size, and total record count.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

List. Returned value: List of list.

Child attributes
batch_nostring

Batch No.. Returned value: Batch No..

counter_idstring

Counter Id. Returned value: Counter Id.

method1string

Subscription Method. Returned value: Subscription Method.

method1_valstring

Subscription Method (raw value). Raw value of method1. The method1 field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

amtstring

Order Request Volume. Returned value: Order Request Volume.

processing_cntstring

Processing. Returned value: Processing.

success_cntstring

Subscription Successful. Returned value: Subscription Successful.

fail_cntstring

Subscription Failed. Returned value: Subscription Failed.

operatorstring

Operator. Returned value: Operator.

operator_valstring

Operator (raw value). Raw value of operator. The operator field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

created_atstring

Submission Time. Returned value: Submission Time. The date or time format follows the value returned by the API.

totalintegerrequired

Total. Returned value: Total number of matching records, used for pagination.

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