codecovHex.pmLicenseDocumentationBuild StatusElixir Version

Geminex

geminex is an Elixir REST client for Gemini public and private APIs.

Documentation

HexDocs includes API reference plus focused guides:

Installation

Add geminex to your list of dependencies in mix.exs:

def deps do
  [
    {:geminex, "~> 0.1.1"}
  ]
end

Then fetch dependencies:

mix deps.get

Quickstart

import Config

config :geminex,
  environment: :sandbox,
  api_key: System.get_env("GEMINI_API_KEY"),
  api_secret: System.get_env("GEMINI_API_SECRET")
{:ok, symbols} = Geminex.API.Public.symbols()
{:ok, balances} = Geminex.API.Private.available_balances()

Notes

Running Tests

mix test

Running Dialyzer

mix dialyzer --plt
mix dialyzer

License

Apache License 2.0. See LICENSE.