ExBitmex.Rest.Orders (ex_bitmex v0.6.1)
Link to this section Summary
Link to this section Types
Link to this type
amend_error_reason()
Specs
amend_error_reason() :: auth_error_reason() | insufficient_balance_error_reason()
Link to this type
auth_error_reason()
Specs
auth_error_reason() :: ExBitmex.Rest.Request.auth_error_reason()
Link to this type
create_error_reason()
Specs
create_error_reason() :: auth_error_reason() | insufficient_balance_error_reason()
Link to this type
credentials()
Specs
credentials() :: ExBitmex.Credentials.t()
Link to this type
insufficient_balance_error_reason()
Specs
insufficient_balance_error_reason() :: {:insufficient_balance, error_msg :: String.t()}
Link to this type
order()
Specs
order() :: ExBitmex.Order.t()
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
amend(credentials, params)
Specs
amend(credentials(), params()) :: {:ok, order(), rate_limit()} | {:error, amend_error_reason(), rate_limit() | nil}
Link to this function
amend_bulk(credentials, params)
Specs
amend_bulk(credentials(), params()) :: {:ok, [order()], rate_limit()} | {:error, amend_error_reason(), rate_limit() | nil}
Link to this function
cancel(credentials, params)
Specs
cancel(credentials(), params()) :: {:ok, [order()], rate_limit()} | {:error, auth_error_reason(), rate_limit() | nil}
Link to this function
cancel_bulk(credentials, params)
Specs
cancel_bulk(credentials(), params()) :: {:ok, [order()], rate_limit()} | {:error, auth_error_reason(), rate_limit() | nil}
Link to this function
create(credentials, params)
Specs
create(credentials(), params()) :: {:ok, order(), rate_limit()} | {:error, create_error_reason(), rate_limit() | nil}