AlpacaElixir v0.1.5 Alpaca.Calendar View Source

A resource that allows us to perform operations on an Calendar

An calendar has the following methods we can call on it

list/1

The list/1 method allows us to serve the full list of market days from 1970 to 2029. It can also be queried by specifying a start and/or end time to narrow down the results. In addition to the dates, the response also contains the specific open and close times for the market days, taking into account early closures.

You can pass optional start and/or end dates as params to the function to get specific time ranges like so Alpaca.Calendar.list(%{start: ~D[2020-02-10], end: ~D[2020-03-01]})

Link to this section Summary

Functions

A function to list all resources from the Alpaca API

Link to this section Functions

Specs

list(map()) :: {:ok, [map()]} | {:error, map()}

A function to list all resources from the Alpaca API