Skip to content
Longport WhaleLongport Whale
Day-End Tasks

Before Clearing Check

Runs the before-clearing check step of the day-end process.

Request parameters

  • Required: ledger_date (Ledger Date), step_id (Step ID), step_no (Step No.)
  • Optional: market (Market)
  • See each field for its format, allowed values, and business meaning.

Result

On success, the corresponding step is triggered. See the 200 response schema for returned data and subsequent state information.

POSThttps://b-api.lbkrs.com/clearing/before_clearing_check

Production: https://b-api.lbkrs.com · Test: https://b-api.longbridge.xyz

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.clearing_busin_step_exec

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

Request body application/json

ledger_datenumberrequired

Ledger date for this day-end step, in YYYYMMDD format. This field is required.

marketstring

Market handled by this step, for example HK or US.

step_idintegerrequired

Day-end step ID identifying the step being executed. This field is required.

step_nointegerrequired

Day-end step sequence number. This field is required.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure

On success data is an empty object.

No nested fields

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