Skip to content
Internal Settlement

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

Query the per-market detail sub-table of internal-account settlement. 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_advance_market_clearing_detail

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

clearing_internal_settlement.query

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
log_idstringrequired

Filters results by Log ID.

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