corporate ann timeline

Queries the stage-progress timeline of a single corporate-action announcement, showing how far it has advanced through each processing stage.

Request parameters

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

Business notes

Records are returned by announcement ann_id and cover the progress nodes across the registration, mandate-collection, execution, and completion stages.

Each record carries the stage identifier, whether it is the current active stage, the operation time of that stage, and the execution details.

Use it to see at a glance how a corporate action is progressing.

Returns

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

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

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

idstring

pageinteger

Page

page_sizeinteger

Page Size

Responses

HTTP 200Paginated list result.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

List

Child attributes

stagestring

Stage

stage_valstring

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

current_stage_statestring

Current Stage State

operated_atstring

Operated At

exec_detailsstring

Exec Details

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

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "stage": "1",
        "stage_val": "1",
        "current_stage_state": "1",
        "operated_at": "1789713827",
        "exec_details": "string"
      }
    ],
    "total": 1
  }
}

Export

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

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

lb_hk_corporate.corporate_query

Export options Export records Download result