Struct AlpacaRestClient 

pub struct AlpacaRestClient { /* private fields */ }

Authenticated Alpaca REST client.

Holds the configured reqwest::Client (with auth headers + timeout) plus the broker and data API base URLs. Endpoint-family wrappers (AlpacaOptionsClient, the corporate-action source, …) build requests against these bases and drive them through a shared retrying request helper.

Implementations

impl AlpacaRestClient

pub fn fetch_splits_raw<'a>( &'a self, query: &'a CorporateActionsQuery, ) -> impl Stream<Item = Result<AlpacaStockSplit, AlpacaRestError>> + 'a

Fetch stock splits matching query from GET /v1beta1/corporate-actions.

Returns a stream that handles page_token pagination automatically, yielding each forward/reverse split as a normalised AlpacaStockSplit. Pagination is bounded: the stream yields a terminal AlpacaRestError::PaginationLimitExceeded if it exceeds 1000 pages, and AlpacaRestError::CyclicPagination if the server repeats a page_token — a silently truncated result would be indistinguishable from a genuinely small one, so incomplete pagination fails loudly instead.

Example

use rustrade_data::exchange::alpaca::{AlpacaRestClient, CorporateActionsQuery};
use futures::StreamExt;

let client = AlpacaRestClient::from_env()?;
let query = CorporateActionsQuery::new().symbols(["NVDA"]);
let mut stream = client.fetch_splits_raw(&query);
while let Some(split) = stream.next().await {
    println!("{:?}", split?);
}

impl AlpacaRestClient

pub fn new( api_key: &str, api_secret: &str, paper: bool, ) -> Result<Self, AlpacaRestError>

Create a new client with explicit credentials.

Arguments

• api_key - Alpaca API key
• api_secret - Alpaca API secret
• paper - Use the paper trading broker endpoint if true

Errors

Returns an error if the HTTP client cannot be built (e.g. non-ASCII credentials that cannot be encoded as header values).

pub fn from_env() -> Result<Self, AlpacaRestError>

Create a client from environment variables.

Reads:

• ALPACA_API_KEY - API key (required)
• ALPACA_SECRET_KEY - API secret (required)
• ALPACA_PAPER - Set to “true” for paper trading (optional, defaults to false)

Errors

Returns an error if either required environment variable is missing or the client cannot be built.

pub fn with_base_urls( self, broker_base: impl Into<String>, data_base: impl Into<String>, ) -> Self

Override both API base URLs (broker and data).

Points the client at API-compatible endpoints other than the production Alpaca hosts — a local mock server in tests, or a proxy/gateway. Credentials, timeouts and retry behaviour are unchanged.

Infallible by design: unlike a next_url-following client, this client only ever requests URLs it builds itself from these bases (pagination advances via an opaque page_token query parameter, never a server-supplied URL), so there is no trusted origin to derive — and nothing to fail on — at construction.

Trait Implementations

impl Clone for AlpacaRestClient

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AlpacaRestClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl StockSplitSource for AlpacaRestClient

fn fetch_splits( &self, filter: &CorporateActionFilter, ) -> impl Stream<Item = Result<CorporateAction<SmolStr>, Self::Error>> + Send

Fetch stock splits for filter’s symbols and effective-date range, mapped to CorporateAction<SmolStr> descriptors.

effective_date provenance: this impl maps it onto Alpaca’s ex_date — the session on which the share count re-bases and the price adjusts, satisfying the StockSplitSource::fetch_splits market-execution-date contract. It deliberately does NOT use payable_date: for forward splits Alpaca’s payable_date can fall a trading day before ex_date (sampled: APH ex 2024-06-12 / payable 2024-06-11; CNQ ex 2024-06-11 / payable 2024-06-10) while the price re-bases on ex_date (observed equal to process_date across the sample), so mapping payable_date would apply the split a day early — look-ahead corruption. This mapping is pinned by ex_date_provenance_ignores_payable_date (in reference) and map_split_maps_ex_date_to_effective_date below.

Alpaca’s endpoint accepts a single comma-joined symbols parameter, so — unlike Massive’s per-symbol fan-out — a multi-symbol filter issues one paginated query. An empty symbols list requests every split in the date range (subject to provider page limits). Splits whose new_rate / old_rate yield a degenerate ratio (zero, negative, or division by zero) are logged and skipped — see CorporateActionKind::stock_split.

type Error = AlpacaRestError

Error yielded as a stream item when a fetch fails (e.g. a transport or deserialisation error). Per-item so a partial result set is still observable up to the failure point.