Coins Stats

Stats of popular coins + BTC & ETH Dominance
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgements

About The Project

An efficient Telegram-bot for getting the statistics of famous Crypto Currency markets' coins and tokens in Telegram which can be installed easily

Built With

This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• Python 3.6v
• Telegram-Bot Api
• Telethon Framework
• datetime module
• asyncio module
• requests module
• Redis Database
• Coinstats app Api
• CoinMarketCap Api

Getting Started

This is a help for installation.

Prerequisites

• Ubuntu 16.04+ (I prefer 16.04)
• You have to installed Python3.6 because Telethon need Python3.6. so follow helps on google for "install Python3.6 on ubuntu"
• Get an API Key at coinmarketcap.com
• Get API_HASH & API_ID at my.telegram.org
• Get Bot_Token from Botfather
• Get Chat ID from Telegram with forwarding a message to userinfobot from which chat you want to receive the Stats

Installation

1. Clone the repo

   git clone https://github.com/ferisystem/CoinsStats.git

2. Enter your Bot_Token in config.py

   BOT_TOKEN = 'ENTER BOT_TOKEN'

3. Enter your api_hash & api_id in config.py

   API_HASH = 'ENTER API_HASH'
   API_ID = 'ENTER API_ID'

4. Enter your Coinmarketcap API in config.py

   CMP_API_KEY = 'ENTER CoinMarketCap API'

5. Enter your Channel/SuperGroup/Group/Private Telegram ID in config.py

   CHAT_ID = 'ENTER DESTINATION_ID'

6. Enter your Private Telegram ID in config.py for receive Exceptions & Erros

   SUDO_ID = 'ENTER SUDO_ID'

7. Enter Coins & Tokens symbol that you want in config.py > coins_list value

   coins_list = ('coin1', 'coin2' 'token1', 'token2', etc...)

8. Now you have to add this command in crontab -e on ubuntu terminal

   * * * * * python3.6 ./CoinsStats/bot.py

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Dear programmer, you can help me in this project. how? read this text. Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the project
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a pull request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Alireza Fereidouni (Feri) - @ferisystem - alirezafereidouni@proton.me

Project Link: github.com/ferisystem/CoinsStats

Example Bot: @CoinsStats

Acknowledgements

• Ali Najafi
• Iman Seyed