Skip to content
Corp Action Management

corporate stock register events

Query the options a client can choose under a corporate action and the resulting exercise, typically drilled in by register_id.

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 links corporate-action options (events) with a client's registration detail, filterable by ann_id (announcement ID) and register_id.

Each record is one option, carrying the event ID (event_id), event type (event_type), option remark (remark), and the client's actual exercise quantity (choices_quantity).

Typically used to review the options a client faced in a corporate action and the quantity they ultimately elected or exercised.

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_events

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
ann_idstring

Ann ID

register_idstring

Register ID

pageinteger

Page

page_sizeinteger

Page Size

Responses

HTTP 200Paginated list result.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

List

Child attributes
idstring

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

event_idstring

Event ID

event_typestring

Event Type

event_type_valstring

Raw value behind field event_type: event_type returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

remarkstring

Remarks

choices_quantitystring

Exercise Quantity

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

Whale Docs