Indicado 🚀🌕

Technical indicator library for Elixir with no dependencies. Indicado helps you analyze historical data to generate future price movement predictions on numerical datasets. Many traders and automated trading platforms use technical analysis because past actions may indicate future prices. Indicado might also be used outside financial markets if data hold patterns and not random.

What can you do with this library ❔

One idea is, you can follow up the cryptocurrency trading bot series of Frathon here. You can bring this library and a similar trading infrastructure explained in the video together. So, you can generate trading strategies with the indicators below and increase your chances of profiting.

Table of Contents 📋

• Indicado
• What can you do with this library
• Table of Contents
• Supported Indicators
• Installation
• Usage
• Contributing

Supported Indicators 📈

Indicators below are supported. New indicators being added regularly.

• Accumulation/Distribution Line (ADI)
• Bollinger Bands (BB)
• Exponential Moving Average (EMA)
• Moving Average Convergence Divergence (MACD)
• Relative Strength Index (RSI)
• Simple Moving Average (SMA)
• Stochastic Oscillator (SR)

Helper math functions such as mean, stddev, variance is accessible through Indicado.Math module.

Installation 💻

Indicado published to Hex. Just add it to your dependencies in mix.exs.

def deps do
  [
    {:indicado, "~> 0.0.1"}
  ]
end

Then run mix deps.get to install indicado.

Usage 🛠️

Indicado provides two functions on the public API of indicators. Namely eval and eval! function.

• eval function calls return {:ok, result} or {:error, reason}.
• eval! functions return a single result list or raises exceptions such as NotEnoughDataError.

Because every other indicator may expect different arguments, I recommend you check online documentation on hexdocs before using the indicado. For demonstration purposes how you can calculate a four day Simple Moving Average is shown below.

  iex(2)> Indicado.SMA.eval([1.0, 5.0, 7.4, 12.5, 16,4], 4)
  {:ok, [6.475, 10.225, 9.975]}

Contributing 🧵

Please follow standard convention such as eval and eval! functions defined for all indicators inside lib folder. Rest is easy;

• Fork it!
• Create your feature branch (git checkout -b my-new-feature)
• Commit your changes (git commit -am 'Add some feature')
• Push to the branch (git push origin my-new-feature)
• Create new Pull Request

To ensure a commit passes CI run mix test.ci before opening a pull request to execute commands below.