Skip to content
Longport WhaleLongport Whale
Corp Action Management

Create Announcement

Manually creates a corporate-action announcement. Alternatively, an announcement can be created by syncing from an advance notice code via /v1/sync/announcement.

Request parameters

  • Required: ca_code (corporate-action code), origin_counter_id (underlying security code), announcement_type, date_type, date.
  • See the field descriptions for the format, allowed values, defaults, and business meaning of each field.

Business notes

On success a corporate-action announcement is created for use in the later registration, notification, and execution flows.

Risk warning

This operation adds corporate-action business data. Confirm the underlying, announcement type, and date before calling.

Result

On success the announcement is created; see the 200 response for the resulting state and data.

POSThttps://b-api.lbkrs.com/corporate_action/create/announcement

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_corporate.corporate_query

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Request body application/json

ca_codestringrequired

This field is required.

origin_counter_idstringrequired

Counter ID associated with this request.

announcement_typestringrequired

This field is required.

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)

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

This field is required.

Allowed values: 1 Ex Date, 2 Record Date

Values
1
Ex Date
2
Record Date
datestringrequired

Date associated with this request. Use the date format defined by the API. This field is required.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

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