Alpa.MarketData.Quotes (AlpaEx v1.0.3)
View SourceQuote (NBBO) data from the Alpaca Market Data API v2.
Summary
Functions
Get historical quotes for a single symbol.
Get historical quotes for multiple symbols.
Get the latest quote for a symbol.
Get latest quotes for multiple symbols.
Functions
@spec get( String.t(), keyword() ) :: {:ok, [Alpa.Models.Quote.t()]} | {:error, Alpa.Error.t()}
Get historical quotes for a single symbol.
Required Parameters
symbol- Stock symbol (e.g., "AAPL")
Options
:start- Start time (DateTime or ISO 8601 string):end- End time (DateTime or ISO 8601 string):limit- Max quotes to return (default 1000, max 10000):feed- Data feed: "iex", "sip":page_token- Pagination token
Examples
iex> Alpa.MarketData.Quotes.get("AAPL", start: ~U[2024-01-15 14:30:00Z])
{:ok, [%Alpa.Models.Quote{...}]}
@spec get_multi( [String.t()], keyword() ) :: {:ok, %{required(String.t()) => [Alpa.Models.Quote.t()]}} | {:error, Alpa.Error.t()}
Get historical quotes for multiple symbols.
Required Parameters
symbols- List of stock symbols (e.g., ["AAPL", "MSFT"])
Options
Same as get/2.
Examples
iex> Alpa.MarketData.Quotes.get_multi(["AAPL", "MSFT"], start: ~U[2024-01-15 14:30:00Z])
{:ok, %{"AAPL" => [%Alpa.Models.Quote{...}], "MSFT" => [%Alpa.Models.Quote{...}]}}
@spec latest( String.t(), keyword() ) :: {:ok, Alpa.Models.Quote.t()} | {:error, Alpa.Error.t()}
Get the latest quote for a symbol.
Options
:feed- Data feed: "iex", "sip"
Examples
iex> Alpa.MarketData.Quotes.latest("AAPL")
{:ok, %Alpa.Models.Quote{...}}
@spec latest_multi( [String.t()], keyword() ) :: {:ok, %{required(String.t()) => Alpa.Models.Quote.t()}} | {:error, Alpa.Error.t()}
Get latest quotes for multiple symbols.
Examples
iex> Alpa.MarketData.Quotes.latest_multi(["AAPL", "MSFT"])
{:ok, %{"AAPL" => %Alpa.Models.Quote{...}, "MSFT" => %Alpa.Models.Quote{...}}}