Skip to content
Corp Action Management

corporate announcement detail

Query the corporate announcement detail list.

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

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

Filters

Child attributes
idstring

ID

pageinteger

Page

page_sizeinteger

Page Size

Responses

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

List

Child attributes
ca_codestring

Announcement NO.

ann_typestring

Ann Type

ann_type_valstring

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

marketstring

Market

counter_typestring

Security Type

counter_type_valstring

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

is_scrip_feestring

Charge Scrip Fee

is_scrip_fee_valstring

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

in_side_election_tostring

Elect. Period To

origin_counter_idstring

Origin Counter ID

origin_counter_id_valstring

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

stage_statestring

CA Execution Status

stage_state_valstring

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

transfer_statestring

Transfer Status

transfer_state_valstring

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

notify_statestring

Client Mandate Collection Status

notify_state_valstring

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

record_datestring

Record Date

election_fromstring

Elect. Period From

election_tostring

Election To

payable_datestring

Payable Date

exterior_datestring

EX Date

effective_datestring

Payable Date (CCASS)

last_trading_datestring

Last Trading Date

created_atstring

Created At

created_bystring

Created By

is_optionalstring

Execution Type

is_optional_valstring

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

slave_ca_codestring

Copy From

master_slavestring

Master/Copied

termsstring

Terms

positionstring

Holding Position

position_valstring

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

stock_namestring

Stock Name

short_name_localesstring

Short Name Locales

is_app_optionalstring

Is App Optional

is_app_optional_valstring

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

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