Skip to content
A real time market data and trade execution toolkit. Built with Elixir, runs on the Erlang virtual machine
Elixir
Branch: master
Clone or download
Latest commit 9faf5c6 Aug 18, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Add Elixir v1.9.0 to CircleCI test matrix Jun 28, 2019
apps Release 0.0.31 Aug 18, 2019
config Add example autocancel configuration Aug 7, 2019
secrets Move CI bitmex api secret Jul 1, 2019
.dialyzer_ignore.exs Use structs to handle BitMEX passive order update messages Jul 1, 2019
.formatter.exs Use umbrella app to separate the framework from examples Jul 26, 2019
.gitignore
.iex.exs Use non-deprecated commands helper Jul 27, 2019
LICENSE.md Update README with basic capabilities Mar 15, 2018
PLANNED_VENUES.md Add Huobi, FTX & Deribit venue adapters to in progress README Aug 17, 2019
README.md Release 0.0.31 Aug 18, 2019
mix.exs Release 0.0.31 Aug 18, 2019
mix.lock Use umbrella app to separate the framework from examples Jul 26, 2019
renovate.json Add renovate.json Mar 12, 2019

README.md

Tai

Build Status Coverage Status

A real time market data and trade execution toolkit. Built with Elixir, runs on the Erlang virtual machine

WARNING

tai is alpha quality software. It passes our test suite but the API is highly likely to change and no effort will be made to maintain backwards compatibility at this time. We are working to make tai production quality software.

Tai on GitHub | Install | Usage | Advisors | Configuration | Commands | Logging

What Can I Do? TLDR;

Stream market data to create and manage orders with a near-uniform API across multiple venues

Here's an example of an advisor that logs the spread between multiple products on multiple venues

asciicast

Supported Venues

Venues Live Order Book Account Balance Active Orders Passive Orders Products Fees
BitMEX [x] [x] [x] [x] [x] [x]
OkEx [x] [x] [x] [x] [x] [x]

Venues In Progress

Venue Live Order Book Account Balance Active Orders Passive Orders Products Fees
Binance [x] [x] [ ] [ ] [x] [x]
GDAX [x] [x] [ ] [ ] [x] [x]
Poloniex [x] [x] [ ] [ ] [x] [x]
Huobi [ ] [ ] [ ] [ ] [ ] [ ]
FTX [ ] [ ] [ ] [ ] [ ] [ ]
Deribit [ ] [ ] [ ] [ ] [ ] [ ]

Planned Venues...

Install

tai requires Elixir 1.8+ & Erlang/OTP 21+. Add tai to your list of dependencies in mix.exs

def deps do
  [
    {:tai, "~> 0.0.31"}
  ]
end

Create an .iex.exs file in the root of your project and import the tai helper

# .iex.exs
Application.put_env(:elixir, :ansi_enabled, true)

import Tai.CommandsHelper

Usage

tai runs as an OTP application.

During development we can leverage mix to compile and run our application with an interactive Elixir shell that imports the set of tai helper commands.

iex -S mix

Advisors

Advisors are the brains of any tai application, they subscribe to changes in market data to record and analyze data or execute automated trading strategies.

Orders are created and managed through a uniform API across exchanges, with fast execution and reliability.

Take a look at some of the examples to understand what you can create with advisors.

Configuration

Each environment can have its own configuration. Take a look at the example dev configuration for available options.

Commands

To monitor your advisors, accounts and markets tai provides the following set of IEx commands.

help

Display the available commands and usage examples

iex(1)> help
* balance
* products
* fees
* markets
* orders
* settings
* advisors [where: [...], order: [...]]
* start_advisors [where: [...]]
* stop_advisors [where: [...]]
* enable_send_orders
* disable_send_orders

balance

Display all non-zero balances across configured accounts

iex(2)> balance
+-------+---------+--------+------------+------------+------------+
| Venue | Account | Symbol |       Free |     Locked |    Balance |
+-------+---------+--------+------------+------------+------------+
|  gdax |    main |    btc | 0.30000000 | 0.00000000 | 0.30000000 |
|  gdax |    main |    ltc | 1.80009170 | 1.10000000 | 2.90009170 |
|  gdax |    main |    usd |       0.01 |       0.00 |       0.01 |
+-------+---------+--------+------------+------------+------------+

products

Display the products provided by configured venues

