1.0.0 • Published 6 years ago

crypto-ml-alerts v1.0.0

Weekly downloads
3
License
MIT
Repository
github
Last release
6 years ago

Fetch the alerts from crypto-ml.com

NPM

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()

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

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

No maintainers yet! Will you be the first?

No sponsors yet! Will you be the first?

These amazing people have contributed code to this project:

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

Unless stated otherwise all works are:

and licensed under: