Skip to content

Crypto Watchdog periodically queries crypto market and reports potential pumps via webhooks

License

Notifications You must be signed in to change notification settings

suleymancelikel/crypto-watchdog

 
 

Repository files navigation

bg


CI

Crypto Watchdog is a free crypto market observer.

Finds new listed coins every hour and Queries first 200 coins/tokens every 45 minutes & returns the ones increased or decreased more than %10 in an hour & notifies google chat room & Slack Channel & Telegram or your services.

Environment Variables 🌐

Name Mandatory Description
CMC_PRO_API_KEY False Enables coinmarketcap queries.
BITQUERY_API_KEY False Enables bitquery queries. Returns new listed coins.
GOOGLE_CHAT_ROOM_HOOK True Notifies Google chat room. Enables Google chat notifications.
SLACK_CHANNEL_HOOK False Notifies Slack channel. Enables Slack Channel notifications.
TELEGRAM_CHANNEL_HOOK False Notifies Telegram channel. Enables Telegram Channel notifications.
CUSTOM_CHANNEL_HOOK False Feeds provided rest endpoint. Enables Custom notifications.
HOURLY_PERCENTAGE False Used to filter price increase percentage in an hour, default is 10%.
DAILY_PERCENTAGE False Used to filter price increase percentage in a day, inactive if not defined.
COIN_GECKO_PAGE_LIMIT False Used to change number of pages to query, default is 2. min: 1 max:28.

  • Api token (CMC_PRO_API_KEY) can be obtained from https://coinmarketcap.com/api/ . (I am using Free version)
  • Api token (BITQUERY_API_KEY) can be obtained from https://graphql.bitquery.io/ide . (I am using Developer (free) version)
  • Provide at least one HOOK to get notified.
  • Features activated by passed environment varibles. You can have all features together or individually.
  • Checkout Integration Document for custom hook integration.

Quickstart 🚀

Quickstart without cloning the repoistory.

  • Add your environment variables to the following command.

Docker (Alternative 1)

$ docker run -d --env CMC_PRO_API_KEY=<YOUR_KEY> --env GOOGLE_CHAT_ROOM_HOOK=<YOUR_HOOK> --env SLACK_CHANNEL_HOOK=<YOUR_HOOK> --env HOURLY_PERCENTAGE=12 hhaluk/crypto-watchdog

All set. ✅

Kubernetes (Alternative 2)

  • Copy standard-deployment.yaml on your machine & place your environment variables if required. (otherwise remove unused name/value pairs)
$ kubectl apply -f standard-deployment.yaml

All set. ✅

Upcoming 🚧

  • Discord Webhook
  • New Coin Listings

Development 🛠️

  • Clone the repository
  • Create an .env file under the root directory & place your Environment Varibles inside the .env. ⚠️
$ npm i
$ npm run start:debug

References

Licence

About

Crypto Watchdog periodically queries crypto market and reports potential pumps via webhooks

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 95.5%
  • JavaScript 2.3%
  • Dockerfile 1.9%
  • Shell 0.3%