Skip to content
Longport WhaleLongport Whale
Internal Settlement

Clearing & Settlement - Internal-Account Settlement (List)

Query the master records of internal-ledger clearing tasks, used by operations to track how each market's internal accounting clearing was executed for a given ledger date.

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.

Business notes

The data records executions of internal-ledger (internal accounting) clearing tasks; each record corresponds to one clearing task initiated for a ledger date.

Every record carries the task id, ledger date (ledger_date), a summary of the markets involved and their counts (markets_summary), operator, operation source (source, such as day-end task), task status (status, such as completed), plus remarks holding each market's result and the update time.

It is commonly used to confirm whether daily internal-ledger clearing completed, distinguish automatic day-end runs from manual ones, and drill into per-market details to investigate anomalies.

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_clearings

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

filtersobject

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

Child attributes
ledger_dateobject

Filters results by Ledger Date.

Child attributes
gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

statusstring

Filters results by Task Status.

Allowed values: 1 Completed, 0 Processing, -1 Failed

Values
1
Completed
0
Processing
-1
Failed
sourcestring

Filters results by Source.

Allowed values: advance Advance Settlement, day_end_task Day-End Task

Values
advance
Advance Settlement
day_end_task
Day-End Task
pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Internal Settlement 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
idstring

Record ID. Returned value: Record ID (row primary key); write operations on this record take it as their id.

ledger_datestring

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

statusstring

Returned value: Task Status.

status_valstring

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

markets_summarystring

Returned value: Market Details.

operatorstring

Returned value: Operator.

sourcestring

Returned value: Source.

source_valstring

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

updated_atstring

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

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