README.md

Arbitoid

Cryptocurrency arbitrage with data retrieval through api and as a telegram bot with built-in admin panel.

---

Project Status

Completed ✓

---

Functionality

• CRUD operations on users via FastAPI + SQLAlchemy ORM
• CoinGeckoAPI class of interaction with the API of one of the blockchain mirrors, as well as the calculation of the largest spread based on market data.
• ArbitoidAPI class implements the bridge function between the FastAPI application and the end user, as well as calculating the financial benefit of arbitrating the asset.
• DatabaseConnector class that implements both client and admin logic for interacting with the user table
• TelegramBot class that implements the main user interaction with the API, as well as a convenient admin panel

Technologies and Frameworks

• Python 3.11
• FastAPI
• SQLAlchemy
• Aiogram
• PostgreSQL

---

Installation

1. Clone the repository to the local machine

   git clone https://github.com/Segfaul/arbitoid.git

2. Go to the repository directory

   cd arbitoid

3. Create and activate a virtual environment

   python -m venv env
   source env/bin/activate

4. Set project dependencies

   pip install -r requirements.txt

5. Configure the configuration file cfg.json

   nano cfg.json

6. Run the FastAPI app in the background

   uvicorn api:app --reload --log-level error

7. Run the business logic in the background

   python __init__.py &

8. Run the global parser in the background

   python global_parser.py &

9. In case of a problem, the program will stop automatically or you can stop execution using

   ps aux | grep ".py"
   kill PID

10. Also you can build a docker app and run the container

    docker build -t app .
    docker run -d app

---