ex_bitmex

v0.0.2

ex_bitmex v0.0.2 ExBitmex.Rest.Orders

Link to this section Summary

Types

auth_error_reason()
create_error_reason()
credentials()
order()
params()
rate_limit()

Functions

amend(credentials, params)
cancel(credentials, params)
create(credentials, params)

Link to this section Types

Link to this type auth_error_reason() 
auth_error_reason() :: ExBitmex.Rest.HTTPClient.auth_error_reason()
Link to this type create_error_reason() 
create_error_reason() ::
  :timeout | auth_error_reason() | {:insufficient_balance, msg :: String.t()}
Link to this type credentials() 
credentials() :: ExBitmex.Credentials.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, auth_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 create(credentials, params) 
create(credentials(), params()) ::
  {:ok, order(), rate_limit()}
  | {:error, create_error_reason(), rate_limit() | nil}