Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aegeontis/volatenium
Simple algorithm-based python crypto trader
https://github.com/aegeontis/volatenium
Last synced: 26 days ago
JSON representation
Simple algorithm-based python crypto trader
- Host: GitHub
- URL: https://github.com/aegeontis/volatenium
- Owner: Aegeontis
- License: agpl-3.0
- Created: 2024-11-03T15:47:27.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-11T15:46:05.000Z (about 1 month ago)
- Last Synced: 2024-11-11T16:36:51.613Z (about 1 month ago)
- Language: Python
- Homepage:
- Size: 42 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Volatenium
A simple algorithm-based python crypto trader
## Installation
1. Download the repo with either:
* git:
1. `git clone https://github.com/Aegeontis/Volatenium.git`
2. `cd Volatenium`
* as zip:
1. Download https://github.com/Aegeontis/Volatenium/archive/refs/heads/main.zip
2. `unzip Volatenium-main.zip`
3. `cd Volatenium-main`
2. Initiate a python venv: `python -m venv venv`
3. Enter the python venv: `source venv/bin/activate`
4. Install requirements: `pip install -r requirements.txt`
5. Create a settings.yaml file. **MAKE SURE each algorithm has a UNIQUE id**. Example below:
```
general_settings:
action_interval: 60.0
exchanges:
Simulator:
exchange_settings:
algorithms:
- id: 0
codename: "SafeTrade"
algorithm_vars:
wallet_crypto_amount: 0.0
wallet_fiat_amount: 100.0
exchange_vars:
crypto_codename: "BTC-EUR"
exchange_fee: 0.0001
wallet_crypto_amount: 0.0
wallet_fiat_amount: 100.0
- id: 1
codename: "SafeTrade"
algorithm_vars:
wallet_crypto_amount: 0.0
wallet_fiat_amount: 100.0
exchange_vars:
crypto_codename: "ETH-EUR"
exchange_fee: 0.0001
wallet_crypto_amount: 0.0
wallet_fiat_amount: 100.0
```
## Usage
##### Normal usage
1. Enter the python venv: `source venv/bin/activate`
2. Start the script: `python main.py`
##### Generate graph
1. Enter the python venv: `source venv/bin/activate`
2. Start the script: `python main.py --generate-graph`