ExOkex.Api (ExOkex v0.6.0) View Source

API Base

Link to this section Summary

Link to this section Types

Specs

body() :: term()

Specs

config() :: ExOkex.Config.t()

Specs

error_reason() :: :rate_limited | term()

Specs

params() :: map()

Specs

path() :: String.t()

Specs

response() ::
  {:ok, term()} | {:error, error_reason()} | {:error, body(), status_code()}

Specs

status_code() :: integer()

Link to this section Functions

Link to this function

parse_response(response)

View Source

Specs

parse_response(
  {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
  | {:error, HTTPoison.Error.t()}
) :: response()
Link to this function

query_string(path, params)

View Source

Specs

query_string(path(), params()) :: String.t()

Specs

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