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

Filters

Child attributes

filters.origin_counter_idstring

Origin Counter Id

filters.ca_codestring

Announcement NO

filters.ann_typestring

Ann Type. Multi-select; submit as a comma-joined string. Allowed values are listed under enum.. Options: 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)

345678910111213141516

filters.marketstring

Market. Multi-select; submit as a comma-joined string. Allowed values are listed under enum.. Options: US = US; HK = HK; UK = UK; SH = SH; SZ = SZ; SG = SG; KR = KR; JP = JP; AU = AU; DE = DE; CA = CA; TH = TH; ID = ID; MY = MY; TR = TR; NA = NA; OSL = OSL; HAS = HAS; EU = EU; UT = UT; GTMMF = GTMMF

USHKUKSHSZSGKRJPAUDECATHIDMYTRNAOSLHASEUUTGTMMF

filters.payable_dateobject

Payable Date. Range filter; both bounds are optional (omit a bound to leave that side unbounded).

Child attributes

filters.payable_date.gtestring

Greater Than or Equal

filters.payable_date.ltestring

Less Than or Equal

filters.record_dateobject

Record Date. Range filter; both bounds are optional (omit a bound to leave that side unbounded).

Child attributes

filters.record_date.gtestring

Greater Than or Equal

filters.record_date.ltestring

Less Than or Equal

filters.election_fromobject

Elect. Period From. Range filter; both bounds are optional (omit a bound to leave that side unbounded).

Child attributes

filters.election_from.gtestring

Greater Than or Equal

filters.election_from.ltestring

Less Than or Equal

filters.in_side_election_toobject

Elect. Period To. Range filter; both bounds are optional (omit a bound to leave that side unbounded).

Child attributes

filters.in_side_election_to.gtestring

Greater Than or Equal

filters.in_side_election_to.ltestring

Less Than or Equal

filters.stage_statestring

CA Execution Status. Multi-select; submit as a comma-joined string. Allowed values are listed under enum.. Options: 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

1234567910012111314151617

filters.remarkstring

Remark

filters.notify_statestring

Client Mandate Collection Status. Multi-select; submit as a comma-joined string. Allowed values are listed under enum.. Options: 1 = Initialized; 2 = Mandate Collection; 3 = Processed - Success; 4 = Processed - Failed; 5 = Submitted to upstream/C.P.; 6 = Alloted/Completed

123456

filters.receivable_dtobject

CCASS File Date. Range filter; both bounds are optional (omit a bound to leave that side unbounded).

Child attributes

filters.receivable_dt.gtestring

Greater Than or Equal

filters.receivable_dt.ltestring

Less Than or Equal

filters.receivable_typestring

CCASS Rec. Type. Options: P = Preliminary; F = Final; C = Cancelled; T = To Be Advised; R = Reminder

PFCTR

filters.created_atobject

Created Time. Range filter; both bounds are optional (omit a bound to leave that side unbounded).

Child attributes

filters.created_at.gtestring

Greater Than or Equal

filters.created_at.ltestring

Less Than or Equal

filters.has_clientstring

Client Num. Options: >0 = With Clients; =0 = Without Clients

>0=0

filters.effective_dateobject

Payable Date (CCASS). Range filter; both bounds are optional (omit a bound to leave that side unbounded).

Child attributes

filters.effective_date.gtestring

Greater Than or Equal

filters.effective_date.ltestring

Less Than or Equal

pageinteger

Page

page_sizeinteger

Page Size

orderByarray<object>

Order By

Responses

HTTP 200Paginated list result.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

List

totalintegerrequired

Total

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,
  "orderBy": []
}'

Response

{
  "code": 0,
  "message": null,
  "data": {
    "list": [
      {
        "ann_type": "<string>",
        "ca_code": "<string>",
        "remark": "<string>",
        "market": "<string>",
        "origin_counter_id": "<string>",
        "stage_state": "<string>",
        "notify_state": "<string>",
        "has_client": "<string>",
        "payable_date": "<string>",
        "record_date": "<string>",
        "election_from": "<string>",
        "in_side_election_to": "<string>",
        "election_to": "<string>",
        "effective_date": "<string>",
        "receivable_type": "<string>",
        "receivable_dt": "<string>",
        "last_trading_date": "<string>",
        "created_by": "<string>",
        "id": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>",
        "operator": "<string>",
        "is_app_optional": "<string>"
      }
    ],
    "total": 0
  }
}