Git Product home page Git Product logo

cryptotelegrambot's Introduction

CRYPTO-TELEGRAM-BOT

Table of Contents
  1. Getting Started
  2. Usage

Getting started

Minimum requirements:

  • Git
  • Golang
  • Telegram
  • Computer/server to host the app

Add bot to your Telegram Channel

Open @BotFather on telegram and create a new bot with it's /newbot command.

Assign it a name. This name won't be the one that is shown on each message, so you can name it whatever you want.

@BotFather will grant you a Token. This token is the one that will replace the REPLACE_WITH_TOKEN on the .env.example file on this repository. (Don't forget to rename that file to .env)

You can use the /setcommands to define the uses your bot has on the '/' icon:

price - Use price <symbol> . Gets symbol actual price. Default BTCEUR
historic - Use historic <symbol> . Gets a percentage between Today's and Yesterday's price. Default BTCEUR
summary - Use summary <symbol> . Gets both the price and historic values. Default BTCEUR
notification - Use add <symbol> <compare> <value>| remove <symbol> <compare> <value> | list . Get notified if the symbol es higher > or lower <

Installation

Open a Terminal and copy these commands (Linux & Mac devices):

cd ~
git clone https://github.com/miseas/CryptoTelegramBot.git
cd ./CryptoTelegramBot
cp .env.example .env
go get cryptoTelegramBot
go run main.go
Warning:

You must replace the REPLACE_WITH_TOKEN on the .env file with the Token granted by @BotFather

Usage

Once the bot is running, you can add it to a Telegram group and use any of the following commands:

    * /price: Use price <symbol> . Gets symbol actual price. Default BTCEUR
    * /historic: Use historic <symbol> . Gets a percentage between Today's and Yesterday's price. Default BTCEUR
    * /summary: Use summary <symbol> . Gets both the price and historic values. Default BTCEUR
    * /notification [add/remove/list] [a_symbol] [a_compare_symbol] [a_value]: . Get notified if the symbol es higher > or lower <

About Notifications

Notifications are still a WIP. You can add/remove or list your notifications. The notifications are checked every 1 min (or custom). After notified 3 times, it will be removed automatically from the list.

Exchanges supported

(more will be added):

  • Binance

cryptotelegrambot's People

Stargazers

 avatar

Watchers

 avatar

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.