Skip to content

Revise README for calculate_avellaneda_parameters usage #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Icare2000 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Revise README for calculate_avellaneda_parameters usage #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@ pip install -r requirements.txt
python data_collector.py # Collect real-time market data (check variable `LIST_MARKETS` to add or remove markets)

# run calculation of parameters
python calculate_avellaneda_parameters.py --symbol BNBUSDT --minutes 5 # Calculate dynamic spreads on BNBUSDT based on 5-minutes data chuncks (orders executed, bid-ask spreads)
python calculate_avellaneda_parameters.py BNB --minutes 5 # Calculate dynamic spreads on BNBUSDT based on 5-minutes data chuncks (orders executed, bid-ask spreads)
OR for ETH
python calculate_avellaneda_parameters.py ETH --minutes 5 # Calculate dynamic spreads on BNBUSDT based on 5-minutes data chuncks (orders executed, bid-ask spreads)
python find_trend.py --symbol BNBUSDT --interval 5m # Trend direction determination with SuperTrend based on 5-minutes kline candles

# the above scripts do not need API credentials, but the market_maker.py does need it
Expand Down Expand Up @@ -140,7 +142,7 @@ python market_maker.py --symbol BNBUSDT # Start with specific symbol

# Data collection and analysis
python data_collector.py # Collect real-time market data
python calculate_avellaneda_parameters.py --symbol BNBUSDT # Calculate dynamic spreads (needs enough data collected)
python calculate_avellaneda_parameters.py BNB # Calculate dynamic spreads (needs enough data collected)
python find_trend.py --symbol BNBUSDT --interval 5m # Trend analysis with SuperTrend

# Monitoring and utilities
Expand Down