ex_bitmex v0.2.0 ExBitmex.Rest.Orders

Link to this section Summary

Link to this section Types

Link to this type

amend_error_reason()

Link to this type

auth_error_reason()

Link to this type

create_error_reason()

create_error_reason() ::
  auth_error_reason() | insufficient_balance_error_reason()
Link to this type

credentials()

credentials() :: ExBitmex.Credentials.t()
Link to this type

insufficient_balance_error_reason()

insufficient_balance_error_reason() ::
  {:insufficient_balance, error_msg :: String.t()}
Link to this type

params()

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

rate_limit()

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

Link to this section Functions

Link to this function

amend(credentials, params)

amend(credentials(), params()) ::
  {:ok, order(), rate_limit()}
  | {:error, amend_error_reason(), rate_limit() | nil}
Link to this function

amend_bulk(credentials, params)

amend_bulk(credentials(), params()) ::
  {:ok, [order()], rate_limit()}
  | {:error, amend_error_reason(), rate_limit() | nil}
Link to this function

cancel(credentials, params)

cancel(credentials(), params()) ::
  {:ok, [order()], rate_limit()}
  | {:error, auth_error_reason(), rate_limit() | nil}
Link to this function

cancel_bulk(credentials, params)

cancel_bulk(credentials(), params()) ::
  {:ok, [order()], rate_limit()}
  | {:error, auth_error_reason(), rate_limit() | nil}
Link to this function

create(credentials, params)

create(credentials(), params()) ::
  {:ok, order(), rate_limit()}
  | {:error, create_error_reason(), rate_limit() | nil}