Krakex.API (krakex v0.5.0) View Source

Access to public and private APIs.

This module defines functions for building calls for the public and private APIs and handles things such as request signing.

Link to this section Summary

Link to this section Types

Specs

response() :: {:ok, term()} | {:error, any()}

Link to this section Functions

Link to this function

private_request(client, resource, params \\ [])

View Source

Specs

private_request(Krakex.Client.t(), binary(), keyword()) :: response()

Access private API calls.

It signs requests using the API and private keys.

It will raise a Krakex.API.MissingCredentialsError if provided a Krakex.Client struct without values for either the API or private keys.

Link to this function

public_request(client, resource, params \\ [])

View Source

Specs

public_request(Krakex.Client.t(), binary(), keyword()) :: response()

Access public API calls.