Clearing - Order Details

Query the clearing order details. Combine business filters through filters, and control pagination with page and page_size.

Response

On success, returns the matching list of records together with pagination information. See each field's documentation for the purpose, allowed values, and dynamic data source of every filter.

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

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.clear_account_balance_changeslb_hk_clearing.clear_equity_holding_change

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

Query parameters

filtersobject

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

Child attributes

ledger_datestring

Filters results by Ledger Date.

trade_datestring

Filters results by Trade Date.

aaidstring

Filters results by Client.

counter_idstring

Filters results by Counter ID.

order_idstring

Filters results by OMS Order ID.

op_entrust_waystring

Filters results by Order Channel.

0 · APP1 · BO2 · Fix3 · PRO4 · LONGPORT5 · OTHER6 · WTT7 · API8 · Other APP9 · WEB

manual_op_entrust_waystring

Filters results by Order Channel.

0 · APP1 · BO2 · Fix3 · PRO4 · LONGPORT5 · OTHER6 · WTT7 · API8 · Other APP9 · WEB

billedstring

Filters results by Billed.

! · YES= · NO

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Clear - order detail records together with pagination metadata such as the page number, page size, and total record count.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

Returned value: List of list.

Child attributes

ledger_datestring

Returned value: Ledger Date. The date or time format follows the value returned by the API.

trade_datestring

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

origin_idstring

Returned value: A/C No..

biz_typestring

Returned value: Biz Type.

biz_type_valstring

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

settlement_channelstring

Returned value: Settlement Channel.

settlement_channel_valstring

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

sub_position_nostring

Returned value: Sub Account/Broker No..

marketstring

Returned value: Market.

counter_idstring

Returned value: Counter ID.

order_idstring

Returned value: OMS Order ID.

directionstring

Returned value: Trade Direction.

direction_valstring

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

op_entrust_waystring

Returned value: Original Order Channel.

op_entrust_way_valstring

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

manual_op_entrust_waystring

Returned value: Order Channel.

manual_op_entrust_way_valstring

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

trade_quantitystring

Returned value: Trade Quantity.

trade_amountstring

Returned value: Trade Amount.

currencystring

Returned value: Currency.

makerstring

Returned value: Operator.

maker_valstring

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

updated_atstring

Returned value: Updated At. The date or time format follows the value returned by the API.

billedstring

Returned value: Billed.

billed_valstring

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

totalintegerrequired

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

Request

curl --get \
  --url 'https://b-api.longbridge.xyz/v1/datasets/clearing_ods_order_details' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "ledger_date": "string",
        "trade_date": "string",
        "origin_id": "string",
        "biz_type": "string",
        "biz_type_val": "string",
        "settlement_channel": "string",
        "settlement_channel_val": "string",
        "sub_position_no": "string",
        "market": "string",
        "counter_id": "string",
        "order_id": "string",
        "direction": "string",
        "direction_val": "string",
        "op_entrust_way": "string",
        "op_entrust_way_val": "string",
        "manual_op_entrust_way": "string",
        "manual_op_entrust_way_val": "string",
        "trade_quantity": "string",
        "trade_amount": "string",
        "currency": "string",
        "maker": "string",
        "maker_val": "string",
        "updated_at": "string",
        "billed": "string",
        "billed_val": "string"
      }
    ],
    "total": 0
  }
}