Skip to content
Longport WhaleLongport Whale
OB Order Reporting Management

OB order summary

Query the summary list of OB orders.

GEThttps://b-api.longbridge.xyz/v1/datasets/ipo_ob_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.financing_rate

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

Query parameters

filtersobject

Filters

Child attributes
ob_channelstring

OB Channel

counter_idstring

Counter Id

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.

sub_methodstring

Subscription Method

sub_method_valstring

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.

ratiostring

Financing Ratio

cntstring

Total Subscription Order

amtstring

Total Subscription Amounts

qtystring

Total Subscription Qty

cashstring

Total Cash Deductible

balancestring

Account Bal

ipo_buy_limitstring

Account IPO Buy Limit

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