Skip to content
Longport WhaleLongport Whale
Internal Settlement

Clearing & Settlement - Internal-Account Settlement (Market Detail Sub-table)

Query the per-market breakdown of a single internal-ledger clearing task, used to drill into that clearing run and check each market's processing status and reversal.

Request parameters

  • Combine business filters through filters (optional fields are listed under the filters field notes below), and use page, page_size, and orderBy to control pagination and sorting.
  • filters is required and must include log_id.

Business notes

The data is a per-market detail subtable for one internal-ledger clearing task (located by the master record's log_id); each record corresponds to one market under that task.

Every record carries the market (market), market-local settlement date (settlement_date), market processing status (market_status), whether it was reverted (reverted), and additional info (additional_info, including error details).

It is commonly used to drill down from an internal-ledger clearing master record to confirm, market by market, whether clearing succeeded or was reverted, and to view the additional notes for a failed market.

Returns

On success, returns the list of matching records with pagination. See the response definition for column meanings.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

clearing_internal_settlement.query

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

Request body application/json

filtersobjectrequired

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

Child attributes
log_idstringrequired

Filters results by Log ID. Required.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Clearing Settlement - Internal Ledger (Market Detail Subtable) 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
marketstring

Returned value: Market.

settlement_datestring

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

market_statusstring

Returned value: Market Status.

market_status_valstring

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

revertedstring

Returned value: Cancelled.

reverted_valstring

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

additional_infostring

Returned value: Additional Info.

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

Whale Docs