Skip to main content

Corporate Actions

Corporate actions endpoints. Mirror method:

Methods

MethodKindAsyncRequestReturndocs.rsSite rustdoc
listmirroryesListRequestResult<ListResponse, Error>docs.rssite
list_allconvenienceyesListRequestResult<ListResponse, Error>docs.rssite
list_streamconveniencenoListRequestResponseStream<Result<ListResponse, Error>>docs.rssite

Requests

CorporateActionType

VariantOfficial Value
ForwardSplitforward_split
ReverseSplitreverse_split
UnitSplitunit_split
StockDividendstock_dividend
CashDividendcash_dividend
SpinOffspin_off
CashMergercash_merger
StockMergerstock_merger
StockAndCashMergerstock_and_cash_merger
Redemptionredemption
NameChangename_change
WorthlessRemovalworthless_removal
RightsDistributionrights_distribution
ContractAdjustmentcontract_adjustment
PartialCallpartial_call

ListRequest

FieldOfficial WordTypeNotes
symbolssymbolsOption<Vec<String>>-
cusipscusipsOption<Vec<String>>-
typestypesOption<Vec<CorporateActionType>>-
startstartOption<String>-
endendOption<String>-
idsidsOption<Vec<String>>-
limitlimitOption<u32>-
sortsortOption<Sort>-
page_tokenpage_tokenOption<String>-

Responses

ListResponse

FieldOfficial WordTypeNotes
corporate_actionscorporate_actionsCorporateActions-
next_page_tokennext_page_tokenOption<String>-

Models

CashDividend

FieldOfficial WordTypeNotes
ididString-
symbolsymbolString-
cusipcusipString-
rateraterust_decimal::Decimal-
specialspecialbool-
foreignforeignbool-
process_dateprocess_dateString-
ex_dateex_dateString-
record_daterecord_dateOption<String>-
payable_datepayable_dateOption<String>-
due_bill_on_datedue_bill_on_dateOption<String>-
due_bill_off_datedue_bill_off_dateOption<String>-

CashMerger

FieldOfficial WordTypeNotes
ididString-
acquirer_symbolacquirer_symbolOption<String>-
acquirer_cusipacquirer_cusipOption<String>-
acquiree_symbolacquiree_symbolString-
acquiree_cusipacquiree_cusipString-
rateraterust_decimal::Decimal-
process_dateprocess_dateString-
effective_dateeffective_dateString-
payable_datepayable_dateOption<String>-

CorporateActions

FieldOfficial WordTypeNotes
forward_splitsforward_splitsVec<ForwardSplit>-
reverse_splitsreverse_splitsVec<ReverseSplit>-
unit_splitsunit_splitsVec<UnitSplit>-
stock_dividendsstock_dividendsVec<StockDividend>-
cash_dividendscash_dividendsVec<CashDividend>-
spin_offsspin_offsVec<SpinOff>-
cash_mergerscash_mergersVec<CashMerger>-
stock_mergersstock_mergersVec<StockMerger>-
stock_and_cash_mergersstock_and_cash_mergersVec<StockAndCashMerger>-
redemptionsredemptionsVec<Redemption>-
name_changesname_changesVec<NameChange>-
worthless_removalsworthless_removalsVec<WorthlessRemoval>-
rights_distributionsrights_distributionsVec<RightsDistribution>-
contract_adjustmentscontract_adjustmentsVec<UnknownCorporateAction>-
partial_callspartial_callsVec<UnknownCorporateAction>-
otherotherBTreeMap<String, Vec<UnknownCorporateAction>>-

ForwardSplit

FieldOfficial WordTypeNotes
ididString-
symbolsymbolString-
cusipcusipString-
new_ratenew_raterust_decimal::Decimal-
old_rateold_raterust_decimal::Decimal-
process_dateprocess_dateString-
ex_dateex_dateString-
record_daterecord_dateOption<String>-
payable_datepayable_dateOption<String>-
due_bill_redemption_datedue_bill_redemption_dateOption<String>-

NameChange

FieldOfficial WordTypeNotes
ididString-
old_symbolold_symbolString-
old_cusipold_cusipString-
new_symbolnew_symbolString-
new_cusipnew_cusipString-
process_dateprocess_dateString-

Redemption

