Skip to content
Longport WhaleLongport Whale
OB Allotment Sync

OB order allotment result details

Returns the allotment-result detail of reported orders, used to reconcile the allotted quantity and final status of each reported order by upstream tenant and stock.

Request parameters

  • Combine business filters through filters (see the filter field notes below for the available fields), then use page, page_size, and orderBy for pagination and sorting.

Business notes

  • The data joins reported orders with IPO orders; each row includes the client account number, reported order number, IPO order number, reported subscription method, client financing ratio, subscription amount and quantity, order status, and allotted quantity.
  • Supports filtering by upstream tenant (ob_channel) and stock code (counter_id).
  • Commonly used after allotment-result sync to verify that each reported order's allotted quota matches its IPO order.

Returns

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

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

Authorization

AuthorizationstringheaderRequired

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

Permission

ipo.financing_rate

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

Request body application/json

filtersobject

Filters

Child attributes
ob_channelstring

OB Channel. not a fixed set.

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
account_nostring

A/C No.

ob_order_idstring

Order Id

order_idstring

IPO Order Id

sub_methodstring

Counterparty Subscription Method

sub_method_valstring

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

rratiostring

Client Financing Ratio

sub_amountstring

Subscription Amounts

sub_qtystring

Subscription Qty

order_statusstring

Status

order_status_valstring

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

lot_win_qtystring

Allotted Qty

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