Skip to content
Longport WhaleLongport Whale
Index Haircut Management

Add Index Haircut

Add Index Haircut.

Request parameters

  • Required: counter_id (Counter ID), haircut (Haircut)
  • Optional: include_indexes (Include Indexes), exclude_indexes (Exclude Indexes), include_exchanges (Include Exchanges), exclude_exchanges (Exclude Exchanges), priority (Priority)
  • See each field for its format, allowed values, and business meaning.

Result

On success, the endpoint completes the operation. See the 200 response schema for returned data and subsequent state information.

POSThttps://b-api.lbkrs.com/report/haircut/create_index_haircut

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

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

Request body application/json

counter_idstringrequired

Counter ID. Counter ID associated with this request.

haircutstringrequired

Haircut. Value range from 0 (exclusive) to 1.

include_indexesarray<string>

Include Indexes. Submit Include Indexes as a JSON array.

exclude_indexesarray<string>

Exclude Indexes. Submit Exclude Indexes as a JSON array.

include_exchangesarray<string>

Include Exchanges. Refer to haircut_exchange_list for the enum.

NASD · NASDAQ

exclude_exchangesarray<string>

Exclude Exchanges. Submit Exclude Exchanges as a JSON array.

prioritynumber

Priority. Processing priority. Interpret the value and sort order according to the allowed-value definitions.

Responses

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

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