diff --git a/README.md b/README.md index dfe26fd..bee9bc8 100644 --- a/README.md +++ b/README.md @@ -106,7 +106,7 @@ curl -X POST http://localhost:8000/api/v1/portfolio/analyze \ -d '{"holdings":[{"symbol":"AAPL","shares":100,"buy_in_price":150},{"symbol":"VOLV-B.ST","shares":50,"buy_in_price":250}]}' ``` -## API Endpoints (99 total) +## API Endpoints (102 total) ### Health @@ -130,15 +130,27 @@ curl -X POST http://localhost:8000/api/v1/portfolio/analyze \ | GET | `/api/v1/stock/{symbol}/filings?form_type=10-K` | SEC filings (10-K, 10-Q, 8-K) | | GET | `/api/v1/search?query=` | Company search by name (SEC/NASDAQ) | -### Sentiment & Analyst Data (Finnhub + Alpha Vantage + yfinance) +### Sentiment & Analyst Data (Finnhub + Alpha Vantage + yfinance + Reddit) | Method | Path | Description | |--------|------|-------------| -| GET | `/api/v1/stock/{symbol}/sentiment` | Aggregated: news sentiment + recommendations + upgrades | +| GET | `/api/v1/stock/{symbol}/sentiment` | Composite sentiment score from all sources (-1 to +1) | | GET | `/api/v1/stock/{symbol}/news-sentiment?limit=30` | News articles with per-ticker sentiment scores (Alpha Vantage) | +| GET | `/api/v1/stock/{symbol}/social-sentiment` | Social media sentiment from Reddit + Twitter (Finnhub) | +| GET | `/api/v1/stock/{symbol}/reddit-sentiment` | Reddit mentions, upvotes, rank (ApeWisdom, free) | | GET | `/api/v1/stock/{symbol}/insider-trades` | Insider transactions via Finnhub | | GET | `/api/v1/stock/{symbol}/recommendations` | Monthly analyst buy/hold/sell counts (Finnhub) | | GET | `/api/v1/stock/{symbol}/upgrades` | Analyst upgrades/downgrades with price targets (yfinance) | +| GET | `/api/v1/discover/reddit-trending` | Top 25 trending stocks on Reddit (free) | + +The `/sentiment` endpoint aggregates 4 sources into a weighted composite score: + +| Source | Weight | Data | +|--------|--------|------| +| News (Alpha Vantage) | 25% | Article-level bullish/bearish scores | +| Analysts (Finnhub) | 30% | Buy/sell recommendation ratio | +| Upgrades (yfinance) | 20% | Recent upgrade/downgrade actions | +| Reddit (ApeWisdom) | 25% | 24h mention change trend | ### Technical Analysis (14 indicators, local computation, no key needed) @@ -555,6 +567,7 @@ docker run -p 8000:8000 invest-api | **Alpha Vantage** | Free | Yes (free registration) | News sentiment scores (bullish/bearish per ticker per article), 25 req/day | | **FRED** | Free | Yes (free registration) | Fed rate, treasury yields, CPI, PCE, money supply, surveys, 800K+ economic series | | **Federal Reserve** | Free | No | EFFR, SOFR, money measures, central bank holdings, primary dealer positions, FOMC documents | +| **ApeWisdom** | Free | No | Reddit stock mentions, upvotes, trending (WSB, r/stocks, r/investing) | | **openbb-technical** | Free | No (local) | ATR, ADX, Stochastic, OBV, Ichimoku, Donchian, Aroon, CCI, Keltner, Fibonacci, A/D, VWAP, Volatility Cones, Relative Rotation | | **openbb-quantitative** | Free | No (local) | Sharpe, Sortino, Omega ratios, CAPM, normality tests, unit root tests, rolling statistics |