corporate stock register events

POSThttps://b-api.longbridge.xyz/v1/datasets/corp_action_stock_register_events

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

Filters

Child attributes

ann_idstring

Ann ID

register_idstring

pageinteger

Page

page_sizeinteger

Page Size

Responses

HTTP 200Paginated list result.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

List

Child attributes

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

Request

curl --request POST \
  --url 'https://b-api.longbridge.xyz/v1/datasets/corp_action_stock_register_events' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "event_id": "string",
        "event_type": "string",
        "event_type_val": "string",
        "remark": "string",
        "choices_quantity": "string"
      }
    ],
    "total": 1
  }
}

Export

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

POSThttps://b-api.longbridge.xyz/v1/datasets/corp_action_stock_register_events/download

Export options Export records Download result