iex(3)> products
+----------+----------+--------------+---------+-----------+-----------+------------+-----------+-----------------+----------+----------+----------------+--------------+
|    Venue |   Symbol | Venue Symbol |  Status | Maker Fee | Taker Fee |  Min Price | Max Price | Price Increment | Min Size | Max Size | Size Increment | Min Notional |
+----------+----------+--------------+---------+-----------+-----------+------------+-----------+-----------------+----------+----------+----------------+--------------+
|     gdax |  btc_usd |      BTC-USD | trading |           |           |       0.01 |           |            0.01 |    0.001 |       70 |          0.001 |      0.00001 |
|  binance | btc_usdt |      BTCUSDT | trading |           |           |     444.36 |  44435.55 |            0.01 | 0.000001 | 10000000 |       0.000001 |           10 |
| poloniex | btc_usdt |     USDT_BTC | trading |           |           | 0.00000001 |    100000 |                 | 0.000001 |          |       0.000001 |            1 |
|     gdax |  ltc_usd |      LTC-USD | trading |           |           |       0.01 |           |            0.01 |      0.1 |     4000 |            0.1 |        0.001 |
| poloniex | ltc_usdt |     USDT_LTC | trading |           |           | 0.00000001 |    100000 |                 | 0.000001 |          |       0.000001 |            1 |
|  binance | ltc_usdt |      LTCUSDT | trading |           |           |       3.32 |    331.85 |            0.01 |  0.00001 | 10000000 |        0.00001 |           10 |
|   bitmex |   xbth19 |       XBTH19 | trading |   -0.025% |    0.075% |            |   1000000 |             0.5 |        1 | 10000000 |            0.5 |              |
|   bitmex |   xbtz18 |       XBTZ18 | trading |   -0.025% |    0.075% |            |   1000000 |             0.5 |        1 | 10000000 |            0.5 |              |
+----------+----------+--------------+---------+-----------+-----------+------------+-----------+-----------------+----------+----------+----------------+--------------+

fees

Display the maker/taker fees for every product from configured venue accounts

iex(4)> fees
+---------+------------+-----------+-------+-------+
|   Venue | Account ID |    Symbol | Maker | Taker |
+---------+------------+-----------+-------+-------+
| binance |       main |   lsk_bnb |  0.1% |  0.1% |
| binance |       main |   rlc_eth |  0.1% |  0.1% |
| binance |       main |  aion_eth |  0.1% |  0.1% |
| binance |       main |   mft_bnb |  0.1% |  0.1% |
| binance |       main |  ardr_bnb |  0.1% |  0.1% |
| binance |       main |  iost_btc |  0.1% |  0.1% |
| binance |       main |   xlm_eth |  0.1% |  0.1% |
| binance |       main |   xem_eth |  0.1% |  0.1% |
| binance |       main |   kmd_btc |  0.1% |  0.1% |
| binance |       main | ncash_btc |  0.1% |  0.1% |
| binance |       main |   xrp_eth |  0.1% |  0.1% |
| binance |       main |   vet_bnb |  0.1% |  0.1% |
+---------+------------+-----------+-------+-------+

markets

Displays the live top of the order book for the configured feeds. It includes the time they were processed locally and if supported, the time they were sent from the venue. This allows you to monitor if a feed is under backpressure and starting to fall behind as it updates it's order books.

iex(5)> markets
+---------+----------+-----------+-----------+------------+--------------+------------------+-----------------------+------------------+-----------------------+
|   Venue |   Symbol | Bid Price | Ask Price |   Bid Size |     Ask Size | Bid Processed At | Bid Server Changed At | Ask Processed At | Ask Server Changed At |
+---------+----------+-----------+-----------+------------+--------------+------------------+-----------------------+------------------+-----------------------+
| binance | btc_usdt |    8430.0 |   8439.91 |   0.349355 |     1.021896 |     1 second ago |          1 second ago |              now |                   now |
| binance | ltc_usdt |    159.53 |    159.58 |   10.54534 |      1.02855 |    9 seconds ago |         9 seconds ago |    4 seconds ago |         4 seconds ago |
| binance | eth_usdt |    519.67 |     520.0 |    0.08984 |      2.33198 |    7 seconds ago |         7 seconds ago |              now |                   now |
|    gdax |  btc_usd |   8430.86 |   8430.87 | 0.01448655 |  24.32791169 |    3 seconds ago |         3 seconds ago |     1 second ago |          1 second ago |
|    gdax |  ltc_usd |    159.97 |    159.98 |    0.00002 | 478.22565196 |   28 seconds ago |        28 seconds ago |              now |                   now |
|    gdax |  eth_usd |    520.93 |    520.94 | 9.48431449 |  79.37008001 |              now |                   now |     1 second ago |         2 seconds ago |
+---------+----------+-----------+-----------+------------+--------------+------------------+-----------------------+------------------+-----------------------+

