Skip to content
Longport WhaleLongport Whale
Subscription Summary

Subscription Summary

Queries Iposubscribe Summary 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_order_overviews

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.ipo_order_overview

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

Stock. Filters results by Stock.

subscription_methodstring

Subscription Method. Filters results by Subscription Method.

Multiple values are supported. Join them with commas (,). Omit the field to disable this filter.

1 · Margin2 · Cash4 · Placement5 · 0 Cost

marketstring

Market. Filters results by Market.

Allowed values: US, SG, HK, JP, TH, UK, CN, DE, AU, MY, CA, NZ, NA, US_OPTIONS

USSGHKJPTHUKCNDEAUMYCANZNAUS_OPTIONS

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 Iposubscribe Summary 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
namestring

Stock. Returned value: Stock.

counter_idstring

Stock Code. Returned value: Stock Code.

marketstring

Market. Returned value: Market.

subscription_methodstring

Subscription Method. Returned value: Subscription Method.

subscription_method_valstring

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

total_sub_qtystring

Total Sub Qty. Returned value: Total Sub Qty.

total_sub_amountstring

Total Sub Amount. Returned value: Total Sub Amount.

total_countstring

Total Count. Returned value: Total Count.

cash_amountstring

Cash Amount. Returned value: Cash Amount.

total_financing_amountstring

Total Financing Amount. Returned value: Total Financing Amount.

total_bank_amountstring

Total Bank Amount. Returned value: Total Bank Amount.

total_lb_amountstring

Total Amount. Returned value: Total Amount.

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