Corporate Actions¶
The corporate actions endpoints allow you to retrieve data for splits, mergers, and other corporate events.
Get Corporate Actions¶
- BrokerClient.get_corporate_announcements(filter: GetCorporateAnnouncementsRequest) List[CorporateActionAnnouncement] | Dict[str, Any]¶
Deprecated since version 0.45.0: Please use the new corporate actions endpoint instead. alpaca.data.historical.corporate_actions.CorporateActionsClient.get_corporate_actions() ref. https://docs.alpaca.markets/reference/corporateactions-1
Returns corporate action announcements data given specified search criteria. :param filter: The parameters to filter the search by. :type filter: GetCorporateAnnouncementsRequest
- Returns:
The resulting announcements from the search.
- Return type:
Get Corporate Action By ID¶
- BrokerClient.get_corporate_announcement_by_id(corporate_announcment_id: UUID | str) CorporateActionAnnouncement | Dict[str, Any]¶
Deprecated since version 0.45.0: Please use the new corporate actions endpoint instead. alpaca.data.historical.corporate_actions.CorporateActionsClient.get_corporate_actions() ref. https://docs.alpaca.markets/reference/corporateactions-1
Returns a specific corporate action announcement. :param corporate_announcment_id: The id of the desired corporate action announcement
- Returns:
The corporate action queried.
- Return type: