AlpacaElixir v2.1.0 Alpaca.Bars View Source

A resource that allows us to query the Bars data from Alpaca The bars API provides time-aggregated price and volume data.

Link to this section Summary

Functions

Retrieves a list of bars for each requested symbol. It is guaranteed all bars are in ascending order by time.

Link to this section Functions

Link to this function

list(timeframe, params \\ %{})

View Source

Specs

list(String.t(), map()) :: {:ok, map()} | {:error, map()}

Retrieves a list of bars for each requested symbol. It is guaranteed all bars are in ascending order by time.

Example

iex> {:ok, bars} = Alpaca.Bar.list("day", %{symbols: "APPL,F,TSLA"})

Allows us to retrieve bars information as a result tuple {:ok, %{}} if successful. If not success we will get back a result tuple {:error, {status: http_status_code, body: http_response_body}}