Skip to content
Longport WhaleLongport Whale
Client Order

Funds private client orders

Queries Funds private client orders data. Combine business filters in filters, and use page, page_size, and orderBy to control pagination and sorting.

Response

On success, the API returns the matching records and pagination metadata. See each filter field for its purpose, allowed values, and dynamic value source.

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

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

lb_hk_user_orders.user_orders_query

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

Query parameters

filtersobject

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

Child attributes
aaidstring

A/C No.. Filters results by A/C No..

actionstring

Trade Direction. Filters results by Trade Direction.

BUY · SubscriptionSELL · Redemption

confirm_atobject

Settlement Confirmation Time. Filters results by Settlement Confirmation Time.

Child attributes
gtestring

Greater Than or Equal. Inclusive lower bound of the filter range.

ltestring

Less Than or Equal. Inclusive upper bound of the filter range.

counter_idstring

Fund Code. Filters results by Fund Code.

Values are dynamic. Call GET /v1/datasets/refs/private_fund_counter_ids to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

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 Funds private client orders 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
idstring

Order No.. Returned value: Unique identifier of the current record.

real_namestring

Client Name. Returned value: Client Name.

aaidstring

A/C No.. Returned value: A/C No..

aaid_valstring

A/C No. (raw value). Raw value of aaid. The aaid field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

actionstring

Trade Direction. Returned value: Trade Direction.

action_valstring

Trade Direction (raw value). Raw value of action. The action field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

counter_idstring

Fund Code. Returned value: Fund Code.

fund_all_namestring

Fund Name. Returned value: Fund Name.

currencystring

Currency. Returned value: Currency.

statestring

Order Status. Returned value: Order Status.

state_valstring

Order Status (raw value). 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.

in_reasonstring

Reason. Returned value: Reason.

out_reasonstring

Remark. Returned value: Remark.

apply_amountstring

Subs. Submitted Amount. Returned value: Subs. Submitted Amount.

navstring

Confirmed Nav. Returned value: Confirmed Nav.

confirmed_sharesstring

Subs. Confirmed Shares. Returned value: Subs. Confirmed Shares.

apply_sharesstring

Redemp. Submitted Shares. Returned value: Redemp. Submitted Shares.

confirmed_amountstring

Actual Redemption Proceeds. Returned value: Actual Redemption Proceeds.

feestring

Fee. Returned value: Fee.

gststring

GST. Returned value: GST.

confirm_atstring

Settlement Confirmation Time. Returned value: Settlement Confirmation Time. The date or time format follows the value returned by the API.

created_atstring

Order Creation Time. Returned value: Order Creation Time. The date or time format follows the value returned by the API.

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

Whale Docs