README.md

Samaritan

中文文档

Installation

You can install samaritan from installation package or Docker.

The default username and password are admin, please modify them immediately after login!

From installation package

1. Download the samaritan installation package on this page
2. Unzip the samaritan installation package
3. Enter the extracted samaritan installation directory
4. Run samaritan

Then, samaritan is running at http://localhost:9876.

Linux & Mac user quick start command

wget https://github.com/miaolz123/samaritan/releases/download/v{{VERSION}}/samaritan_{{OS}}_{{ARCH}}.tar.gz
tar -xzvf samaritan_{{OS}}_{{ARCH}}.tar.gz
cd samaritan_{{OS}}_{{ARCH}}
./samaritan

Please replace {{VERSION}}, {{OS}}, {{ARCH}} first.

From Docker

docker run --name=samaritan -p 19876:9876 miaolz123/samaritan

Then, samaritan is running at http://localhost:19876.

Supported exchanges

Exchange	Stock
okcoin.cn	BTC/CNY, LTC/CNY
huobi	BTC/CNY, LTC/CNY
poloniex	ETH/BTC, XMR/BTC, BTC/USDT, LTC/BTC, ETC/BTC, XRP/BTC, ETH/USDT, ETC/ETH, ...
btcc	BTC/CNY, LTC/CNY, LTC/BTC
chbtc	BTC/CNY, LTC/CNY, ETH/CNY, ETC/CNY
okcoin.future	BTC.WEEK/USD, BTC.WEEK2/USD, BTC.MONTH3/USD, LTC.WEEK/USD, ...
oanda.v20	coming soon ......

Usage

Add an Exchange

Add an Algorithm

Deploy an Algorithm

Run a Trader

Algorithm Reference

Read Documentation

Contributing

Contributions are not accepted in principle until the basic infrastructure is complete.

However, the ISSUE is welcome.

License

Copyright (c) 2016 miaolz123 by MIT