ExFtx.Markets.Candles (ex_ftx v0.0.14)

Link to this section Summary

Link to this section Types

Specs

candle() :: ExFtx.Candle.t()
Link to this type

market_name()

Specs

market_name() :: String.t()

Specs

params() :: %{
  optional(:limit) => pos_integer(),
  optional(:start_time) => pos_integer(),
  optional(:end_time) => pos_integer()
}
Link to this type

resolution()

Specs

resolution() :: non_neg_integer()

Specs

result() ::
  {:ok, candle()} | {:error, :not_found | :parse_result_item | String.t()}

Link to this section Functions

Link to this function

get(market_name, resolution, params \\ %{})

Specs

get(market_name(), resolution(), params()) :: result()