-
Notifications
You must be signed in to change notification settings - Fork 2
Phase 1
Durva Dongre edited this page Jun 4, 2025
·
1 revision
Objective: A conversational interface for Zerodha Kite API users, offering real-time analytics, portfolio management, and research tools.
Purpose: Deliver live market insights for equities, derivatives, and indices.
| UI Elements | Added Parameters | User Queries | API Sources |
|---|---|---|---|
| LTP, % Change, Net Change | IV (for options), Beta | “Show IV for BANKNIFTY 45,000 CE” |
KiteTicker WebSocket |
| Top 10 Bids/Asks | Order flow imbalance | “Is Reliance seeing buy-side pressure?” | kite.quote() |
| OHLC + VWAP | Pivot Points (PP, R1, R2, S1, S2) | “Calculate pivot points for NIFTY” | kite.ohlc() |
| Volume + 52W High/Low | Volume shock alerts (200%+ avg) | “Highlight stocks with volume surge” | External: NSE/BSE APIs |
| Sector Performance Heatmap | Real-time sector momentum | “Show top 3 sectors today” | Custom aggregation |
Purpose: Holistic view of holdings, margins, and risk exposure.
| UI Elements | Added Parameters | User Queries | API Sources |
|---|---|---|---|
| Holdings: Qty, LTP, P&L | Cost basis, Tax liability | “Estimate STCG tax for today’s trades” | kite.holdings() |
| Realized vs. Unrealized P&L | Sharpe Ratio, Max Drawdown | “Calculate my portfolio’s Sharpe ratio” | kite.positions() |
| Margin Utilization | Span margin, Exposure margin | “Show margin blocked for ICICI Bank futures” | kite.margins() |
| Asset Allocation Pie Chart | Equity/Debt/F&O split | “Break down my portfolio by asset class” | Custom logic + kite.holdings()
|
| Order History (Last 30 days) | Trade efficiency (slippage) | “Review my last week’s order execution” | kite.orders() |
Purpose: Track custom instruments and discover opportunities.
| UI Elements | Added Parameters | User Queries | API Sources |
|---|---|---|---|
| Custom Watchlists (Drag/Drop) | EV/EBITDA, Piotroski Score | “Find high-growth small-caps (PEG < 1)” | Kite: kite.ltp()
|
| Prebuilt Screens (e.g., “RSI Oversold”) | Volume-Weighted MACD | “Screen for bullish MACD crossovers” | External: Alpha Vantage/Yahoo Finance |
| Heatmaps (Gainers/Losers) | Short interest, Delivery % | “Show stocks with high delivery volume” | NSE/BSE APIs + Custom DB |
| Alerts Log (Price/Indicator) | Backtested alert reliability | “Notify if Tata Steel crosses ₹150” | Custom engine + Webhooks |
Purpose: Technical analysis with advanced visualization.
| UI Elements | Added Parameters | User Queries | API Sources |
|---|---|---|---|
| Interactive Candlestick Charts | Heikin-Ashi, Renko bricks | “Plot Renko chart for Axis Bank (₹10 brick)” | Kite: kite.historical_data()
|
| 30+ Indicators (RSI, MACD, etc.) | Custom scripts (Python/JS) | “Add Supertrend (10,3) to chart” | External: TradingView Lightweight Charts |
| Correlation Matrix | Rolling beta, covariance | “Compare Infosys with Nasdaq” | Yahoo Finance/Alpha Vantage |
| Event Annotations (Dividends, Splits) | Earnings dates, news events | “Mark Q4 results on chart” | External: Earnings calendars (Moneycontrol) |
Purpose: Deep dive into financial health and valuations.
| UI Elements | Added Parameters | User Queries | API Sources |
|---|---|---|---|
| Financial Ratios (P/E, ROE, etc.) | Cash conversion cycle, FCF yield | “Analyze HUL’s working capital efficiency” | Tickertape/Screener.in APIs |
| Income Statement Trends | EBITDA margin, Revenue CAGR | “Show Reliance’s revenue growth (5Y)” | FMP Cloud/Alpha Vantage |
| Shareholding Pattern | Pledge details, Insider trades | “Track promoter pledging in Adani stocks” | BSE/NSE filings + PRIME Database |
| Dividend History | Yield vs. sector avg. | “List consistent dividend payers (10Y+)” | External: Investing.com APIs |
| Component | Key Features | API Sources | Critical Enhancements |
|---|---|---|---|
| Real-Time Market Data | IV, Pivot Points, Order Flow Imbalance | KiteTicker, kite.quote(), NSE/BSE APIs |
Volatility-adjusted alerts |
| Portfolio Dashboard | VaR, Tax Calculator, Sharpe Ratio |
kite.holdings(), kite.margins(), kite.positions()
|
Risk analytics integration |
| Watchlist & Screener | Combo Screeners, Peer Comparison, Backtested Alerts | Kite LTP + Alpha Vantage/Yahoo Finance + Custom DB | Multi-timeframe scanning |
| Historical Charting | Backtesting, Pattern Recognition, Multi-Asset Overlays | Kite historical_data() + TradingView/Yahoo Finance |
Strategy simulation engine |
| Fundamentals | Ownership Trends, ESG Scores, Analyst Forecasts | Tickertape, FMP Cloud, BSE/NSE Filings | Forecast models + sustainability metrics |
-
Data Pipeline:
- Cache Kite API responses (Redis/Memcached) to handle rate limits.
- Use Celery for async tasks (e.g., historical data fetching).
-
Third-Party Integration:
- Alpha Vantage for global data, FMP Cloud for fundamentals.
- News API (e.g., Newsdata.io) for sentiment analysis.
-
UI/UX:
- React-based dashboard with drag-and-drop watchlists.
- TradingView widgets for charting.
-
Security:
- Encrypt API keys/secrets (AWS KMS/Hashicorp Vault).
- OAuth 2.0 for Zerodha login.
- 📋 Research
What we're actually going to build vs what we dream about - 🗺️ Roadmap
Our master plan (subject to reality checks) - 🧩 Components
The building blocks that hopefully work together - 📡 API Guide
Interfaces to every modular service, from market data to tax - 💰 Funding
How we keep the lights on (and the servers running) - 🏗️ Architecture
The technical deep dive for masochists - ✅ Todo List
What’s pending, what’s burning, and who’s guilty - 🤝 Contributing
Join the chaos, we have cookies*
*Cookies not guaranteed