Skip to content
Longport WhaleLongport Whale
Custom Data

Custom Data Preview

Query the preview list of imported custom stress-test data batches, used to get an overview of each batch of custom scenario data.

Request parameters

  • Combine business filters through filters (see the filter field notes below) and use page, page_size, and orderBy for pagination and sorting.

Business notes

  • Each record represents one imported batch of custom scenario data, identified by the batch number task_id.
  • A record carries the batch title (remark), the number of rows it contains, the importing operator, and the creation time.
  • Use it to quickly locate and verify a batch before drilling into its detail, then query the per-stock rows by batch number.

Returns

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

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

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_margin_call.risk_monitoring_simulation_list_query

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

Request body application/json

filtersobject

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

Child attributes
task_idstring

Task Id. Filters results by Task Id.

remarkstring

Title. Filters results by Title.

pageinteger

Page. Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

orderByarray<object>

Order By. Array of sorting rules. Each item defines a sort field and direction.

Responses

HTTP 200On success, returns paginated Simulate_file records together with pagination metadata such as the page number, page size, and total record count.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

List. Returned value: Records matching the query conditions.

Child attributes
task_idstring

ID. Returned value: ID.

remarkstring

Title. Returned value: Title.

countstring

Stock Count. Returned value: Stock Count.

operatorstring

Operator. Returned value: Operator.

created_atstring

Created At. Returned value: Created At. The date or time format follows the value returned by the API.

totalintegerrequired

Total. 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