https://github.com/straw-hat-labs/bittrex

Bittrex Client for Elixir
https://github.com/straw-hat-labs/bittrex

bittrex bittrex-api elixir elixir-lang module

Last synced: about 2 months ago
JSON representation

Bittrex Client for Elixir

• Host: GitHub
• URL: https://github.com/straw-hat-labs/bittrex
• Owner: straw-hat-labs
• License: mit
• Created: 2017-08-12T07:47:45.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2019-11-01T10:56:35.000Z (about 6 years ago)
• Last Synced: 2025-06-29T00:59:58.170Z (7 months ago)
• Topics: bittrex, bittrex-api, elixir, elixir-lang, module
• Language: Elixir
• Homepage: https://hex.pm/packages/bittrex
• Size: 292 KB
• Stars: 11
• Watchers: 4
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# Bittrex

[![Hex.pm](https://img.shields.io/hexpm/v/bittrex.svg)](https://hex.pm/packages/bittrex)

[![CI Status](https://travis-ci.org/straw-hat-team/bittrex.svg?branch=master)](https://travis-ci.org/straw-hat-team/bittrex)

[![Code Coverage](https://codecov.io/gh/straw-hat-team/bittrex/branch/master/graph/badge.svg)](https://codecov.io/gh/straw-hat-team/bittrex)

[Bittrex API](https://bittrex.github.io/api/v3) integration.

## Usage

First, create the credentials from Bittrex. To manage your API keys please goto

`Settings -> Manage API Keys` on Bittrex.

You need to create an `Bittrex.Client` using `Bittrex.Client.new/1`

    client = Bittrex.Client.new(%{

      api_key: "my api key",

      api_secret: "my api secret"

    })

Now you can use the available functions for communicate with Bittrex API.

Example:

    client = Bittrex.Client.new(%{

      api_key: "my api key",

      api_secret: "my api secret"

    })

    {:ok, markets} = Bittrex.Markets.get_markets(client)

Check the current modules, the module names are trying to follow the same

structure from the [official documentation of Bittrex API](https://bittrex.github.io/api/v3).