Query custodian sub-position management

Query the custodian sub-position 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 the sub-positions under each custodian — custodian id/name, sub-position number, name, feature and mapping; used to group holdings and locate a sub-position during settlement.

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_sub_positions

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.clearing_sub_positions

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

Request body application/json

filtersobject

Child attributes

custodian_idstring

Filters results by Custodian ID.

custodian_namestring

Filters results by Custodian name.

nostring

Filters results by Sub-position number.

namestring

Filters results by Sub-position name.

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.

nostring

Sub account. Returned value: Sub-position number.

namestring

Sub account name. Returned value: Sub-position name.

position_directionstring

Features. Returned value: Sub-position feature (display value; the raw code is in the matching _val field).

position_direction_valstring

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

remarkstring

Remark. Returned value: Remark; may be an empty string.

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_sub_positions' \
  --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",
        "no": "1",
        "name": "张三",
        "position_direction": "1",
        "position_direction_val": "1",
        "remark": "审核通过",
        "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_sub_positions/download

lb_hk_clearing.clearing_sub_positions

Export options Export records Download result