Package Exports
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (hedgequantx) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
HedgeQuantX CLI
Prop Futures Algo Trading CLI
A powerful command-line interface for connecting to prop trading firms and managing your futures trading accounts.
Features
- Multi-platform connection support (ProjectX, Rithmic, Tradovate)
- 19+ supported prop firms via ProjectX
- Real-time account management
- View positions, orders, and account stats
- Secure authentication
Supported Prop Firms (ProjectX)
| Firm | Status |
|---|---|
| Topstep | Active |
| Alpha Futures | Active |
| TickTickTrader | Active |
| Bulenox | Active |
| TradeDay | Active |
| Blusky | Active |
| Goat Futures | Active |
| The Futures Desk | Active |
| DayTraders | Active |
| E8 Futures | Active |
| Blue Guardian Futures | Active |
| FuturesElite | Active |
| FXIFY | Active |
| Hola Prime | Active |
| Top One Futures | Active |
| Funding Futures | Active |
| TX3 Funding | Active |
| Lucid Trading | Active |
| Tradeify | Active |
| Earn2Trade | Coming Soon |
Installation
Prerequisites
- Node.js >= 16.x
- npm >= 8.x
Option 1: Install from GitHub
npm install -g github:HedgeQuantX/HQX-CLIOption 2: Clone and Install (Recommended)
git clone https://github.com/HedgeQuantX/HQX-CLI.git
cd HQX-CLI
npm install
npm linkUpdate
To update the CLI to the latest version:
cd ~/HQX-CLI && git pullThat's it! Changes are applied immediately. No need to reinstall.
Option 3: Download and Install
# Download the package
curl -L -o hedgequantx.tgz https://github.com/HedgeQuantX/HQX-CLI/releases/latest/download/hedgequantx-1.0.0.tgz
# Install globally
npm install -g hedgequantx.tgzUsage
Launch the CLI
hedgequantxCLI Commands
hedgequantx --version # Show version
hedgequantx --help # Show help
hedgequantx status # Show system statusQuick Start
Launch the CLI
hedgequantx
Select your connection
- ProjectX
- Rithmic (coming soon)
- Tradovate (coming soon)
Choose your prop firm
- Select from the list of supported firms
Login with your credentials
- Enter your username
- Enter your password
Access your dashboard
- View Accounts
- View Positions
- View Orders
- User Info
Screenshots
██╗ ██╗███████╗██████╗ ██████╗ ███████╗ ██████╗ ██╗ ██╗ █████╗ ███╗ ██╗████████╗██╗ ██╗
██║ ██║██╔════╝██╔══██╗██╔════╝ ██╔════╝██╔═══██╗██║ ██║██╔══██╗████╗ ██║╚══██╔══╝╚██╗██╔╝
███████║█████╗ ██║ ██║██║ ███╗█████╗ ██║ ██║██║ ██║███████║██╔██╗ ██║ ██║ ╚███╔╝
██╔══██║██╔══╝ ██║ ██║██║ ██║██╔══╝ ██║▄▄ ██║██║ ██║██╔══██║██║╚██╗██║ ██║ ██╔██╗
██║ ██║███████╗██████╔╝╚██████╔╝███████╗╚██████╔╝╚██████╔╝██║ ██║██║ ╚████║ ██║ ██╔╝ ██╗
╚═╝ ╚═╝╚══════╝╚═════╝ ╚═════╝ ╚══════╝ ╚══▀▀═╝ ╚═════╝ ╚═╝ ╚═╝╚═╝ ╚═══╝ ╚═╝ ╚═╝ ╚═╝
────────────────────────────────────────────────────────────────────────────────────────────
Prop Futures Algo Trading
────────────────────────────────────────────────────────────────────────────────────────────
? Choose Your Connection:
❯ ProjectX
Rithmic
Tradovate
──────────────
ExitProject Structure
HQX-CLI/
├── bin/
│ └── cli.js # Main CLI entry point
├── src/
│ ├── api/
│ │ ├── projectx_userapi.json # ProjectX User API spec
│ │ └── projectx_gatewayapi.json # ProjectX Gateway API spec
│ └── services/
│ └── projectx.js # ProjectX API service
├── package.json
├── claude.md # Development rules
└── README.mdAPI Documentation
ProjectX APIs
UserAPI: Authentication, account management, stats, trades
- Host:
userapi.[propfirm].projectx.com
- Host:
GatewayAPI: Trading operations (orders, positions)
- Host:
api.[propfirm].projectx.com
- Host:
Development
Run in development mode
cd HQX-CLI
npm run devRun tests
npm testRoadmap
- ProjectX integration
- Multi-propfirm support
- Account viewing
- Position viewing
- Order viewing
- Rithmic integration
- Tradovate integration
- Algo trading engine
- Real-time market data
- Order placement
- Strategy builder
Contributing
Contributions are welcome! Please read our contributing guidelines before submitting a PR.
License
MIT License - see LICENSE for details.
Disclaimer
This software is for educational and informational purposes only. Trading futures involves substantial risk of loss and is not suitable for all investors. Past performance is not indicative of future results.
Support
- GitHub Issues: https://github.com/HedgeQuantX/HQX-CLI/issues
- Email: marat.himet@gmail.com
Made with passion by HedgeQuantX