Alpa.Models.Trade (AlpaEx v1.0.3)

View Source

Trade data model for market data.

Summary

Types

t()

Functions

from_map(data, symbol \\ nil)

Parse trade data from API response.

from_response(data)

Parse multiple trades from API response.

Types

t()

@type t() :: %Alpa.Models.Trade{
  conditions: [String.t()] | nil,
  exchange: String.t() | nil,
  id: integer() | nil,
  price: Decimal.t() | nil,
  size: integer() | nil,
  symbol: String.t() | nil,
  tape: String.t() | nil,
  timestamp: DateTime.t() | nil,
  update: String.t() | nil
}

Functions

from_map(data, symbol \\ nil)

@spec from_map(map(), String.t() | nil) :: t()

Parse trade data from API response.

from_response(data)

@spec from_response(map()) :: %{required(String.t()) => [t()]} | [t()]

Parse multiple trades from API response.