Skip to main content

Stocks

Stock market data endpoints. Mirror methods cover historical batch and single-symbol endpoints, latest endpoints, auction history, snapshots, and metadata endpoints. Convenience methods add:

Methods

MethodKindAsyncRequestReturndocs.rsSite rustdoc
barsmirroryesBarsRequestResult<BarsResponse, Error>docs.rssite
auctionsmirroryesAuctionsRequestResult<AuctionsResponse, Error>docs.rssite
auctions_allconvenienceyesAuctionsRequestResult<AuctionsResponse, Error>docs.rssite
auctions_singlemirroryesAuctionsSingleRequestResult<AuctionsSingleResponse, Error>docs.rssite
auctions_single_allconvenienceyesAuctionsSingleRequestResult<AuctionsSingleResponse, Error>docs.rssite
auctions_streamconveniencenoAuctionsRequestResponseStream<Result<AuctionsResponse, Error>>docs.rssite
auctions_single_streamconveniencenoAuctionsSingleRequestResponseStream<Result<AuctionsSingleResponse, Error>>docs.rssite
bars_allconvenienceyesBarsRequestResult<BarsResponse, Error>docs.rssite
bars_singlemirroryesBarsSingleRequestResult<BarsSingleResponse, Error>docs.rssite
bars_single_allconvenienceyesBarsSingleRequestResult<BarsSingleResponse, Error>docs.rssite
bars_streamconveniencenoBarsRequestResponseStream<Result<BarsResponse, Error>>docs.rssite
bars_single_streamconveniencenoBarsSingleRequestResponseStream<Result<BarsSingleResponse, Error>>docs.rssite
quotesmirroryesQuotesRequestResult<QuotesResponse, Error>docs.rssite
quotes_allconvenienceyesQuotesRequestResult<QuotesResponse, Error>docs.rssite
quotes_singlemirroryesQuotesSingleRequestResult<QuotesSingleResponse, Error>docs.rssite
quotes_single_allconvenienceyesQuotesSingleRequestResult<QuotesSingleResponse, Error>docs.rssite
quotes_streamconveniencenoQuotesRequestResponseStream<Result<QuotesResponse, Error>>docs.rssite
quotes_single_streamconveniencenoQuotesSingleRequestResponseStream<Result<QuotesSingleResponse, Error>>docs.rssite
tradesmirroryesTradesRequestResult<TradesResponse, Error>docs.rssite
trades_allconvenienceyesTradesRequestResult<TradesResponse, Error>docs.rssite
trades_singlemirroryesTradesSingleRequestResult<TradesSingleResponse, Error>docs.rssite
trades_single_allconvenienceyesTradesSingleRequestResult<TradesSingleResponse, Error>docs.rssite
trades_streamconveniencenoTradesRequestResponseStream<Result<TradesResponse, Error>>docs.rssite
trades_single_streamconveniencenoTradesSingleRequestResponseStream<Result<TradesSingleResponse, Error>>docs.rssite
latest_barsmirroryesLatestBarsRequestResult<LatestBarsResponse, Error>docs.rssite
latest_barmirroryesLatestBarRequestResult<LatestBarResponse, Error>docs.rssite
latest_quotesmirroryesLatestQuotesRequestResult<LatestQuotesResponse, Error>docs.rssite
latest_quotemirroryesLatestQuoteRequestResult<LatestQuoteResponse, Error>docs.rssite
latest_tradesmirroryesLatestTradesRequestResult<LatestTradesResponse, Error>docs.rssite
latest_trademirroryesLatestTradeRequestResult<LatestTradeResponse, Error>docs.rssite
snapshotsmirroryesSnapshotsRequestResult<SnapshotsResponse, Error>docs.rssite
snapshotmirroryesSnapshotRequestResult<SnapshotResponse, Error>docs.rssite
condition_codesmirroryesConditionCodesRequestResult<ConditionCodesResponse, Error>docs.rssite
exchange_codesmirroryes-Result<ExchangeCodesResponse, Error>docs.rssite

Requests

AuctionsRequest

FieldOfficial WordTypeNotes
symbolssymbolsVec<String>-
startstartOption<String>-
endendOption<String>-
limitlimitOption<u32>-
asofasofOption<String>-
feedfeedOption<AuctionFeed>-
currencycurrencyOption<Currency>-
page_tokenpage_tokenOption<String>-
sortsortOption<Sort>-

AuctionsSingleRequest

FieldOfficial WordTypeNotes
symbolsymbolString-
startstartOption<String>-
endendOption<String>-
limitlimitOption<u32>-
asofasofOption<String>-
feedfeedOption<AuctionFeed>-
currencycurrencyOption<Currency>-
page_tokenpage_tokenOption<String>-
sortsortOption<Sort>-

BarsRequest