orders

Displays the list of orders and their details.

As the lifecycle of the order changes it's details will be updated. You can view these changes by running the orders command again.

iex(6)> orders
+--------+---------+--------+------+-------+--------+-----+------------+----------------+---------------+--------+-----------+----------------+----------------+------------------+----------------------+----------------+--------------+
|  Venue | Account | Symbol | Side |  Type |  Price | Qty | Leaves Qty | Cumulative Qty | Time in Force | Status | Client ID | Venue Order ID |    Enqueued At | Last Received At | Last Venue Timestamp |     Updated At | Error Reason |
+--------+---------+--------+------+-------+--------+-----+------------+----------------+---------------+--------+-----------+----------------+----------------+------------------+----------------------+----------------+--------------+
| bitmex |    main | xbtm19 |  buy | limit | 3622.5 |  15 |         15 |              0 |           gtc |   open | 78f616... |      fe7486... | 11 seconds ago |   11 seconds ago |       11 seconds ago | 11 seconds ago |              |
+--------+---------+--------+------+-------+--------+-----+------------+----------------+---------------+--------+-----------+----------------+----------------+------------------+----------------------+----------------+--------------+

settings

Displays the current runtime settings

iex(7)> settings
+-------------+-------+
|        Name | Value |
+-------------+-------+
| send_orders | false |
+-------------+-------+

advisors

List advisors that can optionally be filtered and ordered

iex(8)> advisors where: [status: :unstarted], order: [:group_id]
+---------------------------------+-------------------+-----------+-----+
|                        Group ID |        Advisor ID |    Status | PID |
+---------------------------------+-------------------+-----------+-----+
| create_and_cancel_pending_order |      gdax_btc_usd | unstarted |   - |
|             fill_or_kill_orders |  binance_btc_usdt | unstarted |   - |
|                      log_spread |  binance_btc_usdt | unstarted |   - |
|                      log_spread |      gdax_btc_usd | unstarted |   - |
|                      log_spread | poloniex_btc_usdt | unstarted |   - |
+---------------------------------+-------------------+-----------+-----+

start_advisors

Starts advisors with an optional filter

iex(9)> start_advisors where: [status: :unstarted]
Started advisors: 5 new, 0 already running

stop_advisors

Stops advisors with an optional filter

iex(10)> stop_advisors where: [status: :running]
Stopped advisors: 5 new, 0 already stopped

Logging

tai uses a system wide event bus and forwards these events to the Elixir logger. By default Elixir will use the console logger to print logs to stdout in the main process running tai. You can configure your Elixir logger to format or change the location of the output.

For example. To write to a file, add a file logger:

# mix.exs
defp deps do
  {:logger_file_backend, "~> 0.0.10"}
end

And configure it's log location:

# config/config.exs
use Mix.Config

config :logger, :file_log, path: "./log/#{Mix.env()}.log"
config :logger, backends: [{LoggerFileBackend, :file_log}]

If you intend to deploy tai to a service that ingests structured logs, you will need to use a supported backed. For Google Cloud Stackdriver you can use logger_json

# mix.exs
defp deps do
  {:logger_json, "~> 2.0.1"}
end

# config/config.exs
use Mix.Config

config :logger_json, :backend, metadata: :all
config :logger, backends: [LoggerJSON]

Secrets

Managing secrets is a complex and opinionated topic. We recommend that you avoid compiling application secrets into your OTP release and regularly rotate them. This can be achieved in many different ways, tai has chosen to use confex to manage this workflow. confex provides the ability to read secrets from environment variables or the file system out of the box. It also has the ability to read secrets from your any location you wish via a custom adapter.

Take a look at our example dev configuration which reads secrets from the file system.

Help Wanted :)

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

Authors

License

tai is released under the MIT license

You can’t perform that action at this time.