Corp Action

Interface Description

• Function description: Supports the query of the corporate events for stock splits and reverse stock split, including past and upcoming events.

• Request URL: /instrument/corp-action

• Request method: GET

• Frequency limit: The calling frequency of each AppId is limited to 60 times per minute.

Request parameters

Parameter	Type	Required fields	Description
page_number	int	No	The initial value, if not passed, the first page will be searched by default
page_size	int	No	Number of entries per page: default value is 20, and maximum value is 200. Integers can be filled
instrument_ids	String	Yes	Instrument id collection, such as: 913256135,913303964. Multiple instrument_ids should be separated by ,. A single query supports up to 100 instrument_id
start_date	String	No	Event start date, UTC time.Time format: yyyy-MM-dd
end_date	String	No	Event end date, UTC time.Time format: yyyy-MM-dd
event_types	String	Yes	Event type collection. Multiple event_types should be separated by ,, reference: EventType
last_update_time	String	No	Incremental update time, UTC time. Time format: yyyy-MM-dd HH:mm:ss

Response parameter

Field	Type	Description
instrument_id	int	Unique identifier for the security
symbol	String	Securities code
isin	String	Security isin
exchange_code	String	Exchange code, reference: ExchangeCode
cusip	String	Security cusip
event_type	int	Event type, reference: EventType
event_action	String	Event status, reference: EventStatus
event_id	int	Event id
source	String	Event source, reference: EventSource
ratio_old	String	old ratio
ratio_new	String	new ratio
event_date	String	Event date, UTC time, eg: 2021-12-28
update_time	String	Update time, UTC time, eg: 2021-12-28T09:00:09.945+0000
create_time	String	Create time, UTC time, eg: 2021-12-28T09:00:09.945+0000

Request example

Python

from webullsdktrade.api import API
from webullsdkcore.client import ApiClient
from webullsdkcore.common.region import Region

api_client = ApiClient(your_app_key, your_app_secret, Region.JP.value)
api = API(api_client)
res = api.market_data.get_corp_action(instrument_ids="913303964,913256135", event_types="301,302")
if res.status_code == 200:
    print('corp action quote:', res.json())

Java

HttpApiConfig apiConfig = HttpApiConfig.builder()
        .appKey(Env.APP_KEY)
        .appSecret(Env.APP_SECRET)
        .regionId(Region.jp.name())
        .build();
QuotesApiClient quotesApiClient = new HttpQuotesApiClient(apiConfig);

CorpActionRequest corpActionRequest = new CorpActionRequest();
corpActionRequest.setPageNumber(pageNumber);
corpActionRequest.setPageSize(pageSize);
corpActionRequest.setInstrumentIds(instrumentIds);
corpActionRequest.setStartDate(startDate);
corpActionRequest.setEndDate(endDate);
corpActionRequest.setEventTypes(eventTypes);
corpActionRequest.setLastUpdateTime(lastUpdateTime);
List<CorpAction> corpAction = quotesApiClient.getCorpAction(corpActionRequest);

Response example