Alpa.Models.Order (AlpaEx v1.0.3)

View Source

Order model for trading operations.

Summary

Functions

Parse order data from API response.

Types

order_class()

@type order_class() :: :simple | :bracket | :oco | :oto

order_type()

@type order_type() :: :market | :limit | :stop | :stop_limit | :trailing_stop

side()

@type side() :: :buy | :sell

status()

@type status() ::
  :new
  | :partially_filled
  | :filled
  | :done_for_day
  | :canceled
  | :expired
  | :replaced
  | :pending_cancel
  | :pending_replace
  | :pending_new
  | :accepted
  | :accepted_for_bidding
  | :stopped
  | :rejected
  | :suspended
  | :calculated
  | :held

t()

@type t() :: %Alpa.Models.Order{
  asset_class: String.t() | nil,
  asset_id: String.t() | nil,
  canceled_at: DateTime.t() | nil,
  client_order_id: String.t() | nil,
  created_at: DateTime.t() | nil,
  expired_at: DateTime.t() | nil,
  extended_hours: boolean() | nil,
  failed_at: DateTime.t() | nil,
  filled_at: DateTime.t() | nil,
  filled_avg_price: Decimal.t() | nil,
  filled_qty: Decimal.t() | nil,
  hwm: Decimal.t() | nil,
  id: String.t() | nil,
  legs: [t()] | nil,
  limit_price: Decimal.t() | nil,
  notional: Decimal.t() | nil,
  order_class: order_class() | nil,
  order_type: order_type() | nil,
  qty: Decimal.t() | nil,
  replaced_at: DateTime.t() | nil,
  replaced_by: String.t() | nil,
  replaces: String.t() | nil,
  side: side() | nil,
  status: status() | nil,
  stop_price: Decimal.t() | nil,
  submitted_at: DateTime.t() | nil,
  symbol: String.t() | nil,
  time_in_force: time_in_force() | nil,
  trail_percent: Decimal.t() | nil,
  trail_price: Decimal.t() | nil,
  type: String.t() | nil,
  updated_at: DateTime.t() | nil
}

time_in_force()

@type time_in_force() :: :day | :gtc | :opg | :cls | :ioc | :fok

Functions

from_map(data)

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

Parse order data from API response.