Skip to content
Longport WhaleLongport Whale
OB Management

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

Query the OB Account Query (back Office OB Related Page Query Use) list.

GEThttps://b-api.longbridge.xyz/v1/datasets/ipo_ob_account_query

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

account.ob_accounts

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

Query parameters

filtersobject
Child attributes
member_idstring

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

account_typestring

M · MarginC · CashF · 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