Files
alpaca-dashboard/README.md
T

75 lines
1.7 KiB
Markdown
Raw Normal View History

2026-01-26 21:16:46 -07:00
# Alpaca Dashboard
2026-01-30 06:54:14 -07:00
A web dashboard for monitoring your Alpaca trading account in real-time.
2026-01-28 15:52:52 -07:00
2026-01-28 17:00:59 -07:00
![Dashboard Preview](screenshot.png)
2026-01-26 21:16:46 -07:00
## Features
2026-01-28 15:52:52 -07:00
- 📱 Mobile-first responsive design
- 🎨 Modern dark theme with smooth animations
- 🔒 Secure - credentials never leave your browser
- ⚡ Auto-refreshes every 30 seconds
- 📊 Real-time portfolio metrics (equity, cash, buying power, daily P&L)
- 📈 Live position tracking with profit/loss
2026-01-26 21:16:46 -07:00
2026-01-28 15:52:52 -07:00
## Quick Start
2026-01-26 21:16:46 -07:00
2026-01-28 15:52:52 -07:00
### Live Demo
Access the dashboard at: [https://justinoros.github.io/alpaca-dashboard](https://justinoros.github.io/alpaca-dashboard)
2026-01-26 21:16:46 -07:00
2026-01-28 15:52:52 -07:00
### Local Setup
1. Clone the repository
2. Open `index.html` in your browser
3. Enter your Alpaca API credentials
4. Select Paper or Live trading
5. Click **GO!**
2026-01-26 21:16:46 -07:00
2026-01-28 15:52:52 -07:00
## Getting API Credentials
2026-01-26 21:16:46 -07:00
2026-01-28 15:52:52 -07:00
1. Log in to [app.alpaca.markets](https://app.alpaca.markets)
2. Navigate to Paper Trading or Live Trading
3. Go to "Your API Keys"
4. Copy your API Key and Secret Key
2026-01-26 21:16:46 -07:00
2026-01-28 15:52:52 -07:00
⚠️ **Never share or commit your API credentials**
2026-01-26 21:16:46 -07:00
2026-01-28 15:52:52 -07:00
## What's Displayed
2026-01-26 21:16:46 -07:00
2026-01-28 15:52:52 -07:00
**Account Summary:**
- Portfolio Value
- Cash Balance
- Buying Power
- Today's P&L ($ and %)
2026-01-26 21:16:46 -07:00
2026-01-28 15:52:52 -07:00
**Positions:**
- Symbol, Quantity, Avg Cost
- Current Price, Market Value
- Unrealized P&L ($ and %)
2026-01-26 21:37:37 -07:00
2026-01-28 15:52:52 -07:00
## Technical Details
2026-01-26 21:37:37 -07:00
2026-01-28 15:52:52 -07:00
- Pure HTML/CSS/JavaScript (no frameworks)
- Paper API: `https://paper-api.alpaca.markets`
- Live API: `https://api.alpaca.markets`
- Works on all modern browsers
2026-01-26 21:16:46 -07:00
2026-01-28 15:52:52 -07:00
## Security
2026-01-26 21:16:46 -07:00
2026-01-28 15:52:52 -07:00
- Credentials stored in memory only
- No server-side components
- No third-party data sharing
- Read-only dashboard
2026-01-26 21:16:46 -07:00
## License
2026-01-28 15:52:52 -07:00
MIT License
2026-01-26 21:16:46 -07:00
## Disclaimer
2026-01-28 15:52:52 -07:00
For informational purposes only. Not financial advice. Developer not affiliated with Alpaca Markets.
2026-01-26 21:16:46 -07:00
---
2026-01-28 15:59:34 -07:00
**Built for traders who want a simple, clean portfolio view.**