Index Haircut Management

Queries Index 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/risk_index_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_indexes

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

namestring

Rule Name. Filters results by Rule Name.

include_indexesstring

Inclusion Index. Filters results by Inclusion Index.

exclude_indexesstring

Exclusion Index. Filters results by Exclusion Index.

include_exchangesstring

Inclusion Exchange. Filters results by Inclusion Exchange.

NASD · NASDAQ

exclude_exchangesstring

Exclusion Exchange. Filters results by Exclusion Exchange.

NASD · NASDAQ

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 Index 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

namestring

Rule Name. Returned value: Rule Name.

security_typestring

Security Type. Returned value: Security Type.

security_type_valstring

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

marketstring

Market. Returned value: Market.

market_valstring

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

include_indexesstring

Include Indexes. Returned value: Include Indexes.

exclude_indexesstring

Exclude Indexes. Returned value: Exclude Indexes.

include_exchangesstring

Include Exchanges. Returned value: Include Exchanges.

exclude_exchangesstring

Exclude Exchanges. Returned value: Exclude Exchanges.

haircutstring

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

last_update_userstring

Last Update User. Returned value: Last Update User.

created_atstring

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

updated_atstring

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

Request

curl --get \
  --url 'https://b-api.longbridge.xyz/v1/datasets/risk_index_haircut_configs' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20' \
  --data-urlencode 'orderBy=[]'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "name": "Stock Test",
        "security_type": "Stock",
        "security_type_val": "Stock",
        "market": "US",
        "market_val": "US",
        "include_indexes": "{IX/SH/000011}",
        "exclude_indexes": "{}",
        "include_exchanges": "{NASD}",
        "exclude_exchanges": "{}",
        "haircut": "25.00",
        "last_update_user": "user@example.com",
        "created_at": "1784147141",
        "updated_at": "1784147141"
      }
    ],
    "total": 41
  }
}