Minimal library for detecting flash crashes in cryptocurrency prices on Bitfinex
Project description
flashcrashed
Minimal library for detecting flash crashes in cryptocurrency prices on Bitfinex
Free software: GNU General Public License v3
Documentation: https://flashcrashed.readthedocs.io.
Features
CLI for monitoring cryptocurrency prices for flash crashes
CLI for testing performance of a flash crash detector
Configurable flash crash detector for custom price monitoring
Installation
To install flashcrashed, do:
pip install flashcrashed
Basic Usage
To use flashcrashed, do:
flashcrashed <BITFINEX_KEY> <BITFINEX_SECRET>
To test the performance of a detector, do:
flashtest
The default detector used is the detector.SimpleDetector. To use your own:
# my_detector.py
from flashcrashed.detector import Detector
class CustomDetector(Detector):
def predict(self, price):
# Return: 0 - BUY, 1 - HOLD (do nothing), 2 - SELL
return 1
To test its performance:
flashtest --detector my_detector.CustomDetector
To run flashcrashed with custom detector:
flashcrashed --detector my_detector.CustomDetector
Credits
This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.
History
0.1.0 (2018-05-25)
First release on PyPI.
0.1.1 (2018-06-04)
Updated README
0.1.2 (2018-06-04)
Fix rendering of docs
0.1.2 (2018-06-04)
Updated project description
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for flashcrashed-0.1.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 48cc18c0d37fe2889f9664fe0c20bd46bad6cb70783faf10b53dab4a237ffb0f |
|
MD5 | a5ddcedf6699acf18251a30f4cabbb74 |
|
BLAKE2b-256 | 65e3acc8f2595f55f70b37b9cbc1650d7a4f95cab59bdf608e2b0380e6b668b7 |