Corporate actions endpoints. Mirror method:
Methods
| Method | Kind | Async | Request | Return | docs.rs | Site rustdoc |
|---|
list | mirror | yes | ListRequest | Result<ListResponse, Error> | docs.rs | site |
list_all | convenience | yes | ListRequest | Result<ListResponse, Error> | docs.rs | site |
list_stream | convenience | no | ListRequest | ResponseStream<Result<ListResponse, Error>> | docs.rs | site |
Requests
CorporateActionType
| Variant | Official Value |
|---|
ForwardSplit | forward_split |
ReverseSplit | reverse_split |
UnitSplit | unit_split |
StockDividend | stock_dividend |
CashDividend | cash_dividend |
SpinOff | spin_off |
CashMerger | cash_merger |
StockMerger | stock_merger |
StockAndCashMerger | stock_and_cash_merger |
Redemption | redemption |
NameChange | name_change |
WorthlessRemoval | worthless_removal |
RightsDistribution | rights_distribution |
ContractAdjustment | contract_adjustment |
PartialCall | partial_call |
ListRequest
| Field | Official Word | Type | Notes |
|---|
symbols | symbols | Option<Vec<String>> | - |
cusips | cusips | Option<Vec<String>> | - |
types | types | Option<Vec<CorporateActionType>> | - |
start | start | Option<String> | - |
end | end | Option<String> | - |
ids | ids | Option<Vec<String>> | - |
limit | limit | Option<u32> | - |
sort | sort | Option<Sort> | - |
page_token | page_token | Option<String> | - |
Responses
ListResponse
| Field | Official Word | Type | Notes |
|---|
corporate_actions | corporate_actions | CorporateActions | - |
next_page_token | next_page_token | Option<String> | - |
Models
CashDividend
| Field | Official Word | Type | Notes |
|---|
id | id | String | - |
symbol | symbol | String | - |
cusip | cusip | String | - |
rate | rate | rust_decimal::Decimal | - |
special | special | bool | - |
foreign | foreign | bool | - |
process_date | process_date | String | - |
ex_date | ex_date | String | - |
record_date | record_date | Option<String> | - |
payable_date | payable_date | Option<String> | - |
due_bill_on_date | due_bill_on_date | Option<String> | - |
due_bill_off_date | due_bill_off_date | Option<String> | - |
CashMerger
| Field | Official Word | Type | Notes |
|---|
id | id | String | - |
acquirer_symbol | acquirer_symbol | Option<String> | - |
acquirer_cusip | acquirer_cusip | Option<String> | - |
acquiree_symbol | acquiree_symbol | String | - |
acquiree_cusip | acquiree_cusip | String | - |
rate | rate | rust_decimal::Decimal | - |
process_date | process_date | String | - |
effective_date | effective_date | String | - |
payable_date | payable_date | Option<String> | - |
CorporateActions
| Field | Official Word | Type | Notes |
|---|
forward_splits | forward_splits | Vec<ForwardSplit> | - |
reverse_splits | reverse_splits | Vec<ReverseSplit> | - |
unit_splits | unit_splits | Vec<UnitSplit> | - |
stock_dividends | stock_dividends | Vec<StockDividend> | - |
cash_dividends | cash_dividends | Vec<CashDividend> | - |
spin_offs | spin_offs | Vec<SpinOff> | - |
cash_mergers | cash_mergers | Vec<CashMerger> | - |
stock_mergers | stock_mergers | Vec<StockMerger> | - |
stock_and_cash_mergers | stock_and_cash_mergers | Vec<StockAndCashMerger> | - |
redemptions | redemptions | Vec<Redemption> | - |
name_changes | name_changes | Vec<NameChange> | - |
worthless_removals | worthless_removals | Vec<WorthlessRemoval> | - |
rights_distributions | rights_distributions | Vec<RightsDistribution> | - |
contract_adjustments | contract_adjustments | Vec<UnknownCorporateAction> | - |
partial_calls | partial_calls | Vec<UnknownCorporateAction> | - |
other | other | BTreeMap<String, Vec<UnknownCorporateAction>> | - |
ForwardSplit
| Field | Official Word | Type | Notes |
|---|
id | id | String | - |
symbol | symbol | String | - |
cusip | cusip | String | - |
new_rate | new_rate | rust_decimal::Decimal | - |
old_rate | old_rate | rust_decimal::Decimal | - |
process_date | process_date | String | - |
ex_date | ex_date | String | - |
record_date | record_date | Option<String> | - |
payable_date | payable_date | Option<String> | - |
due_bill_redemption_date | due_bill_redemption_date | Option<String> | - |
NameChange
| Field | Official Word | Type | Notes |
|---|
id | id | String | - |
old_symbol | old_symbol | String | - |
old_cusip | old_cusip | String | - |
new_symbol | new_symbol | String | - |
new_cusip | new_cusip | String | - |
process_date | process_date | String | - |
Redemption
| Field | Official Word | Type | Notes |
|---|
id | id | String | - |
symbol | symbol | String | - |
cusip | cusip | String | - |
rate | rate | rust_decimal::Decimal | - |
process_date | process_date | String | - |
payable_date | payable_date | Option<String> | - |
ReverseSplit
| Field | Official Word | Type | Notes |
|---|
id | id | String | - |
symbol | symbol | String | - |
old_cusip | old_cusip | String | - |
new_cusip | new_cusip | String | - |
new_rate | new_rate | rust_decimal::Decimal | - |
old_rate | old_rate | rust_decimal::Decimal | - |
process_date | process_date | String | - |
ex_date | ex_date | String | - |
record_date | record_date | Option<String> | - |
payable_date | payable_date | Option<String> | - |
RightsDistribution
| Field | Official Word | Type | Notes |
|---|
id | id | String | - |
source_symbol | source_symbol | String | - |
source_cusip | source_cusip | String | - |
new_symbol | new_symbol | String | - |
new_cusip | new_cusip | String | - |
rate | rate | rust_decimal::Decimal | - |
process_date | process_date | String | - |
ex_date | ex_date | String | - |
record_date | record_date | Option<String> | - |
payable_date | payable_date | String | - |
expiration_date | expiration_date | Option<String> | - |
SpinOff
| Field | Official Word | Type | Notes |
|---|
id | id | String | - |
source_symbol | source_symbol | String | - |
source_cusip | source_cusip | String | - |
source_rate | source_rate | rust_decimal::Decimal | - |
new_symbol | new_symbol | String | - |
new_cusip | new_cusip | String | - |
new_rate | new_rate | rust_decimal::Decimal | - |
process_date | process_date | String | - |
ex_date | ex_date | String | - |
record_date | record_date | Option<String> | - |
payable_date | payable_date | Option<String> | - |
due_bill_redemption_date | due_bill_redemption_date | Option<String> | - |
StockAndCashMerger
| Field | Official Word | Type | Notes |
|---|
id | id | String | - |
acquirer_symbol | acquirer_symbol | String | - |
acquirer_cusip | acquirer_cusip | String | - |
acquirer_rate | acquirer_rate | rust_decimal::Decimal | - |
acquiree_symbol | acquiree_symbol | String | - |
acquiree_cusip | acquiree_cusip | String | - |
acquiree_rate | acquiree_rate | rust_decimal::Decimal | - |
cash_rate | cash_rate | rust_decimal::Decimal | - |
process_date | process_date | String | - |
effective_date | effective_date | String | - |
payable_date | payable_date | Option<String> | - |
StockDividend
| Field | Official Word | Type | Notes |
|---|
id | id | String | - |
symbol | symbol | String | - |
cusip | cusip | String | - |
rate | rate | rust_decimal::Decimal | - |
process_date | process_date | String | - |
ex_date | ex_date | String | - |
record_date | record_date | Option<String> | - |
payable_date | payable_date | Option<String> | - |
StockMerger
| Field | Official Word | Type | Notes |
|---|
id | id | String | - |
acquirer_symbol | acquirer_symbol | String | - |
acquirer_cusip | acquirer_cusip | String | - |
acquirer_rate | acquirer_rate | rust_decimal::Decimal | - |
acquiree_symbol | acquiree_symbol | String | - |
acquiree_cusip | acquiree_cusip | String | - |
acquiree_rate | acquiree_rate | rust_decimal::Decimal | - |
process_date | process_date | String | - |
effective_date | effective_date | String | - |
payable_date | payable_date | Option<String> | - |
UnitSplit
| Field | Official Word | Type | Notes |
|---|
id | id | String | - |
old_symbol | old_symbol | String | - |
old_cusip | old_cusip | String | - |
old_rate | old_rate | rust_decimal::Decimal | - |
new_symbol | new_symbol | String | - |
new_cusip | new_cusip | String | - |
new_rate | new_rate | rust_decimal::Decimal | - |
alternate_symbol | alternate_symbol | String | - |
alternate_cusip | alternate_cusip | String | - |
alternate_rate | alternate_rate | rust_decimal::Decimal | - |
process_date | process_date | String | - |
effective_date | effective_date | String | - |
payable_date | payable_date | Option<String> | - |
UnknownCorporateAction
WorthlessRemoval
| Field | Official Word | Type | Notes |
|---|
id | id | String | - |
symbol | symbol | String | - |
cusip | cusip | String | - |
process_date | process_date | String | - |
Enums
Sort
- Kind: enum
- Summary: -
- docs.rs: Sort
- Site rustdoc: Sort
| Variant | Official Value |
|---|
Asc | asc |
Desc | desc |
- 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.