Skip to content


Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time

Quant Reseach

This repo serves as a quickstart guide for using using Augmento sentiment data, as well as a working repo for analysing the data and developing example strategies.

Augmento API docs:

Bitmex API docs:

Getting started


python 2.7 or later

Install requirements

pip install -r requirements.txt --user
zlib (already included with MacOS)

Run tests

python -m unittest discover -v



The quickstart examples are the quickest way to download some data, plot the data, and run a simple strategy.

Cache two years of Augmento data from the Augmento ReST API to a local folder

python examples/

Cache a list of sources, coins, bin sizes, and topics from the Augmento ReST API to a local folder

python examples/

Cache two years of XBt candle data from the Bitmex ReST API to a local folder (this may take a few minutes)

python examples/

Plot some of the cached raw Augmento data against the cached Bitmex XBt price data

python examples/

Backtest a very simple strategy using Augmento data against the Bitmex XBt price, and plot the results

python examples/