Alpa.Models.Bar (AlpaEx v1.0.3)

View Source

OHLCV bar data model for market data.

Summary

Types

t()

Functions

from_map(data, symbol \\ nil)

Parse bar data from API response.

from_response(data)

Parse multiple bars from API response.

Types

t()

@type t() :: %Alpa.Models.Bar{
  close: Decimal.t() | nil,
  high: Decimal.t() | nil,
  low: Decimal.t() | nil,
  open: Decimal.t() | nil,
  symbol: String.t() | nil,
  timestamp: DateTime.t() | nil,
  trade_count: integer() | nil,
  volume: integer() | nil,
  vwap: Decimal.t() | nil
}

Functions

from_map(data, symbol \\ nil)

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

Parse bar data from API response.

from_response(data)

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

Parse multiple bars from API response.