krakex v0.1.1 Krakex.Client View Source
The Krakex client.
This modules defines a Krakex.Client
struct which is needed to use any
of the functions defined in the Krakex
module.
It contains the following fields:
key
- the API key.secret
- the private API key.endpoint
- the base URL of the API (default:"https://api.kraken.com"
).
Link to this section Summary
Link to this section Types
Link to this type
t()
View Source
t() :: %Krakex.Client{endpoint: binary(), http_client: module(), key: binary() | nil, secret: binary() | nil}
Link to this section Functions
Link to this function
new(api_key, private_key, endpoint \\ "https://api.kraken.com")
View Source
new(binary(), binary(), binary()) :: t()
Returns a Krakex.Client
struct.
It takes care of initializing the values for the API and private keys.
The endpoint
argument can optionally be set.