Clear Instruction Settings

Query the settlement-instruction configuration.

Request parameters

Combine business filter conditions through filters (see the filter-field descriptions below), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

Maintains market-level settlement rules — market, settlement channel, trade stage, account type, business type, buy/sell direction, long/short, instruction type, settlement method, default custodian and sub-position; used to configure the default settlement-instruction generation rules.

Returns

On success, returns the matching record list with pagination information. See the response schema for the meaning of each returned column.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.clearing_instruction_settings

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

Request body application/json

filtersobject

Child attributes

marketstring

Values come from the clear_markets dynamic enumeration; not a fixed set.; queryable via GET /v1/datasets/refs/clearing_markets_all

biz_typestring

Filters results by Business type. Values come from a backend data dictionary.

Allowed values: ! All, 1 Stock, 5 Options

Values

!: All
1: Stock
5: Options

pageinteger

page_sizeinteger

Responses

HTTP 200Paginated list result.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

Child attributes

idstring

Record ID. Returned value: Record ID (row primary key); write operations on this record take it as their id.

marketstring

Market. Returned value: Market (display value; the raw code is in the matching _val field); ! means all.

market_valstring

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.

settlement_channelstring

Settlement channel. Returned value: Settlement channel (display value; the raw code is in the matching _val field); ! means all.

settlement_channel_valstring

Raw value of settlement_channel. The settlement_channel field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

stagestring

Trade stage. Returned value: Trade stage (display value; the raw code is in the matching _val field); ! means all.

stage_valstring

Raw value of stage. The stage field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

account_typestring

Account type. Returned value: Account type (display value; the raw code is in the matching _val field); ! means all.

account_type_valstring

Raw value of account_type. The account_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

biz_typestring

Business type. Returned value: Business type (display value; the raw code is in the matching _val field); ! means all.

biz_type_valstring

Raw value of biz_type. The biz_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

directionstring

Direction. Returned value: Trade direction (display value; the raw code is in the matching _val field).

direction_valstring

Raw value of direction. The direction field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

positionstring

Position side. Returned value: Long/short position side; may be an empty string.

position_valstring

Raw value of position. The position field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

instr_typestring

Instruction type. Returned value: Settlement instruction type (display value; the raw code is in the matching _val field).

instr_type_valstring

Raw value of instr_type. The instr_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

settle_methodstring

Settle method. Returned value: Settlement method (display value; the raw code is in the matching _val field).

settle_method_valstring

Raw value of settle_method. The settle_method field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

custodian_idstring

Default custodian. Returned value: Default custodian (display value; the raw code is in the matching _val field).

custodian_id_valstring

Raw value of custodian_id. The custodian_id field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

sub_position_nostring

Default sub account. Returned value: Default sub-position number.

updated_atstring

Updated at. Returned value: Unix timestamp in seconds, returned as a string.

updated_bystring

Updated by. Returned value: Back-office account that last updated the record.

totalintegerrequired

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 --request POST \
  --url 'https://b-api.lbkrs.com/v1/datasets/clearing_instruction_settings' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "123",
        "market": "US",
        "market_val": "US",
        "settlement_channel": "lb",
        "settlement_channel_val": "lb",
        "stage": "1",
        "stage_val": "1",
        "account_type": "1",
        "account_type_val": "1",
        "biz_type": "1",
        "biz_type_val": "1",
        "direction": "1",
        "direction_val": "1",
        "position": "1",
        "position_val": "1",
        "instr_type": "1",
        "instr_type_val": "1",
        "settle_method": "1",
        "settle_method_val": "1",
        "custodian_id": "1000000001",
        "custodian_id_val": "长桥证券",
        "sub_position_no": "SN20250101000001",
        "updated_at": "1789713827",
        "updated_by": "张三"
      }
    ],
    "total": 1
  }
}

Export

The export endpoint uses the same filters as this Dataset query.

POSThttps://b-api.lbkrs.com/v1/datasets/clearing_instruction_settings/download

lb_hk_clearing.clearing_instruction_settings

Export options Export records Download result