Skip to content
Longport WhaleLongport Whale
OB Management

OB Account Query (back Office OB Related Page Query Use)

Query the list of OB (omnibus) accounts, used during day-end settlement to reconcile OB accounts and their account-opening details.

Request parameters

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

Business notes

Each record is a securities account whose client type is OB, carrying the client ID, securities account number, the owning OB parent account and its asset ID, the client and account names, account type, account state, account-opening state, and creation and update times.

  • member_id filters by client ID; when omitted the default scope is returned.
  • account_type filters by account type, with candidate values coming from the backend data dictionary.

Use it to locate a client's OB account and confirm its parent/child relationship and opening progress.

Returns

On success, returns the matching record list with pagination. See the response schema for column meanings.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

account.ob_accounts

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

Request body application/json

filtersobject
Child attributes
member_idstring

When omitted, defaults to filtering by '0' — without this filter the endpoint returns only data matching that value.

member_id is the customer ID. It differs from the securities account number account_no and the internal securities account ID aaid; one customer can have multiple securities accounts.

account_typestring

Filters results by Account type. Values come from a backend data dictionary.

Values
M
Margin
C
Cash
F
Futures
pageinteger
page_sizeinteger

Responses

HTTP 200Paginated list result.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required
Child attributes
member_idstring
account_nostring
parent_account_nostring
client_namestring
account_namestring
account_typestring
account_type_valstring

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

statestring
state_valstring

Raw value of state. The state field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

open_statestring
open_state_valstring

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

created_atstring
updated_atstring
totalintegerrequired
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