corporate stock register details drawer

Query the client roster under a corporate-action registration record, used to drill into corporate-action client details by client.

Request parameters

Combine business filters through filters (available fields are listed under the filters field docs), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

Data comes from corporate-action client registration records and can be filtered by client via aaid.

Each record is one client's registration entry, carrying the registration record ID, securities account (origin_id), and client name (real_name).

Typically used to locate a client's registration from the corporate-action client list before drilling into their chosen options or entitlement details.

Returns

On success, returns the matched record list with pagination info. See the response definitions for column meanings.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_corporate.corporate_query

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

Request body application/json

filtersobject

Filters

Child attributes

aaidstring

Client

Pass the internal numeric ID of the customer's securities account (aaid), not the securities account number account_no (such as H00000000) or the customer ID member_id. One customer can have multiple aaid values.

pageinteger

Page

page_sizeinteger

Page Size

Responses

HTTP 200Paginated list result.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

List

Child attributes

origin_idstring

A/C No.

real_namestring

Client Name

totalintegerrequired

Total

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/corp_action_stock_register_details_drawer' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "origin_id": "1000000001",
        "real_name": "张三"
      }
    ],
    "total": 1
  }
}

Export

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

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

lb_hk_corporate.corporate_query

Export options Export records Download result