Dependencies

Make sure these packages are installed before running Speculator:

• Delorean, pip3 install delorean

• requests, pip3 install requests

• NumPy, pip3 install numpy

• TensorFlow, pip3 install tensorflow

• scikit-learn, pip3 install scikit-learn

• pandas, pip3 install pandas

• flask, pip3 install flask

• flask-cache, pip3 install flask-cache

• flask-restful, pip3 install flask-restful

• webargs, pip3 install webargs

Or just use a one-liner:

pip3 install delorean requests numpy tensorflow scikit-learn pandas flask flask-cache flask-restful webargs

API

Web RESTful:

First start the Flask API server with python api.py. Then use HTTP methods like GET: curl http://localhost:5000/api/public/predict -X GET

For a list of valid arguments in the URL, please check back tomorrow (12/20/17).

I plan to start a server for anyone to access this without starting their own Flask server, but with only public access. Starting this on your own server with authentication for users (private access) will allow you to PUT/POST/DELETE your own market data and analyze that instead of the default. This is currently in development and will be extended in the future.

Python:

Speculator is available as a package on PyPi.

pip3 install speculator

If you want to use or thoroughly understand Speculator’s API, I recommend checking out the docs, which features a fully documented example.

Project Structure

LICENSE
README.md

docs
    \_ CONTRIBUTING.md
    \_ analysis.md
    \_ example.md
    \_ example.py
    \_ utils.md

speculator
    \_ api.py
    \_ main.py
    \_ market.py
    \_ features
                \_ obv.py
                \_ rsi.py
                \_ sma.py
                \_ so.py
    \_ models
             \_ deep_neural_network.py
             \_ random_forest.py
    \_ tests
            \_ integration
                          \_ test_poloniex.py
            \_ unit
                   \_ test_date.py
                   \_ test_poloniex.py
                   \_ test_obv.py
                   \_ test_rsi.py
                   \_ test_sma.py
                   \_ test_so.py
                   \_ test_stats.py
    \_ utils
            \_ date.py
            \_ poloniex.py
            \_ stats.py

Contributing

Please read the detailed contributing doc.