Back to packageRELEASE DETAILS

1.0.1

npm

@0xshibu/crypto-price-alert

Published19 Mar 2024

Direct dependencies2

Transitive dependenciesNot calculated

README

Current package documentation

Cryptocurrency Price Alert Script

The Cryptocurrency Price Alert script is a Node.js utility designed to monitor the price of a specified cryptocurrency and notify the user when the price crosses predefined upper or lower thresholds. This real-time monitoring tool helps users stay informed about significant price movements without the need to constantly check online exchanges or market data platforms.

Features

Real-time Price Monitoring: Automatically fetches the latest cryptocurrency price every 30 seconds.
Desktop Notifications: Sends a desktop notification when the price crosses the user-defined thresholds.
Customizable Thresholds: Users can set their own upper and lower price limits for alerts.
Supports Multiple Cryptocurrencies: Easily modified to monitor different cryptocurrencies available on the CoinGecko API.

Prerequisites

Before you can run this script, ensure you have the following installed:

Node.js (v14 or newer recommended)
npm (Node Package Manager)

Installation

Clone the repository or download the source code to your local machine.

git clone https://github.com/0xshibu/Crypto-Price-Alert.git
cd Crypto-Price-Alert

Install dependencies by running the following command in your project directory:
```
npm install
```

Configuration

To use the script, you need to specify the cryptocurrency you want to monitor and the upper and lower price thresholds for alerts. These can be set directly in the script or passed as command-line arguments (if you implement this functionality).

Usage

Start the script by running:
```
node cryptoPriceAlert.js
```
Monitor the console for real-time price updates and alerts.
Adjust thresholds as needed by editing the script or implementing a method to accept user inputs.

Customization

To monitor a different cryptocurrency or change the frequency of price checks:

Edit the coinId variable for different cryptocurrencies.
Modify the setInterval duration for different update frequencies.

Dependencies

node-fetch: Used to make HTTP requests to the CoinGecko API for price data.
node-notifier: Used for sending desktop notifications when price thresholds are crossed.

Contributing

Contributions to the Cryptocurrency Price Alert script are welcome! Whether it's feature suggestions, bug reports, or code contributions, please feel free to make a pull request or open an issue.

License

MIT License

Disclaimer

This script is provided as-is for educational purposes only. Please use responsibly and at your own risk.

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 2

Native requirements

2 direct targetsNot calculated transitive count

Package / target	Requirement	Relationship
node-fetch Environment { "local_name": "node-fetch", "alias": false, "peer_metadata": null }	`^3.3.2`	runtime
node-notifier Environment { "local_name": "node-notifier", "alias": false, "peer_metadata": null }	`^10.0.1`	runtime

Distribution files

1 collected

Distribution 1

Source distribution

Source file

Checksums from source

{
  "integrity": "sha512-KoM3fx9pWiKFHwYSAJNtWwGtICnw7jikJZiDIXSyLR+LyvwppW0wmP2jBPhAKlSjU3Zr51IgEsnqn50ambQG1Q==",
  "shasum": "b13f14ff0c62272c166cedb938ac2a0860d8116d",
  "tarball": "https://registry.npmjs.org/@0xshibu/crypto-price-alert/-/crypto-price-alert-1.0.1.tgz",
  "fileCount": 4,
  "unpackedSize": 5292,
  "signatures": [
    {
      "keyid": "SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA",
      "sig": "MEUCIDUspoKECwUYT7em9HAVzx94T4H26kFuz3Ixj5lVVTAKAiEAut+2TT00c8HylUhVYEJeQljrmalSPZYxHwAsejsmLlM="
    }
  ]
}

Repository

PENDING

0xshibu/crypto-price-alert

Shared repository data · GitHub

License detected in repository: Not collected

Metadata history

Meaningful changes

Current collected state Current

Observed since 21 Oct, 11:27 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package_version:ad53fabdbe0c090c7d5bfea780190157bc36571d6fd4609d07656cce9b4608cb

Other collected versions

View all collected versions →