Specs

format_to_float(any()) :: float() | {:error, binary()}

Helper function for formatting the value to float.

Specs

generate_empty_candle() :: OHLC.candle()

Generates and returns empty candle.

Specs

get_time_rounded(number(), OHLC.timeframe(), list() | nil) ::
  number() | DateTime

Gets the rounded timestamp based on the timeframe.

Parameters:

• timestamp - Unix timestamp which will be rounded.
• timeframe - Timeframe used for rounding the timestamp. Available values are: :minute, :hour, :day, :week
• opts - Options for rounding the timestamp. Available values are:
  • {:format, :stamp | :struct} - Returned value will be unix timestamp or DateTime struct.
  • {:type, :down | :up | :jump} - Timestamp will be rounded up, down or jump to the next time cycle. Default is :up.

Specs

trades_total_volume(OHLC.trades()) :: float()

Calculates the total volume from trades.

Specs

validate_data(OHLC.candles() | nil, OHLC.trades() | nil) ::
  :ok | {:error, binary()}

Validates the data used for generating the OHLC candles. Accepts lists of candles, trades or both.