FieldOfficial WordTypeNotes
ididString-
symbolsymbolString-
cusipcusipString-
rateraterust_decimal::Decimal-
process_dateprocess_dateString-
payable_datepayable_dateOption<String>-

ReverseSplit

FieldOfficial WordTypeNotes
ididString-
symbolsymbolString-
old_cusipold_cusipString-
new_cusipnew_cusipString-
new_ratenew_raterust_decimal::Decimal-
old_rateold_raterust_decimal::Decimal-
process_dateprocess_dateString-
ex_dateex_dateString-
record_daterecord_dateOption<String>-
payable_datepayable_dateOption<String>-

RightsDistribution

FieldOfficial WordTypeNotes
ididString-
source_symbolsource_symbolString-
source_cusipsource_cusipString-
new_symbolnew_symbolString-
new_cusipnew_cusipString-
rateraterust_decimal::Decimal-
process_dateprocess_dateString-
ex_dateex_dateString-
record_daterecord_dateOption<String>-
payable_datepayable_dateString-
expiration_dateexpiration_dateOption<String>-

SpinOff

FieldOfficial WordTypeNotes
ididString-
source_symbolsource_symbolString-
source_cusipsource_cusipString-
source_ratesource_raterust_decimal::Decimal-
new_symbolnew_symbolString-
new_cusipnew_cusipString-
new_ratenew_raterust_decimal::Decimal-
process_dateprocess_dateString-
ex_dateex_dateString-
record_daterecord_dateOption<String>-
payable_datepayable_dateOption<String>-
due_bill_redemption_datedue_bill_redemption_dateOption<String>-

StockAndCashMerger

FieldOfficial WordTypeNotes
ididString-
acquirer_symbolacquirer_symbolString-
acquirer_cusipacquirer_cusipString-
acquirer_rateacquirer_raterust_decimal::Decimal-
acquiree_symbolacquiree_symbolString-
acquiree_cusipacquiree_cusipString-
acquiree_rateacquiree_raterust_decimal::Decimal-
cash_ratecash_raterust_decimal::Decimal-
process_dateprocess_dateString-
effective_dateeffective_dateString-
payable_datepayable_dateOption<String>-

StockDividend

FieldOfficial WordTypeNotes
ididString-
symbolsymbolString-
cusipcusipString-
rateraterust_decimal::Decimal-
process_dateprocess_dateString-
ex_dateex_dateString-
record_daterecord_dateOption<String>-
payable_datepayable_dateOption<String>-

StockMerger

FieldOfficial WordTypeNotes
ididString-
acquirer_symbolacquirer_symbolString-
acquirer_cusipacquirer_cusipString-
acquirer_rateacquirer_raterust_decimal::Decimal-
acquiree_symbolacquiree_symbolString-
acquiree_cusipacquiree_cusipString-
acquiree_rateacquiree_raterust_decimal::Decimal-
process_dateprocess_dateString-
effective_dateeffective_dateString-
payable_datepayable_dateOption<String>-

UnitSplit

FieldOfficial WordTypeNotes
ididString-
old_symbolold_symbolString-
old_cusipold_cusipString-
old_rateold_raterust_decimal::Decimal-
new_symbolnew_symbolString-
new_cusipnew_cusipString-
new_ratenew_raterust_decimal::Decimal-
alternate_symbolalternate_symbolString-
alternate_cusipalternate_cusipString-
alternate_ratealternate_raterust_decimal::Decimal-
process_dateprocess_dateString-
effective_dateeffective_dateString-
payable_datepayable_dateOption<String>-

UnknownCorporateAction

WorthlessRemoval

FieldOfficial WordTypeNotes
ididString-
symbolsymbolString-
cusipcusipString-
process_dateprocess_dateString-

Enums

Sort

  • Kind: enum
  • Summary: -
  • docs.rs: Sort
  • Site rustdoc: Sort
VariantOfficial Value
Ascasc
Descdesc
  • Examples: examples/corporate_actions_list.rs
  • Tests: tests/live_corporate_actions.rs, tests/mock_news_corporate_actions_errors.rs
  • Benchmarks: benches/news_corporate_actions.rs

Coverage Notes

  • The strict endpoint parity ledger for this module lives in API Coverage.
  • Generated reference pages mirror the shipped Rust surface and do not claim unimplemented Alpaca endpoints as available.