Skip to main content

Module reference

Module reference 

Source
Expand description

Alpaca corporate-actions reference data (GET /v1beta1/corporate-actions).

The raw REST surface behind the StockSplitSource adapter: a CorporateActionsQuery builder, the nested response types, and the paginated AlpacaRestClient::fetch_splits_raw stream. Only stock-split actions are requested (types=forward_split,reverse_split); each row is normalised into an AlpacaStockSplit.

§Date semantics

AlpacaStockSplit::ex_date is the split’s ex-date — the session on which the share count re-bases and the price adjusts (observed equal to process_date across every sampled split). It is the field the StockSplitSource adapter maps onto the descriptor’s effective_date. Alpaca also returns payable_date, which can fall a trading day before ex_date for forward splits and therefore must NOT be used as the effective date: an effective date earlier than the true ex-date would re-base a position before the market actually did.

Structs§

AlpacaStockSplit
A normalised Alpaca stock split (forward or reverse).
CorporateActionsQuery
Query parameters for the GET /v1beta1/corporate-actions splits endpoint.