Alpa.Trading.CorporateActions (AlpaEx v1.0.3)
View SourceCorporate actions operations for the Alpaca Trading API.
Provides access to corporate action announcements including dividends, mergers, spinoffs, and stock splits.
Summary
Functions
@spec get( String.t(), keyword() ) :: {:ok, Alpa.Models.CorporateAction.t()} | {:error, Alpa.Error.t()}
Get a specific corporate action announcement.
Examples
iex> Alpa.Trading.CorporateActions.get("announcement-id")
{:ok, %Alpa.Models.CorporateAction{...}}
@spec list(keyword()) :: {:ok, [Alpa.Models.CorporateAction.t()]} | {:error, Alpa.Error.t()}
Get corporate action announcements.
Options
:ca_types- Filter by type (e.g., ["dividend", "split"]):since- Filter since date (format: "YYYY-MM-DD"):until- Filter until date (format: "YYYY-MM-DD"):symbol- Filter by symbol:cusip- Filter by CUSIP:date_type- Date type to filter on ("declaration", "ex", "record", "payable")
Examples
iex> Alpa.Trading.CorporateActions.list(ca_types: ["dividend"], symbol: "AAPL")
{:ok, [%Alpa.Models.CorporateAction{...}]}