commit 6143925ac0eedb5b82887227885d936c8f92edc8 Author: Justin Oros Date: Mon Jan 26 21:16:46 2026 -0700 Alpaca Dashboard diff --git a/README.md b/README.md new file mode 100644 index 0000000..6e80a35 --- /dev/null +++ b/README.md @@ -0,0 +1,181 @@ +# Alpaca Dashboard + +A sleek, mobile-optimized web dashboard for monitoring your Alpaca trading account in real-time. Built with vanilla HTML, CSS, and JavaScript—no frameworks required. + +![Alpaca Dashboard](https://img.shields.io/badge/status-active-success) +![License](https://img.shields.io/badge/license-MIT-blue) + +## Features + +- 📱 **Mobile-First Design** - Optimized for mobile but looks great on desktop too +- 🎨 **Modern UI** - Dark theme with smooth animations and gradient effects +- 🔒 **Secure** - API credentials never leave your browser +- ⚡ **Real-Time Updates** - Auto-refreshes every 30 seconds +- 📊 **Portfolio Overview** - View equity, cash, buying power, and daily P&L at a glance +- 📈 **Position Tracking** - Monitor all positions with profit/loss calculations +- 🔄 **Auto-Detection** - Automatically detects Paper vs Live trading accounts + +## Demo + +![Dashboard Preview](screenshot.png) + +## Getting Started + +### Prerequisites + +- An Alpaca trading account (sign up at [alpaca.markets](https://alpaca.markets)) +- API Key and Secret from your Alpaca account + +### Installation + +1. Clone this repository: +```bash +git clone https://github.com/yourusername/alpaca-dashboard.git +cd alpaca-dashboard +``` + +2. Ensure `alpaca.png` logo file is in the same directory as `alpaca-dashboard.html` + +3. Open `alpaca-dashboard.html` in your web browser + +That's it! No build process, no dependencies to install. + +## Usage + +1. Open `alpaca-dashboard.html` in your web browser +2. Enter your Alpaca API Key and API Secret +3. Click **GO!** to connect to your account +4. View your portfolio data and positions + +The dashboard will automatically: +- Detect whether you're using Paper or Live trading credentials +- Refresh your data every 30 seconds +- Display real-time profit/loss with color-coded indicators + +## Getting Your API Credentials + +1. Log in to your Alpaca account at [app.alpaca.markets](https://app.alpaca.markets) +2. Navigate to **Paper Trading** or **Live Trading** (depending on which you want to use) +3. Go to **Your API Keys** section +4. Generate or view your API Key and Secret Key +5. Copy both values into the dashboard login form + +⚠️ **Security Note**: Keep your API credentials secure. Never share them or commit them to version control. + +## API Endpoints + +The dashboard connects to: +- **Paper Trading**: `https://paper-api.alpaca.markets` +- **Live Trading**: `https://api.alpaca.markets` + +It automatically tries Paper first, then Live, based on your credentials. + +## Displayed Information + +### Account Summary +- **Portfolio Value** - Total equity in your account +- **Cash** - Available cash balance +- **Buying Power** - Amount available for trading +- **Today's P&L** - Profit/loss for the current trading day with percentage + +### Positions Table +- Symbol +- Quantity +- Average Cost +- Current Price +- Market Value +- Unrealized P&L (dollar amount) +- Unrealized P&L (percentage) + +## Browser Compatibility + +Works on all modern browsers: +- ✅ Chrome/Edge (recommended) +- ✅ Firefox +- ✅ Safari +- ✅ Mobile browsers (iOS Safari, Chrome Mobile) + +## Customization + +The dashboard uses CSS variables for easy theming. Edit the `:root` section in the ` + + +
+
+
+ +
+
+
+ Alpaca Logo + +
+
Real-time portfolio monitoring
+
+ + +
+ +
+ + +
+
+ + +
+ +
+ +
+ +

Positions

+
+
+ + + + + + + + + + + + + + + +
SymbolQtyAvg CostCurrent PriceMarket ValueP&LP&L %
+
+
+
+
+ + + +