Skip to content
Longport WhaleLongport Whale
Broker Trade

Broker Trade

Queries Upstream Trade Records 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/booking_va_upstream_executions

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_clearing.billing_va_contracts

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
exec_idstring

Execution No. Filters results by Execution No.

currencystring

Currency. Filters results by Currency.

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

mis_typestring

Mis Type. Filters results by Mis Type.

0 · Unmatched1 · Matched2 · Not Even

timestampobject

Trade Time. Filters results by Trade 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.

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 Upstream Trade Records 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
marketstring

Market. Returned value: Market.

trade_idstring

Broker Trade ID. Returned value: Broker Trade ID.

exec_idstring

Execution No. Returned value: Execution No.

sidestring

Direction. Returned value: Direction.

pricestring

Price. Returned value: Price.

quantitystring

Quantity. Returned value: Quantity.

amountstring

Amount. Returned value: Amount.

feestring

Fee. Returned value: Fee.

amount_unroundedstring

Settled Amount Unrounded. Returned value: Settled Amount Unrounded.

currencystring

Currency. Returned value: Currency.

trade_timestring

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

mis_typestring

Mis Type. Returned value: Mis Type.

mis_type_valstring

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

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