Struct AlpacaOptionsClient 

pub struct AlpacaOptionsClient { /* private fields */ }

Alpaca options market data client.

Provides access to option contract discovery and chain snapshots via REST API. The client handles authentication, rate limiting, and pagination automatically.

Construction

Use AlpacaOptionsClient::from_env to create a client using environment variables, or AlpacaOptionsClient::new for explicit credentials.

Internally this is a thin wrapper over the shared AlpacaRestClient transport.

Implementations

impl AlpacaOptionsClient

pub async fn fetch_contracts( &self, query: &AlpacaOptionContractQuery, ) -> Result<Vec<AlpacaOptionContract>, AlpacaOptionsError>

Fetch option contracts matching the query.

Automatically paginates through all results. Pagination is bounded: the fetch returns a terminal AlpacaOptionsError::PaginationLimitExceeded if it exceeds 100 pages, and AlpacaOptionsError::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.

Arguments

• query - Query parameters for filtering contracts

Returns

Vector of matching option contracts.

Errors

Returns error on network failure, API error, invalid response, or out-of-bounds pagination (see above).

impl AlpacaOptionsClient

pub async fn fetch_snapshots( &self, symbols: &[String], feed: AlpacaOptionFeed, ) -> Result<Vec<AlpacaOptionSnapshot>, AlpacaOptionsError>

Fetch option snapshots with Greeks for the given symbols.

Automatically batches requests if more than 100 symbols are provided, and paginates through all results. Per-batch pagination is bounded: the fetch returns a terminal AlpacaOptionsError::PaginationLimitExceeded if a batch exceeds 100 pages, and AlpacaOptionsError::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.

Arguments

• symbols - OCC symbols to fetch (e.g., [“AAPL240119C00150000”])
• feed - Data feed to use (OPRA for real-time, Indicative for delayed)

Returns

Vector of option snapshots with quote and Greeks data.

Errors

Returns error on network failure, API error, invalid response, or out-of-bounds pagination (see above).

Note

Greeks streaming is NOT available via WebSocket. This method provides point-in-time snapshot data only.

pub async fn fetch_chain_snapshots( &self, underlying: &str, feed: AlpacaOptionFeed, ) -> Result<Vec<AlpacaOptionSnapshot>, AlpacaOptionsError>

Fetch snapshots for all options of an underlying symbol.

This is a convenience method that first fetches all contracts for the underlying, then fetches snapshots for those contracts.

Arguments

• underlying - Underlying symbol (e.g., “AAPL”)
• feed - Data feed to use

Returns

Vector of option snapshots for all active contracts of the underlying.

impl AlpacaOptionsClient

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

Create a new client with explicit credentials.

Arguments

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

Errors

Returns error if the HTTP client cannot be built (invalid headers).

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

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 error if required environment variables are missing.

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) on the underlying transport.

See AlpacaRestClient::with_base_urls — points the client at API-compatible endpoints other than the production Alpaca hosts (a local mock server in tests, or a proxy/gateway).

Trait Implementations

impl Clone for AlpacaOptionsClient

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 AlpacaOptionsClient

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

Formats the value using the given formatter.