Skip to content
Longport WhaleLongport Whale
Settlement Batch

Settlement Batches

Query the settlement batch records. 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/booking_settlement_record_batches

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_settlement.batch_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
marketstring

Filters results by Market.

Allowed values: US, HK, UK, SH, SZ, SG, KR, JP, AU, DE, CA, TH, ID, MY, TR, NA, OSL, HAS, EU, UT, GTMMF

US · USHK · HKUK · UKSH · SHSZ · SZSG · SGKR · KRJP · JPAU · AUDE · DECA · CATH · THId · IDMY · MYTR · TRNA · NAOSL · OSLHAS · HASEU · EUUT · UTGTMMF · GTMMF

expected_settlement_dateobject

Filters results by Expected Settlement Date.

Child attributes
gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

statestring

Filters results by Status.

2 · DataPulled3 · DataLoaded4 · Calculated5 · To Be Settled6 · Settled10005 · Settling20005 · Settlement Failed (contact technical support)7 · Equity settled

nostring

Filters results by Settlement Batch No.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

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

nostring

Returned value: Settlement Batch No.

marketstring

Returned value: Market.

statestring

Returned value: Settlement Status.

state_valstring

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

expected_settlement_datestring

Returned value: Expected Settlement 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.

settled_atstring

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

expected_balance_settlement_datestring

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

expected_equity_settlement_datestring

Returned value: Expected Settlement Date(Qty). 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