docs: add market support and limitations documentation

- Create MARKET_SUPPORT.md with comprehensive guide to supported exchanges - Document TradingView and Finnhub API limitations - Add troubleshooting section for 'symbol only available on TradingView' error - Update README.md table of contents with new Market Support section - Addresses issue #83 by clearly explaining why NSE and other markets may have limitations
2026-09-03 06:15:16 +08:00 · 2026-06-06 12:55:47 +01:00
parent 8326133a70
commit fa5f1bac69
2 changed files with 179 additions and 5 deletions
--- a/MARKET_SUPPORT.md
+++ b/MARKET_SUPPORT.md
@@ -0,0 +1,153 @@
+# 🌍 Market Support & Limitations
+
+OpenStock supports stocks from multiple exchanges worldwide, but there are important limitations to be aware of based on our data providers (Finnhub & TradingView).
+
+## ✅ Fully Supported Markets
+
+### Americas
+- **US**: NASDAQ, NYSE, AMEX (symbols like `AAPL`, `MSFT`)
+- **Canada**: TSX (symbols like `RY.TO`)
+- **Brazil**: BMFBOVESPA (symbols like `VALE3.SA`)
+- **Mexico**: BMV (symbols like `ASUR.MX`)
+- **Argentina**: BCBA (symbols like `BMA.BA`)
+
+### Europe
+- **UK**: LSE (symbols like `BARC.L`)
+- **France**: EURONEXT (symbols like `AIR.PA`)
+- **Germany**: XETRA (symbols like `SAP.DE`)
+- **Sweden**: OMXSTO (symbols like `ERIC-B.ST`)
+- **Spain**: BMAD (symbols like `REPSOL.MC`)
+- **Italy**: EURONEXT Milan (symbols like `ENI.MI`)
+- **Belgium**: EURONEXT (symbols like `GIB.BR`)
+- **Denmark**: OMXCOPENHAGEN (symbols like `ISH.CO`)
+- **Finland**: OMXHEX (symbols like `NOKIA.HE`)
+- **Greece**: ATHEX (symbols like `ETE.ATH`)
+- **Ireland**: ISE (symbols like `RY.IR`)
+- **Netherlands**: EURONEXT (symbols like `ING.AS`)
+- **Norway**: OMXOSLO (symbols like `EQNR.OL`)
+- **Poland**: WSE (symbols like `PZU.WA`)
+- **Portugal**: EURONEXT (symbols like `BCP.LI`)
+- **Switzerland**: SIX (symbols like `NESN.SW`)
+
+### Asia-Pacific
+- **Taiwan**: TWSE (symbols like `2330.TW`), TPEX (symbols like `6488.TWO`)
+- **Hong Kong**: HKEX (symbols like `0700.HK`)
+- **Japan**: TSE (symbols like `7203.T`)
+- **South Korea**: KRX (symbols like `005930.KS`), KOSDAQ (symbols like `010000.KQ`)
+- **Singapore**: SGX (symbols like `U11.SI`)
+- **Australia**: ASX (symbols like `CBA.AX`)
+- **New Zealand**: NZX (symbols like `FBU.NZ`)
+- **India**: NSE (symbols like `INFY.NS`), BSE (symbols like `INFY.BO`)
+- **Thailand**: SET (symbols like `ADVANC.BK`)
+- **Malaysia**: KLSE (symbols like `1023.KL`)
+- **Philippines**: PSE (symbols like `JFC.PH`)
+- **Indonesia**: IDX (symbols like `BBCA.JK`)
+
+### Middle East & Africa
+- **Israel**: TASE (symbols like `TEVA.TA`)
+- **South Africa**: JSE (symbols like `NPN.JO`)
+- **Saudi Arabia**: TASI (limited support)
+- **UAE**: ADX (limited support)
+
+## ⚠️ Known Limitations
+
+### TradingView Widget Limitations
+
+TradingView's free tier embeddable widgets have several restrictions:
+
+1. **International Markets**: Some symbols, especially from emerging markets (India NSE, Vietnam, etc.), may show:
+   - "This symbol is only available on TradingView" error
+   - Missing charts or company profile data
+   - Empty technical analysis indicators
+
+2. **Affected Markets**:
+   - India (NSE/BSE): Free tier support is limited
+   - Vietnam, Philippines, Indonesia: Partial or no support
+   - Emerging market stocks: Often require paid subscription
+
+3. **Why This Happens**:
+   - TradingView's free widget tier has limited symbol availability
+   - Some exchanges require commercial licensing
+   - High-volume markets get priority in free tier
+
+### Finnhub API Limitations
+
+1. **Free Tier**:
+   - Supports basic quote and company data for most exchanges
+   - Real-time data delayed by 15+ minutes for non-US stocks
+   - Rate limited to 60 API calls per minute
+   - No access to historical minute-level bars
+
+2. **Market-Specific**:
+   - India NSE/BSE: Available but with delays
+   - Chinese A-shares: Not available in free tier
+   - Forex: Not available
+   - Cryptocurrencies: Not available
+
+## 🔧 Troubleshooting
+
+### "This symbol is only available on TradingView"
+
+**What this means**: TradingView's embedded widgets don't support this symbol.
+
+**What you can still do**:
+- ✅ Search for the stock using Finnhub data
+- ✅ View company profile from Finnhub
+- ✅ Add to watchlist (data updates available)
+- ✅ See market news from Finnhub
+- ❌ View interactive TradingView charts
+- ❌ See technical analysis indicators from TradingView
+
+**Solutions**:
+1. **For Personal Use**: Upgrade to Finnhub/TradingView paid plans
+2. **For Self-Hosted Deployments**: 
+   - Upgrade API keys in your `.env` file
+   - Consider alternative chart libraries (e.g., Lightweight Charts, Chart.js)
+
+### Charts Don't Load
+
+**Possible causes**:
+- Symbol not supported on TradingView
+- Network connectivity issue
+- TradingView API rate limiting
+
+**Troubleshooting**:
+1. Check browser console for errors (F12)
+2. Verify symbol exists on Finnhub search
+3. Try a US stock (e.g., AAPL) to confirm basic functionality
+4. Check your internet connection
+
+## 🚀 Future Improvements
+
+The OpenStock community is working on:
+
+- [ ] Fallback chart libraries for unsupported symbols
+- [ ] Market availability checker before displaying widgets
+- [ ] Alternative data sources for emerging markets
+- [ ] Forex support
+- [ ] Cryptocurrency support
+- [ ] Custom indicators and drawing tools
+- [ ] Paper trading features
+
+## 💡 Contributing
+
+If you discover:
+- A market that should be supported
+- An exchange with incorrect symbol mapping
+- Alternative data providers we should consider
+
+Please [open an issue](https://github.com/Open-Dev-Society/OpenStock/issues) with:
+- Exchange name and country
+- Example stock symbols
+- Expected vs. actual behavior
+- Links to Finnhub/TradingView documentation
+
+## 📚 References
+
+- [Finnhub API Documentation](https://finnhub.io/docs/api)
+- [TradingView Widget Documentation](https://www.tradingview.com/pine-script-docs/)
+- [Supported Finnhub Exchanges](https://finnhub.io/docs/api/symbol-lookup)
+
+---
+
+**Disclaimer**: Nothing here is financial advice. Market data availability depends on provider terms and your subscription tier. Always verify current data before making investment decisions. OpenStock is community-built and not a brokerage.
--- a/README.md
+++ b/README.md
@@ -52,11 +52,12 @@ Note: OpenStock is community-built and not a brokerage. Market data may be delay
 7. 🔐 [Environment Variables](#environment-variables)
 8. 🧱 [Project Structure](#project-structure)
 9. 📡 [Data & Integrations](#data--integrations)
-10. 🧪 [Scripts & Tooling](#scripts--tooling)
-11. 🤝 [Contributing](#contributing)
-12. 🛡️ [Security](#security)
-13. 📜 [License](#license)
-14. 🙏 [Acknowledgements](#acknowledgements)
+10. 🌍 [Market Support](#market-support)
+11. 🧪 [Scripts & Tooling](#scripts--tooling)
+12. 🤝 [Contributing](#contributing)
+13. 🛡️ [Security](#security)
+14. 📜 [License](#license)
+15. 🙏 [Acknowledgements](#acknowledgements)

 ## ✨ Introduction <a name="introduction"></a>

@@ -395,6 +396,26 @@ public/assets/images/   # logos and screenshots
    - Gmail transport. Update credentials or switch to your SMTP provider.
    - Templates for welcome and news summary emails.

+
+## 🌍 Market Support <a name="market-support"></a>
+
+OpenStock supports **30+ international stock exchanges** including NSE, LSE, TSX, and more. However, please be aware of important limitations based on our data providers.
+
+**Quick Facts**:
+- ✅ Finnhub supports most global exchanges
+- ⚠️ TradingView free tier has restrictions on emerging markets (India NSE, Vietnam, etc.)
+- 📊 Real-time data for non-US stocks is delayed by 15+ minutes on free tier
+
+**See [MARKET_SUPPORT.md](./MARKET_SUPPORT.md) for**:
+- Complete list of supported exchanges
+- Known limitations and workarounds
+- Why "This symbol is only available on TradingView" appears
+- How to upgrade for broader market coverage
+- Future improvements planned
+
+For the latest supported symbols and exchanges, see [Finnhub's exchange list](https://finnhub.io/docs/api/symbol-lookup).
+
+
 ## 🧪 Scripts & Tooling <a name="scripts--tooling"></a>

 Package scripts