Alpa.Models.Position (AlpaEx v1.0.3)

View Source

Position model for portfolio holdings.

Summary

Functions

Parse position data from API response.

Types

side()

@type side() :: :long | :short

t()

@type t() :: %Alpa.Models.Position{
  asset_class: String.t() | nil,
  asset_id: String.t() | nil,
  asset_marginable: boolean() | nil,
  avg_entry_price: Decimal.t() | nil,
  change_today: Decimal.t() | nil,
  cost_basis: Decimal.t() | nil,
  current_price: Decimal.t() | nil,
  exchange: String.t() | nil,
  lastday_price: Decimal.t() | nil,
  market_value: Decimal.t() | nil,
  qty: Decimal.t() | nil,
  qty_available: Decimal.t() | nil,
  side: side() | nil,
  symbol: String.t() | nil,
  unrealized_intraday_pl: Decimal.t() | nil,
  unrealized_intraday_plpc: Decimal.t() | nil,
  unrealized_pl: Decimal.t() | nil,
  unrealized_plpc: Decimal.t() | nil
}

Functions

from_map(data)

@spec from_map(map()) :: t()

Parse position data from API response.