Skip to content
Rights Issues and Tender Offers

List Rights Issue and Tender Offer Events

Lists, page by page, corporate action events that require an active subscription, such as rights issues and tender offers, for the target account. Used for the rights issue and tender offer list page. You can filter by market, event type, and subscription status.

An empty order_id or "0" means the Client has not subscribed yet. The Broker App shows the event details and max_subscribe_quantity; after the Client enters a quantity, call POST /v1/portfolio/corpaction/subscribe/calculate_fee and then POST /v1/portfolio/corpaction/subscribe/apply. A populated order_id means a subscription order already exists; use it to call POST /v1/portfolio/corpaction/subscribe/detail.

Pagination: page starts from 1. When page × size is greater than or equal to data.total, there is no more data. Specify the target account in the x-target-aaid request header.

POSThttps://api.lbkrs.com/v1/portfolio/corpaction/subscribe/list

Parameters

x-target-aaidstringheaderRequired

The aaid of the target account. The operation returns or processes subscription data for this account.

Request body application/json

searchobject
Child attributes
filtersobject
Child attributes
marketstring

Market code, such as HK or US

statestring

Filter by subscription status. See CorpActionSubscribeState for values. Pass ALL to skip this filter.

typestring

Filter by event type. See CorpActionSubscribeType for values. Pass ALL to skip this filter.

pageinteger

Page number, starting from 1

sizeinteger

Records per page. The Broker App uses 10.

Responses

HTTP 200The request succeeded. The response body contains the result of the “List Rights Issue and Tender Offer Events” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
dataarray<object>

Event list

Child attributes
ann_idstring

Corporate action event ID. Convert it to a number when calculating fees or subscribing.

order_idstring

Subscription order ID. An empty value or "0" means the Client has not subscribed yet.

counter_codestring

Security code

counter_namestring

Security name

currencystring

Currency of the subscription price and fees

typestring

Subscription corporate action type:

  • RIGHTSISSUE - Rights issue
  • TAKEOVER - Tender offer
Values
RIGHTSISSUE
TAKEOVER
statestring

Subscription status:

  • UNSELECT - Pending
  • PROCESSING - Processing
  • UNDISTRIBUT - Pending distribution
  • DISTRIBUTED - Distributed
  • REVOKED - Cancelled
Values
UNSELECT
PROCESSING
UNDISTRIBUT
DISTRIBUTED
REVOKED
pricestring

Subscription price: the rights issue price for rights issues, or the offer price for tender offers

equity_holdingstring

Holding quantity, in shares

max_subscribe_quantitystring

Maximum quantity that can be subscribed, in shares

is_excessboolean

Whether this is an excess rights application. Applies only to rights issues.

record_datestring

Record date, as a Unix timestamp in seconds, in string form

start_timestring

Subscription start time, as a Unix timestamp in seconds, in string form

end_timestring

Subscription closing time, as a Unix timestamp in seconds, in string form

distribute_datestring

Estimated distribution date, as a Unix timestamp in seconds, in string form

totalinteger

Total number of matching records

Whale Docs