Skip to content

bevry-trading/crypto-ml-alerts

Repository files navigation

crypto-ml-alerts

Travis CI Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
Patreon donate button Open Collective donate button Flattr donate button PayPal donate button Bitcoin donate button Wishlist browse button
Slack community badge

Fetch the alerts from https://crypto-ml.com

Install

NPM

  • Install: npm install --global crypto-ml-alerts
  • Executable: crypto-ml-alerts

This package is published with the following editions:

  • crypto-ml-alerts aliases crypto-ml-alerts/source/index.js
  • crypto-ml-alerts/source/index.js is Source + ESNext + Require

Older environments may need Babel's Polyfill or something similar.

Usage

Once installed, run it via the command line like so:

env TZ=Etc/UTC CRYPTO_ML_USERNAME=USERNAME CRYPTO_ML_PASSWORD=PASSWORD crypto-ml-alerts

This will then return an array where each entry has the following properties:

  • when - today, yesterday, or previous
  • date - YYYY-MM-DD
  • currency - the cryptocurrency code
  • action - SELL, HOLD, or BUY
  • price - the price at the time of the alert

You can watch what it is doing by setting CRYPTO_ML_DEBUG=true, like so:

env TZ=Etc/UTC CRYPTO_ML_DEBUG=true CRYPTO_ML_USERNAME=USERNAME CRYPTO_ML_PASSWORD=PASSWORD crypto-ml-alerts

You can also use it programatically via:

'use strict'

const fetch = require('crypto-ml-alerts')

async function main () {
    try {
        const signals = await fetch()
        console.log(JSON.stringify(signals, null, '  '))
    }
    catch (e) {
        console.error(e)
        process.exit(-1)
    }
}

main()

History

Discover the release history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

No maintainers yet! Will you be the first?

Sponsors

No sponsors yet! Will you be the first?

Patreon donate button Open Collective donate button Flattr donate button PayPal donate button Bitcoin donate button Wishlist browse button

Contributors

These amazing people have contributed code to this project:

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

License

Unless stated otherwise all works are:

  • Copyright © 2018+ Benjamin Lupton

and licensed under: