ex_bitmex

v0.0.3

ex_bitmex v0.0.3 ExBitmex.Rest.HTTPClient

Link to this section Summary

Types

auth_error_reason()
auth_response()
bad_request()
credentials()
forbidden()
invalid_signature()
ip_forbidden()
non_auth_error_reason()
non_auth_response()
params()
rate_limit()
unauthorized()
verb()

Functions

auth_delete(path, credentials, params)
auth_get(path, credentials, params)
auth_post(path, credentials, params)
auth_put(path, credentials, params)
auth_request(verb, path, credentials, params)
domain()
non_auth_get(path, params \\ %{})
non_auth_request(verb, path, params)
url(path)

Link to this section Types

Link to this type

auth_error_reason() 
auth_error_reason() ::
  :timeout
  | :not_found
  | ip_forbidden()
  | forbidden()
  | invalid_signature()
  | unauthorized()
  | bad_request()

Link to this type

auth_response() 
auth_response() ::
  {:ok, map() | [map()], rate_limit()}
  | {:error, auth_error_reason(), rate_limit() | nil}

Link to this type

bad_request() 
bad_request() :: {:bad_request, error :: map()}

Link to this type

credentials() 
credentials() :: ExBitmex.Credentials.t()

Link to this type

forbidden() 
forbidden() :: {:forbidden, message :: String.t()}

Link to this type

invalid_signature() 
invalid_signature() :: :invalid_signature

Link to this type

ip_forbidden() 
ip_forbidden() :: :ip_forbidden

Link to this type

non_auth_error_reason() 
non_auth_error_reason() :: :timeout | :not_found | bad_request()

Link to this type

non_auth_response() 
non_auth_response() ::
  {:ok, map() | [map()], rate_limit()}
  | {:error, non_auth_error_reason(), rate_limit() | nil}

Link to this type

params() 
params() :: map()

Link to this type

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

Link to this type

unauthorized() 
unauthorized() :: {:unauthorized, message :: String.t()}

Link to this type

verb() 
verb() :: :get | :post | :put | :delete

Link to this section Functions

Link to this function

auth_delete(path, credentials, params) 
auth_delete(path :: String.t(), credentials(), params()) :: auth_response()

Link to this function

auth_get(path, credentials, params) 
auth_get(path :: String.t(), credentials(), params()) :: auth_response()

Link to this function

auth_post(path, credentials, params) 
auth_post(path :: String.t(), credentials(), params()) :: auth_response()

Link to this function

auth_put(path, credentials, params) 
auth_put(path :: String.t(), credentials(), params()) :: auth_response()

Link to this function

auth_request(verb, path, credentials, params) 
auth_request(verb(), path :: String.t(), credentials(), params()) ::
  auth_response()

Link to this function

domain() 
domain() :: String.t()

Link to this function

non_auth_get(path, params \\ %{}) 
non_auth_get(path :: String.t(), params()) :: non_auth_response()

Link to this function

non_auth_request(verb, path, params) 
non_auth_request(verb(), path :: String.t(), params()) :: non_auth_response()

Link to this function

url(path) 
url(path :: String.t()) :: String.t()