Subscription Summary

Query the IPO subscription summary, which aggregates IPO subscription orders by stock, market, and subscription method to show the overall subscription scale and financing composition of each security.

Request parameters

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

Business notes

Data is drawn from IPO subscription orders, grouped by stock, market, and subscription method, counting only orders in valid states.
Each record carries the stock and its code, market, and subscription method, plus total shares, subscription amount, and subscription order count.
Amounts are further split into the cash portion, total financing amount, and within financing the channel-funded amount and the broker-advanced amount, making it easy to reconcile funds against financing sources.

Returns

On success, returns the matching records with pagination info. See the response definition for column meanings.

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

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

Request body application/json

filtersobject

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

Child attributes

counter_idstring

Stock. Filters results by Stock. Format is {type}/{market}/{code}, for example, stock ST/HK/700 or ST/US/AAPL, and option OP/US/AAPL270319C320000.

subscription_methodstring

Subscription Method. Filters results by Subscription Method.

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

Allowed values: 1 Margin, 2 Cash, 4 Placement, 5 0 Cost

Values

1: Margin
2: Cash
4: Placement
5: 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

Values

US
SG
HK
JP
TH
UK
CN
DE
AU
MY
CA
NZ
NA
US_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

Request

curl --request POST \
  --url 'https://b-api.lbkrs.com/v1/datasets/ipo_order_overviews' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20,
  "orderBy": []
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "name": "鼎泰高科",
        "counter_id": "ST/HK/1377",
        "market": "HK",
        "subscription_method": "Cash",
        "subscription_method_val": "2",
        "total_sub_qty": "900",
        "total_sub_amount": "345,449.07",
        "total_count": "6",
        "cash_amount": "345,449.07",
        "total_financing_amount": "0",
        "total_bank_amount": "",
        "total_lb_amount": ""
      }
    ],
    "total": 360
  }
}