corporate stock events v2

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

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

Filters

Child attributes

ann_idstring

Ann ID

pageinteger

Page

page_sizeinteger

Page Size

Responses

HTTP 200Paginated list result.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

List

Child attributes

idstring

is_defaultstring

Is Default

is_default_valstring

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

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.

currencystring

Currency

exchange_ratestring

FX Rate

exchange_pricestring

Price

precisionstring

Min number of shares

origin_divide_payout_ratiostring

From Rate

new_divide_payout_ratiostring

To Rate

surplus_valuestring

Distribute Rate

is_fractional_stockstring

Fraction Distrib.

is_fractional_stock_valstring

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

executive_datestring

Executive Date (CCASS)

receive_counter_idstring

Distribution Stock

remarkstring

Remarks to Client

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

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "string",
        "is_default": "string",
        "is_default_val": "string",
        "event_type": "string",
        "event_type_val": "string",
        "currency": "string",
        "exchange_rate": "string",
        "exchange_price": "string",
        "precision": "string",
        "origin_divide_payout_ratio": "string",
        "new_divide_payout_ratio": "string",
        "surplus_value": "string",
        "is_fractional_stock": "string",
        "is_fractional_stock_val": "string",
        "executive_date": "string",
        "receive_counter_id": "string",
        "remark": "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_events/download

Export options Export records Download result