# History
[![Build Status](https://github.com/fremantle-industries/history/workflows/test/badge.svg?branch=main)](https://github.com/fremantle-industries/history/actions?query=workflow%3Atest)
[![hex.pm version](https://img.shields.io/hexpm/v/history.svg?style=flat)](https://hex.pm/packages/history)

Download and warehouse historical trading data

## Install

Add `history` to your list of dependencies in `mix.exs`

```elixir
def deps do
  [
    {:history, "~> 0.0.22"}
  ]
end
```

## Usage

```bash
$ docker-compose up
```

Visit [`history.localhost`](http://history.localhost)

When running the application with `docker-compose` you will need to enter the basic auth development credentials:

```
username: admin
password: password
```

## Requirements

`history` requires Elixir 1.12+ & Erlang/OTP 22+

## Features

### Import Products From Tai

![import-tai-products](./docs/import-tai-products.png)

### Download Historical Venue Data

![filter-predicted-funding-rate-job](./docs/filter-predicted-funding-rate-job.png)

![predicted-funding-rate-download](./docs/predicted-funding-rate-download.png)

### Visualize & Explore Data for Market Insights

![home](./docs/history-home.png)

![gainers-and-losers](./docs/history-gainers-losers.png)

![swap-funding-rates](./docs/swap-funding-rates.png)

## Venues

| Venues   | Trades | Candles | Funding Rates | Predicted Funding Rates | Lending Rates |
| -------- | :----: | :-----: | :-----------: | :---------------------: | :-----------: |
| FTX      |  [x]   |   [x]   |      [x]      |           [x]           |      [x]      |
| OkEx     |  [ ]   |   [ ]   |      [ ]      |           [ ]           |      [ ]      |
| BitMEX   |  [ ]   |   [ ]   |      [ ]      |           [ ]           |      [ ]      |
| Binance  |  [ ]   |   [ ]   |      [ ]      |           [ ]           |      [ ]      |
| Deribit  |  [ ]   |   [ ]   |      [ ]      |           [ ]           |      [ ]      |
| GDAX     |  [ ]   |   [ ]   |      [ ]      |           [ ]           |      [ ]      |
| Huobi    |  [ ]   |   [ ]   |      [ ]      |           [ ]           |      [ ]      |
| Bybit    |  [ ]   |   [ ]   |      [ ]      |           [ ]           |      [ ]      |
| bit.com  |  [ ]   |   [ ]   |      [ ]      |           [ ]           |      [ ]      |
| Bitfinex |  [ ]   |   [ ]   |      [ ]      |           [ ]           |      [ ]      |
| Kraken   |  [ ]   |   [ ]   |      [ ]      |           [ ]           |      [ ]      |
| CME      |  [ ]   |   [ ]   |      [ ]      |           [ ]           |      [ ]      |
| Phemex   |  [ ]   |   [ ]   |      [ ]      |           [ ]           |      [ ]      |
| BTSE     |  [ ]   |   [ ]   |      [ ]      |           [ ]           |      [ ]      |
| KuCoin   |  [ ]   |   [ ]   |      [ ]      |           [ ]           |      [ ]      |
| BitMax   |  [ ]   |   [ ]   |      [ ]      |           [ ]           |      [ ]      |
| MEXC     |  [ ]   |   [ ]   |      [ ]      |           [ ]           |      [ ]      |
| PrimeXBT |  [ ]   |   [ ]   |      [ ]      |           [ ]           |      [ ]      |
| Gate.io  |  [ ]   |   [ ]   |      [ ]      |           [ ]           |      [ ]      |
| Coinflex |  [ ]   |   [ ]   |      [ ]      |           [ ]           |      [ ]      |
| bitFlyer |  [ ]   |   [ ]   |      [ ]      |           [ ]           |      [ ]      |

## Development

Initial setup:

- Installs `hex` and `npm` dependencies
- Generates migrations for history, workbench and tai
- Runs migrations
- Seeds database

```bash
$ docker-compose up db
$ mix setup
$ mix phx.server
```

## Test

```bash
$ docker-compose up db
$ mix test
```

## Ecto Database

Reset drops the db, creates a new db & runs the migrations

```bash
$ mix ecto.reset
```

Migrate up

```bash
$ mix ecto.migrate
```

Migrate down

```bash
# Last migration
$ mix ecto.rollback
# Last 3 migrations
$ mix ecto.rollback -n 3
```

## Help Wanted :)

If you think this `history` thing might be worthwhile and you don't see a feature
or venue listed we would love your contributions to add them! Feel free to
drop us an email or open a Github issue.

## Authors

- Alex Kwiatkowski - alex+git@fremantle.io

## License

`history` is released under the [MIT license](./LICENSE)