Practical overview
When it fits
Use it to explore exchange-market signals or paper-trade supported strategies from a Python CLI. Consider live execution only if you understand the inventory, fee, latency and partial-fill risks and can manage the required exchange configuration.
Who it is for
- Developers seeking a command-line tool to scan cryptocurrency exchange markets.
- Traders evaluating triangular, cross-exchange or spot/perpetual basis strategies in paper mode.
- Python users who can manage exchange credentials, configuration and inventory requirements.
Documented uses
- Scan for three-leg trading cycles on one exchange.
- Compare prices across exchanges where assets are already held at each venue.
- Surface spot/perpetual basis signals and funding APR.
- Estimate opportunities using order-book depth, fees and a slippage buffer.
- Simulate trades in paper mode or, with safeguards enabled, place live orders.
Requirements & limits
The repository is public and MIT-licensed. Python 3.11 or later is required. API keys are optional for scanning public order books; private balance access and live orders require exchange credentials.
- The bot models full order-book depth, taker fees and slippage rather than relying only on top-of-book prices.
- Cross-exchange trading requires capital at both venues; transfers are not part of the bot's trade path.
- Paper trading is the default, and basis execution is off unless enabled.
- Live orders require paper mode to be disabled, the
--liveflag andLIVE_TRADING=1. - The README identifies fees, latency and partial fills as continuing risks; a best-effort unwind may not eliminate residual exposure.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Set up the CLI for scanning
Install the application and run a scan without configuring private exchange credentials.
Before you start
- Python 3.11 or later
- The repository's requirements.txt
Steps
Create and activate a Python virtual environment.
Install dependencies from requirements.txt.
Copy .env.example to .env.
Run the command below; optionally use
--strategy triangular --oncefor a one-time triangular scan.python -m arbitrage scan
Expected outcome
The CLI is set up to scan using public order books, which do not require API keys.
Guide limitations
- This setup guide does not configure private balance access or live trading.
- The README cautions that fees and latency can erase apparent opportunities.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 6 October 2026
- Original website title
- bigmacman1129/crypto-arbitrage · Official homepage title · retained in its source language

