Git Product home page Git Product logo

crypto-ml-alerts's Introduction

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:

crypto-ml-alerts's People

Contributors

balupton avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

ashleyfulks

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.