Turkish Crypto Exchange Bot
The goal of this Telegram bot is to give the user current price of the cryptocurrencies from Turkish exchanges.
Bot currently supports 2 biggest Turkish exchanges : Paribu and BTCTurk.
Prices are given as Turkish Lira (TRY), Tether (USDT) and BTC pairs (BTC)
Medium article: https://onerince.medium.com/aws-lambda-for-telegram-bots-d02517e1e2f2
📝 Table of Contents
🎥 Demo / Working
🆕 What's New
- July 2019
- Project creation
- March 2021
- Switched to python-telegram-bot library for more optimized performance
- Removed small and closed exchanges
- Added USDT and BTC pairs
- Re-organized response message
- Changed database structure for faster response times
- August 2021
- Deployed to AWS Lambda
- Instead of CMC, now getting coin names from exchange APIs when possible (one less request)
- January 2022
- Now using AWS SAM to deploy Lambda, instead of manually uploading zip file :-)
- Created GitHub Actions Workflows to automatic deployment and tests
💭 How it works
Telegram has a webhook functionality for bots, so every time a message sent to a bot it is possible to process that request information to an external API service. I have used AWS Lambda and AWS API Gateway for this purpose.
🎈 Usage
Verify template file:
sam validate
Build application:
sam build --use-container
Deploy function to your own AWS account or Telegram bot:
sam deploy --guided
🎮 Test
Run Python unit tests
make test
Invoke function locally using sample event (telegram bot message event)
sam local invoke CryptoBotFunction -e events/event.json
Instead of invoking function, you can also run it as an HTTP server. Port is 3000 as default.
sam local start-api --env-vars env.json
You can control your code standards performing static - type checks and formatting code automatically. Run all these tests with;
make ci
Bot is active on @python_koin_bot on Telegram
Prerequisites
1. Installing required packages
To test and use this codebase; AWS SAM, AWS CLI and Docker must be installed. Also, AWS CLI profile must be configured.
For install instructions and detailed guide:
https://aws.amazon.com/tr/serverless/sam/
2. Env Variables
Running unit tests with Python requires env variables in a dotenv file. Example file: .env.dist
To invoke Lambda function locally with sam local, SAM template file need env variables in env.json file. Example file: .env.json.dist
To use this bot, you'll need a Telegram bot Token, and a CoinMarketCap API key to retrieve data from CMC. These variables must exist in environment variables.
🎯 Future Goals
- Output in a more organized way. (like a table)
- Implement an algorithm which detects arbitrage opportunities and notifies user.
- Allow user to set a notification alarm for a specific coin.
🎉 Acknowledgements
- Telegram Bot Doc. - To understand basic bot commands and process
- CoinMarketCap API Doc. - Detailed information to use CMC API
- AWS SAM Reference - SAM Documentation
- AWS Lambda Deployment with Github Actions - Github Action Deployment