corporate announcements

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

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

Combines business filters. Omit a filter field to disable that filter.

Child attributes

origin_counter_idstring

Filters results by Origin Counter Id.

ca_codestring

Filters results by Announcement NO..

ann_typestring

Filters results by Ann Type.

Multiple values are supported. Join them with commas (,). Omit the field to disable this filter.

Allowed values:

3 - TM (Take-Over (Compulsory) / Auto-Exercise of Structured Products)
4 - BE (Benefit Entitlement)
5 - CA (Split,Reverse Split,Symbol Change)
6 - DS (Delisted, Expired, Lapsed)
7 - OO (Open Offer)
8 - EO (Excess Open Offer)
9 - RS (Rights Subscription)
10 - ER (Excess Rights Subscription)
11 - TU (Take-Over (Unconditional))
12 - TC (Take-Over (Conditional))
13 - ADR (ADR Fee)
14 - SO (Spin Off)
15 - IP (Interest Payment)
16 - VT(Voting)

3 · TM (Take-Over (Compulsory) / Auto-Exercise of Structured Products)4 · BE (Benefit Entitlement)5 · CA (Split,Reverse Split,Symbol Change)6 · DS (Delisted, Expired, Lapsed)7 · OO (Open Offer)8 · EO (Excess Open Offer)9 · RS (Rights Subscription)10 · ER (Excess Rights Subscription)11 · TU (Take-Over (Unconditional))12 · TC (Take-Over (Conditional))13 · ADR (ADR Fee)14 · SO (Spin Off)15 · IP (Interest Payment)16 · VT(Voting)

marketstring

Filters results by Market.

Multiple values are supported. Join them with commas (,). Omit the field to disable this filter.

Allowed values: US, HK, UK, SH, SZ, SG, KR, JP, AU, DE, CA, TH, ID, MY, TR, NA, OSL, HAS, EU, UT, GTMMF

US · USHK · HKUK · UKSH · SHSZ · SZSG · SGKR · KRJP · JPAU · AUDE · DECA · CATH · THID · IDMY · MYTR · TRNA · NAOSL · OSLHAS · HASEU · EUUT · UTGTMMF · GTMMF

payable_dateobject

Filters results by Payable Date.

Child attributes

gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

record_dateobject

Filters results by Record Date.

Child attributes

gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

election_fromobject

Filters results by Elect. Period From.

Child attributes

gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

in_side_election_toobject

Filters results by Elect. Period To.

Child attributes

gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

stage_statestring

Filters results by CA Execution Status.

Multiple values are supported. Join them with commas (,). Omit the field to disable this filter.

Allowed values:

1 - Initialized
2 - Confrimed
3 - Recoding
4 - Record - Success
5 - Record - Failed
6 - Execution - Pending Approval
7 - Executing
9 - Execution - Success
10 - Execution - Failed
0 - Not Created
12 - Cancelled
11 - Success; Avg cost is updated
13 - Cancelled; Avg cost is updated
14 - Execution - Success
15 - Expired
1617 - In approval

1 · Initialized2 · Confrimed3 · Recoding4 · Record - Success5 · Record - Failed6 · Execution - Pending Approval7 · Executing9 · Execution - Success10 · Execution - Failed0 · Not Created12 · Cancelled11 · Success; Avg cost is updated13 · Cancelled; Avg cost is updated14 · Execution - Success15 · Expired1617 · In approval

remarkstring

Filters results by Remark.

notify_statestring

Filters results by Client Mandate Collection Status.

Multiple values are supported. Join them with commas (,). Omit the field to disable this filter.

Allowed values:

1 - Initialized
2 - Mandate Collection
3 - Processed - Success
4 - Processed - Failed
5 - Submitted to upstream/C.P.
6 - Alloted/Completed

1 · Initialized2 · Mandate Collection3 · Processed - Success4 · Processed - Failed5 · Submitted to upstream/C.P.6 · Alloted/Completed

receivable_dtobject

Filters results by CCASS File Date.

Child attributes

gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

receivable_typestring

Filters results by CCASS Rec. Type.

Allowed values:

P - Preliminary
F - Final
C - Cancelled
T - To Be Advised
R - Reminder

P · PreliminaryF · FinalC · CancelledT · To Be AdvisedR · Reminder

created_atobject

Filters results by Created Time.

Child attributes

gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

has_clientstring

Filters results by Client Num.

Allowed values:

>0 - With Clients
=0 - Without Clients

>0 · With Clients=0 · Without Clients

effective_dateobject

Filters results by Payable Date (CCASS).

Child attributes

gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated corporate announcements records together with pagination metadata such as the page number, page size, and total record count.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

Returned value: List of list.

Child attributes

ann_typestring

Returned value: Ann Type.

ann_type_valstring

Raw value of ann_type. The ann_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

ca_codestring

Returned value: Announcement NO..

remarkstring

Returned value: Remark.

marketstring

Returned value: Market.

origin_counter_idstring

Returned value: Origin Counter ID.

stage_statestring

Returned value: CA Execution Status.

stage_state_valstring

Raw value of stage_state. The stage_state field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

notify_statestring

Returned value: Client Mandate Collection Status.

notify_state_valstring

Raw value of notify_state. The notify_state field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

has_clientstring

Returned value: Indicates whether client.

has_client_valstring

Raw value of has_client. The has_client field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

payable_datestring

Returned value: Payable Date. The date or time format follows the value returned by the API.

record_datestring

Returned value: Record Date. The date or time format follows the value returned by the API.

election_fromstring

Returned value: Elect. Period From.

in_side_election_tostring

Returned value: Elect. Period to.

election_tostring

Returned value: Select End Time (CCASS).

effective_datestring

Returned value: Payable Date (CCASS). The date or time format follows the value returned by the API.

receivable_typestring

Returned value: CCASS Rec. Type.

receivable_type_valstring

Raw value of receivable_type. The receivable_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

receivable_dtstring

Returned value: CCASS File Date.

last_trading_datestring

Returned value: Last Trading Date. The date or time format follows the value returned by the API.

created_bystring

Returned value: Created By.

idstring

Returned value: Unique identifier of the current record.

created_atstring

Returned value: Created Time. The date or time format follows the value returned by the API.

updated_atstring

Returned value: Updated At. The date or time format follows the value returned by the API.

operatorstring

Returned value: Operater.

is_app_optionalstring

Returned value: Indicates whether is app optional.

is_app_optional_valstring

Raw value of is_app_optional. The is_app_optional field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

totalintegerrequired

Returned value: Total number of matching records, used for pagination.

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

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "ann_type": "BE",
        "ann_type_val": "4",
        "ca_code": 882902308,
        "remark": "DIPS.US Cash Dividend: 0.2813 USD per Share",
        "market": "US",
        "origin_counter_id": "ETF/US/DIPS",
        "stage_state": "Initialized",
        "stage_state_val": "1",
        "notify_state": "Initialized",
        "notify_state_val": "1",
        "has_client": "No",
        "has_client_val": "false",
        "payable_date": "1784678400",
        "record_date": "1784246400",
        "election_from": "--",
        "in_side_election_to": "--",
        "election_to": "--",
        "effective_date": "1784592000",
        "receivable_type": "--",
        "receivable_type_val": "",
        "receivable_dt": "--",
        "last_trading_date": "--",
        "created_by": "SYSTEM-AUTO-CREATE",
        "id": "117456",
        "created_at": "1784171454",
        "updated_at": "1784184808",
        "operator": "示例用户",
        "is_app_optional": "NO",
        "is_app_optional_val": "false"
      }
    ],
    "total": 21476
  }
}

Export

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

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

Export options Export records Download result