ex_bitmex v0.6.1

ExBitmex.Rest.Instrument.CompositeIndex (ex_bitmex v0.6.1)

Link to this section Summary

Types

composite_index()
error_reason()
params()
rate_limit()

Functions

get(symbol, params \\ %{})

Link to this section Types

Link to this type

composite_index()

Specs

composite_index() :: ExBitmex.CompositeIndex.t()
Link to this type

error_reason()

Specs

error_reason() :: term()
Link to this type

params()

Specs

params() :: map()
Link to this type

rate_limit()

Specs

rate_limit() :: ExBitmex.RateLimit.t()

Link to this section Functions

Link to this function

get(symbol, params \\ %{})

Specs

get(String.t(), map()) ::
  {:ok, [composite_index()], rate_limit()}
  | {:error, error_reason(), rate_limit() | nil}