Skip to content
Longport WhaleLongport Whale
Stock Haircut Management

Stock Haircut Management

Queries Stock Haircut List data. Combine business filters in filters, and use page, page_size, and orderBy to control pagination and sorting.

Response

On success, the API returns the matching records and pagination metadata. See each filter field for its purpose, allowed values, and dynamic value source.

GEThttps://b-api.longbridge.xyz/v1/datasets/instrument_stock_haircut_configs

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_report.haircut_securities

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

Query parameters

filtersobject

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

Child attributes
counter_idstring

Product ID. Filters results by Product ID.

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 Stock Haircut List 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: List of list.

Child attributes
sourcestring

Source. Returned value: Source.

source_valstring

Source (raw value). 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.

counter_idstring

Product ID. Returned value: Product ID.

counter_name_localesstring

Product Name. Returned value: Product Name.

counter_name_locales_valstring

Product Name (raw value). Raw value of counter_name_locales. The counter_name_locales field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

haircutstring

1 - Haircut (%). Returned value: 1 - Haircut (%).

rule_namestring

Source Rule. Returned value: Source Rule.

last_update_userstring

Last Update User. Returned value: Last Update User.

haircut_created_atstring

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

updated_atstring

Haircut Sync At. Returned value: Haircut Sync 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