ex_bitmex v0.0.6 ExBitmex.Rest.HTTPClient
Link to this section Summary
Link to this section Types
Link to this type
auth_error_reason()
auth_error_reason()
auth_error_reason() ::
:timeout
| :not_found
| bad_request()
| :overloaded
| service_unavailable()
| nonce_not_increasing()
| :ip_forbidden
| forbidden()
| :invalid_signature
| unauthorized()
auth_error_reason() :: :timeout | :not_found | bad_request() | :overloaded | service_unavailable() | nonce_not_increasing() | :ip_forbidden | forbidden() | :invalid_signature | unauthorized()
Link to this type
auth_error_response()
auth_error_response()
auth_error_response() :: {:error, auth_error_reason(), rate_limit() | nil}
auth_error_response() :: {:error, auth_error_reason(), rate_limit() | nil}
Link to this type
auth_response()
auth_response()
auth_response() :: auth_success_response() | auth_error_response()
auth_response() :: auth_success_response() | auth_error_response()
Link to this type
auth_success_response()
auth_success_response()
auth_success_response() :: {:ok, map() | [map()], rate_limit()}
auth_success_response() :: {:ok, map() | [map()], rate_limit()}
Link to this type
bad_request()
bad_request()
bad_request() :: {:bad_request, error :: map()}
bad_request() :: {:bad_request, error :: map()}
Link to this type
credentials()
credentials()
credentials() :: ExBitmex.Credentials.t()
credentials() :: ExBitmex.Credentials.t()
Link to this type
forbidden()
forbidden()
forbidden() :: {:forbidden, message()}
forbidden() :: {:forbidden, message()}
Link to this type
message()
message()
message() :: String.t()
message() :: String.t()
Link to this type
non_auth_error_reason()
non_auth_error_reason()
non_auth_error_reason() ::
:timeout | :not_found | bad_request() | :overloaded | service_unavailable()
non_auth_error_reason() :: :timeout | :not_found | bad_request() | :overloaded | service_unavailable()
Link to this type
non_auth_response()
non_auth_response()
non_auth_response() ::
{:ok, map() | [map()], rate_limit()}
| {:error, non_auth_error_reason(), rate_limit() | nil}
non_auth_response() :: {:ok, map() | [map()], rate_limit()} | {:error, non_auth_error_reason(), rate_limit() | nil}
Link to this type
nonce_not_increasing()
nonce_not_increasing()
nonce_not_increasing() :: {:nonce_not_increasing, message()}
nonce_not_increasing() :: {:nonce_not_increasing, message()}
Link to this type
params()
params()
params() :: map()
params() :: map()
Link to this type
rate_limit()
rate_limit()
rate_limit() :: ExBitmex.RateLimit.t()
rate_limit() :: ExBitmex.RateLimit.t()
Link to this type
unauthorized()
unauthorized()
unauthorized() :: {:unauthorized, message()}
unauthorized() :: {:unauthorized, message()}
Link to this type
verb()
verb()
verb() :: :get | :post | :put | :delete
verb() :: :get | :post | :put | :delete
Link to this section Functions
Link to this function
auth_delete(path, credentials, params)
auth_delete(path, credentials, params)
auth_delete(path :: String.t(), credentials(), params()) :: auth_response()
auth_delete(path :: String.t(), credentials(), params()) :: auth_response()
Link to this function
auth_get(path, credentials, params)
auth_get(path, credentials, params)
auth_get(path :: String.t(), credentials(), params()) :: auth_response()
auth_get(path :: String.t(), credentials(), params()) :: auth_response()
Link to this function
auth_post(path, credentials, params)
auth_post(path, credentials, params)
auth_post(path :: String.t(), credentials(), params()) :: auth_response()
auth_post(path :: String.t(), credentials(), params()) :: auth_response()
Link to this function
auth_put(path, credentials, params)
auth_put(path, credentials, params)
auth_put(path :: String.t(), credentials(), params()) :: auth_response()
auth_put(path :: String.t(), credentials(), params()) :: auth_response()
Link to this function
auth_request(verb, path, credentials, params)
auth_request(verb, path, credentials, params)
auth_request(verb(), path :: String.t(), credentials(), params()) ::
auth_response()
auth_request(verb(), path :: String.t(), credentials(), params()) :: auth_response()
Link to this function
domain()
domain()
domain() :: String.t()
domain() :: String.t()
Link to this function
non_auth_get(path, params \\ %{})
non_auth_get(path, params \\ %{})
non_auth_get(path :: String.t(), params()) :: non_auth_response()
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, params)
non_auth_request(verb(), path :: String.t(), params()) :: non_auth_response()
non_auth_request(verb(), path :: String.t(), params()) :: non_auth_response()
Link to this function