FieldOfficial WordTypeNotes
symbolssymbolsVec<String>-
timeframetimeframeTimeFrame-
startstartOption<String>-
endendOption<String>-
limitlimitOption<u32>-
adjustmentadjustmentOption<Adjustment>-
feedfeedOption<DataFeed>-
sortsortOption<Sort>-
asofasofOption<String>-
currencycurrencyOption<Currency>-
page_tokenpage_tokenOption<String>-

BarsSingleRequest

FieldOfficial WordTypeNotes
symbolsymbolString-
timeframetimeframeTimeFrame-
startstartOption<String>-
endendOption<String>-
limitlimitOption<u32>-
adjustmentadjustmentOption<Adjustment>-
feedfeedOption<DataFeed>-
sortsortOption<Sort>-
asofasofOption<String>-
currencycurrencyOption<Currency>-
page_tokenpage_tokenOption<String>-

ConditionCodesRequest

FieldOfficial WordTypeNotes
ticktypeticktypeTickType-
tapetapeTape-

LatestBarRequest

FieldOfficial WordTypeNotes
symbolsymbolString-
feedfeedOption<DataFeed>-
currencycurrencyOption<Currency>-

LatestBarsRequest

FieldOfficial WordTypeNotes
symbolssymbolsVec<String>-
feedfeedOption<DataFeed>-
currencycurrencyOption<Currency>-

LatestQuoteRequest

FieldOfficial WordTypeNotes
symbolsymbolString-
feedfeedOption<DataFeed>-
currencycurrencyOption<Currency>-

LatestQuotesRequest

FieldOfficial WordTypeNotes
symbolssymbolsVec<String>-
feedfeedOption<DataFeed>-
currencycurrencyOption<Currency>-

LatestTradeRequest

FieldOfficial WordTypeNotes
symbolsymbolString-
feedfeedOption<DataFeed>-
currencycurrencyOption<Currency>-

LatestTradesRequest

FieldOfficial WordTypeNotes
symbolssymbolsVec<String>-
feedfeedOption<DataFeed>-
currencycurrencyOption<Currency>-

QuotesRequest

FieldOfficial WordTypeNotes
symbolssymbolsVec<String>-
startstartOption<String>-
endendOption<String>-
limitlimitOption<u32>-
feedfeedOption<DataFeed>-
sortsortOption<Sort>-
asofasofOption<String>-
currencycurrencyOption<Currency>-
page_tokenpage_tokenOption<String>-

QuotesSingleRequest

FieldOfficial WordTypeNotes
symbolsymbolString-
startstartOption<String>-
endendOption<String>-
limitlimitOption<u32>-
feedfeedOption<DataFeed>-
sortsortOption<Sort>-
asofasofOption<String>-
currencycurrencyOption<Currency>-
page_tokenpage_tokenOption<String>-

SnapshotRequest

FieldOfficial WordTypeNotes
symbolsymbolString-
feedfeedOption<DataFeed>-
currencycurrencyOption<Currency>-

SnapshotsRequest

FieldOfficial WordTypeNotes
symbolssymbolsVec<String>-
feedfeedOption<DataFeed>-
currencycurrencyOption<Currency>-

TradesRequest

FieldOfficial WordTypeNotes
symbolssymbolsVec<String>-
startstartOption<String>-
endendOption<String>-
limitlimitOption<u32>-
feedfeedOption<DataFeed>-
sortsortOption<Sort>-
asofasofOption<String>-
currencycurrencyOption<Currency>-
page_tokenpage_tokenOption<String>-

TradesSingleRequest

FieldOfficial WordTypeNotes
symbolsymbolString-
startstartOption<String>-
endendOption<String>-
limitlimitOption<u32>-
feedfeedOption<DataFeed>-
sortsortOption<Sort>-
asofasofOption<String>-
currencycurrencyOption<Currency>-
page_tokenpage_tokenOption<String>-

Responses

AuctionsResponse

FieldOfficial WordTypeNotes
auctionsauctionsHashMap<String, Vec<DailyAuction>>-
next_page_tokennext_page_tokenOption<String>-
currencycurrencyOption<Currency>-

AuctionsSingleResponse

FieldOfficial WordTypeNotes
symbolsymbolString-
auctionsauctionsVec<DailyAuction>-
next_page_tokennext_page_tokenOption<String>-
currencycurrencyOption<Currency>-

BarsResponse

FieldOfficial WordTypeNotes
barsbarsHashMap<String, Vec<Bar>>-
next_page_tokennext_page_tokenOption<String>-
currencycurrencyOption<Currency>-

BarsSingleResponse

FieldOfficial WordTypeNotes
symbolsymbolString-
barsbarsVec<Bar>-
next_page_tokennext_page_tokenOption<String>-
currencycurrencyOption<Currency>-

ConditionCodesResponse

ExchangeCodesResponse

LatestBarResponse

FieldOfficial WordTypeNotes
symbolsymbolString-
barbarBar-
currencycurrencyOption<Currency>-

LatestBarsResponse

FieldOfficial WordTypeNotes
barsbarsHashMap<String, Bar>-
currencycurrencyOption<Currency>-

LatestQuoteResponse

