Alpa.Trading.Assets (AlpaEx v1.0.3)

View Source

Asset operations for the Alpaca Trading API.

Summary

Functions

Get a specific asset by symbol or asset ID.

Get all assets.

Functions

get(symbol_or_asset_id, opts \\ [])

@spec get(
  String.t(),
  keyword()
) :: {:ok, Alpa.Models.Asset.t()} | {:error, Alpa.Error.t()}

Get a specific asset by symbol or asset ID.

Examples

iex> Alpa.Trading.Assets.get("AAPL")
{:ok, %Alpa.Models.Asset{...}}

list(opts \\ [])

@spec list(keyword()) :: {:ok, [Alpa.Models.Asset.t()]} | {:error, Alpa.Error.t()}

Get all assets.

Options

  • :status - Filter by status ("active", "inactive")
  • :asset_class - Filter by asset class ("us_equity", "crypto")
  • :exchange - Filter by exchange (e.g., "NASDAQ", "NYSE")

Examples

iex> Alpa.Trading.Assets.list()
{:ok, [%Alpa.Models.Asset{...}]}

iex> Alpa.Trading.Assets.list(status: "active", asset_class: "us_equity")
{:ok, [%Alpa.Models.Asset{...}]}