Skip to main content

Service that collects cryptocurrencies price data, fires alerts based on price sentiment and performs automatic trading. It includes Restful API and lite website showing functionality.

Project description

XTCryptoSignals

XTCryptoSignals is a Python library that includes the following services:

Ticker

  • Data collection of crypto-currencies pairs such as BTC/USDT, ETH/BTC or any other pair that is supported by the Exchange API
  • A Signals service based on setup rules to send real-time alerts about price, price change, trading volume or market sentiment through E-mail or Push Notifications to the browser or mobile app
  • Automatic trading

RESTFul Server API

  • Restful interface that exposes API entry points to get desired crypto-currencies data.
  • SocketIO Server to broadcast real-time data to clients.

Website

  • Website to show some of the platform functionalities.

Roadmap

  • Add crypto-currencies exchanges (Dec 2018)
  • Implement RESTFul API and socket.io to access price data in real time (Jan 2019)
  • Build website to use this platform (From Jan 2019)
  • Add Gunicorn to make it production ready (March 2019)
  • Building Unit, functional and end-to-end testing for existing and future features (From Jan 2019)
  • Setup notification rules for price range, price change, trading volume, price sentiment (Apr-July 2019)
  • Implement e-mail and web browser push notifications signals (Aug 2019)
  • Integrate platform with Docker and Docker Compose (Aug 2019)
  • Build iOS app (Sep-Oct 2019)
  • Implement automatic trading (Nov-Dec 2019)

Getting Started

Pre-requisites

Installation

Install from source

Clone project repository

hg clone ssh://hg@bitbucket.org/pantunes/xtcryptosignals
cd xtcryptosignals

Setup Python virtual environment:

virtualenv venv -p python3
source venv/bin/activate

Install package in develop mode:

pip install -e .

(Dependencies will be installed automatically from requirements.txt)

Running tests

python setup.py test

Install from PyPi

Create folder project:

mkdir xtcryptosignals
cd xtcryptosignals

Setup Python virtual environment:

virtualenv venv -p python3
source venv/bin/activate

Install package:

pip install xtcryptosignals

Ticker

Start service

xt-ticker

Run without Celery (for testing purposes):

xt-ticker --testing

To get a list of supported exchanges:

xt-ticker --list-config exchanges
binance
uphold
okex
idex
switcheo
hotbit
bibox
okcoin
bithumb
coinbene
dcoin
bitmax
bilaxy

(Drop me an e-mail if you want support for a new exchange or contribute to this project creating a pull request)

Command line help

xt-ticker --help
Usage: xt-ticker [OPTIONS]

  Use this tool to collect data from configured coins or/and tokens from
  configured crypto-currencies exchanges.

Options:
  --testing                       Execute 1 iteration for all configured coins
                                  and/or tokens without Celery. (Useful for
                                  testing purposes)
  --list-config [exchanges|currencies]
                                  List 'exchanges' or 'currencies' (coins or
                                  tokens) per exchange that the tool currently
                                  supports.
  --enable-messaging              Enable real-time crypto data message broadcasting.
  --log-minimal                   Only log errors and important warnings in
                                  stdout.
  --version                       Show version.
  -h, --help                      Show this message and exit.

Setup

There is already an initial setup with some crypto-currencies (coins and tokens) that can be added or/and removed in settings_exchanges.py.

BIBOX: {
    'pairs': [
        ('ONT', 'USDT'),
        ('ONT', 'BTC'),
        ('ONT', 'ETH'),
        ('NEO', 'USDT'),
        ('NEO', 'BTC'),
        ('NEO', 'ETH'),
        ('LTC', 'USDT'),
        ('LTC', 'BTC'),
        ('CARD', 'ETH'),
    ]
}

UPHOLD: {
    'pairs': [
        ('BTC', 'USD'),
        ('ETH', 'USD'),
        ('LTC', 'USD'),
        ('XRP', 'USD'),
    ]
}

Initial setup to create dynamic MongoDB collections for data segmentation categorized by Exchanges pooling frequency in settings.py.

HISTORY_FREQUENCY = (
    '10s', '30s', '1m', '10m', '30m', '1h', '2h', '3h', '4h', '12h', '1d', '4d', 
    '1w', '2w', '4w', '12w', '24w', '1y',
)

Results

The Ticker service uses multi-processing as it can take advantage of a multi-core CPU.
It takes around 6 seconds to collect data of 70 crypto-currencies symbols pairs from 7 exchanges and save it in 11 collections in MongoDB.
(This performance figure mainly depends on used hardware as CPU cores and Internet connection / latency)

RESTFul Server API

Start service

Development:

xt-server --enable-messaging

Production:

DEBUG=0 xt-server --enable-messaging

Website

Start service

Development:

xt-client

Production:

# if using default settings
SERVER_API_BASE_URL=http://127.0.0.1:5000 xt-client --gunicorn

SERVER_API_BASE_URL should contain the public address where xt-server was started.

or

# start all services, xt-all --help
xt-all

# start only client
xt-client

# start only server
xt-server

# start only ticker
xt-ticker

Open the browser with the URL http://127.0.0.1:8000

alt text

10 seconds ticker page in the URL http://127.0.0.1:8000/ticker/10s

alt text

Displaying Tickers menu

alt text

Displaying Pairs menu

alt text

10 seconds ticker page for Bitcoin in the URL http://127.0.0.1:8000/ticker/BTCUSDT/10s

alt text

Disclaimer

This project is work in progress and when it comes to trading use it at your own risk.

License

GNU

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

XTCryptoSignals-0.1.3.1.tar.gz (1.2 MB view hashes)

Uploaded Source

Built Distribution

XTCryptoSignals-0.1.3.1-py3-none-any.whl (1.2 MB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page