FieldOfficial WordTypeNotes
symbolsymbolString-
quotequoteQuote-
currencycurrencyOption<Currency>-

LatestQuotesResponse

FieldOfficial WordTypeNotes
quotesquotesHashMap<String, Quote>-
currencycurrencyOption<Currency>-

LatestTradeResponse

FieldOfficial WordTypeNotes
symbolsymbolString-
tradetradeTrade-
currencycurrencyOption<Currency>-

LatestTradesResponse

FieldOfficial WordTypeNotes
tradestradesHashMap<String, Trade>-
currencycurrencyOption<Currency>-

QuotesResponse

FieldOfficial WordTypeNotes
quotesquotesHashMap<String, Vec<Quote>>-
next_page_tokennext_page_tokenOption<String>-
currencycurrencyOption<Currency>-

QuotesSingleResponse

FieldOfficial WordTypeNotes
symbolsymbolString-
quotesquotesVec<Quote>-
next_page_tokennext_page_tokenOption<String>-
currencycurrencyOption<Currency>-

SnapshotResponse

FieldOfficial WordTypeNotes
symbolsymbolString-
currencycurrencyOption<Currency>-
latestTradelatestTradeOption<Trade>-
latestQuotelatestQuoteOption<Quote>-
minuteBarminuteBarOption<Bar>-
dailyBardailyBarOption<Bar>-
prevDailyBarprevDailyBarOption<Bar>-

SnapshotsResponse

TradesResponse

FieldOfficial WordTypeNotes
tradestradesHashMap<String, Vec<Trade>>-
next_page_tokennext_page_tokenOption<String>-
currencycurrencyOption<Currency>-

TradesSingleResponse

FieldOfficial WordTypeNotes
symbolsymbolString-
tradestradesVec<Trade>-
next_page_tokennext_page_tokenOption<String>-
currencycurrencyOption<Currency>-

Models

Auction

FieldOfficial WordTypeNotes
ttOption<Timestamp>-
xxOption<String>-
ppOption<f64>-
ssOption<u64>-
ccOption<String>-

Bar

  • Kind: struct
  • Summary: -
  • docs.rs: Bar
  • Site rustdoc: Bar
FieldOfficial WordTypeNotes
ttOption<Timestamp>-
ooOption<f64>-
hhOption<f64>-
llOption<f64>-
ccOption<f64>-
vvOption<u64>-
nnOption<u64>-
vwvwOption<f64>-

DailyAuction

FieldOfficial WordTypeNotes
ddOption<String>-
ooVec<Auction>-
ccVec<Auction>-

Quote

  • Kind: struct
  • Summary: -
  • docs.rs: Quote
  • Site rustdoc: Quote
FieldOfficial WordTypeNotes
ttOption<Timestamp>-
bxbxOption<String>-
bpbpOption<f64>-
bsbsOption<u64>-
axaxOption<String>-
apapOption<f64>-
r#asasOption<u64>-
ccOption<Vec<String>>-
zzOption<String>-

Snapshot

FieldOfficial WordTypeNotes
latestTradelatestTradeOption<Trade>-
latestQuotelatestQuoteOption<Quote>-
minuteBarminuteBarOption<Bar>-
dailyBardailyBarOption<Bar>-
prevDailyBarprevDailyBarOption<Bar>-

Trade

  • Kind: struct
  • Summary: -
  • docs.rs: Trade
  • Site rustdoc: Trade
FieldOfficial WordTypeNotes
ttOption<Timestamp>-
xxOption<String>-
ppOption<f64>-
ssOption<u64>-
iiOption<u64>-
ccOption<Vec<String>>-
zzOption<String>-
uuOption<String>-

Enums

Adjustment

  • Kind: struct
  • Summary: -
  • docs.rs: Adjustment
  • Site rustdoc: Adjustment
  • Example constructors: raw -> raw, split -> split, dividend -> dividend, spin_off -> spin-off, all -> all

AuctionFeed

VariantOfficial Value
Sipsip

DataFeed

VariantOfficial Value
DelayedSipdelayed_sip
Iexiex
Otcotc
Sipsip
Boatsboats
Overnightovernight

Tape

  • Kind: enum
  • Summary: -
  • docs.rs: Tape
  • Site rustdoc: Tape
VariantOfficial Value
AA
BB
CC

TickType

VariantOfficial Value
Tradetrade
Quotequote

TimeFrame

  • Kind: struct
  • Summary: -
  • docs.rs: TimeFrame
  • Site rustdoc: TimeFrame
  • Example constructors: min_1 -> 1Min, day_1 -> 1Day
  • Examples: examples/stocks_bars_all.rs, examples/stocks_latest_bar.rs
  • Tests: tests/live_stocks_auctions.rs, tests/live_stocks_batch_historical.rs, tests/live_stocks_latest_snapshot.rs, tests/live_stocks_metadata.rs, tests/live_stocks_single_historical.rs, tests/mock_stocks_errors.rs
  • Benchmarks: benches/stocks.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.