Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kenmwaura1/py-crypto-bot
simple python crypto bot to trade crypto on Binance based on RSI. Utilizing web sockets to get real-time prices. Store the data in a Redis instance then a Postgres DB on candle close
https://github.com/kenmwaura1/py-crypto-bot
binance-api bot crypto postgresql python redis websockets
Last synced: 25 days ago
JSON representation
simple python crypto bot to trade crypto on Binance based on RSI. Utilizing web sockets to get real-time prices. Store the data in a Redis instance then a Postgres DB on candle close
- Host: GitHub
- URL: https://github.com/kenmwaura1/py-crypto-bot
- Owner: KenMwaura1
- License: mit
- Created: 2021-12-07T21:47:41.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-27T09:39:19.000Z (12 months ago)
- Last Synced: 2024-01-27T12:04:14.118Z (12 months ago)
- Topics: binance-api, bot, crypto, postgresql, python, redis, websockets
- Language: Python
- Homepage:
- Size: 208 KB
- Stars: 31
- Watchers: 3
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://github.com/KenMwaura1/py-crypto-bot/actions/workflows/python-app.yml)
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
Py Crypto Bot
Using Binance WebSocket API to get real-time price data for cryptocurrencies. Store the data in a Postgres DB on candle close. Using the TA-Lib library to calculate the RSI and execute buy/sell orders.
Currently supported pairs are ETH/USDT and BTC/USDT.
Table of Contents
## About The Project
[Link to accompanying article](https://dev.to/ken_mwaura1/crypto-data-bot-using-python-binance-websockets-and-postgresql-db-5fnd) :pencil2:
### Sample image of data stored in DB
### Built With
* [Python 3.8+](https://www.python.org/downloads/)
* [Binance WebSocket API](https://github.com/binance/binance-spot-api-docs/blob/master/web-socket-streams.md#klinecandlestick-streams)
* [TA-Lib](https://mrjbq7.github.io/ta-lib/)
## Getting Started
To get started, you'll need to install the following:
### Prerequisites
This is an example of how to list things you need to use the software and how to install them.
* [Python 3.7+](https://www.python.org/downloads/)
* Postgresql Database.
* This could either be installed [locally](https://www.postgresql.org/) or via [docker](https://www.docker.com/).
This [article](https://blog.crunchydata.com/blog/easy-postgresql-12-and-pgadmin-4-setup-with-docker) is an awesome resource on how to get Postgresql and pgadmin4 installed as containers.
Create a database `price_data`. Either using SQL or 3-party client like pgadmin4 or [dbeaver](https://dbeaver.io/)
### Installation
1. Get a free API Key at [Binance](https://www.binance.com).
2. Clone the repo
```sh
git clone https://github.com/KenMwaura1/py-crypto-bot.git
```
3. Create a virtual environment
```sh
python -m venv venv
```
4. Activate the virtual environment
```sh
source venv/bin/activate
```
5. Install the dependencies
```sh
pip install -r requirements.txt
```
6. Add your credentials to a .env file
```sh
echo "BINANCE_API_KEY=" >> .env
echo "BINANCE_API_SECRET=" >> .env
```
OR
Copy the provided example file to your .env file
```sh
cp .env.example .env
```
7. Run the bot
```sh
python bot.py
```
See the [open issues](https://github.com/KenMwaura1/py-crypto-bot/issues) for a full list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
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.txt` for more information.
## Contact
[@Ken_Mwaura1](https://twitter.com/Ken_Mwaura1) -
Project Link: [https://github.com/KenMwaura1/py-crypto-bot](https://github.com/KenMwaura1/py-crypto-bot)
[contributors-shield]: https://img.shields.io/github/contributors/KenMwaura1/py-crypto-bot.svg?style=for-the-badge
[contributors-url]: https://github.com/KenMwaura1/py-crypto-bot/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/KenMwaura1/py-crypto-bot.svg?style=for-the-badge
[forks-url]: https://github.com/KenMwaura1/py-crypto-bot/network/members
[stars-shield]: https://img.shields.io/github/stars/KenMwaura1/py-crypto-bot.svg?style=for-the-badge
[stars-url]: https://github.com/KenMwaura1/py-crypto-bot/stargazers
[issues-shield]: https://img.shields.io/github/issues/KenMwaura1/py-crypto-bot.svg?style=for-the-badge
[issues-url]: https://github.com/KenMwaura1/py-crypto-bot/issues
[license-shield]: https://img.shields.io/github/license/KenMwaura1/py-crypto-bot.svg?style=for-the-badge
[license-url]: https://github.com/KenMwaura1/py-crypto-bot/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/kennedy-mwaura/