AlpacaElixir v0.1.6 Alpaca.Asset View Source

A resource that allows us to perform operations on an Asset

An asset has the following methods we can call on it

get/1
list/1

The get/1 method allows us to get a singular asset by calling Alpaca.Asset.get(symbol) or Alpaca.Asset.get(id). Where symbol is the symbol of the asset to get and id is the Alpaca internal id of the asset.

The list/1 method allows us to list all assets by calling Alpaca.Asset.list(params). Where the params are a map, and possible options are defined in the Alpaca documentation.

Link to this section Summary

Functions

A function to get a singlular resource from the Alpaca API

A function to list all resources from the Alpaca API

Link to this section Functions

Specs

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

A function to get a singlular resource from the Alpaca API

Specs

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

A function to list all resources from the Alpaca API