Files
openbb-invest-api/routes.py
Yaojia Wang 87260f4b10 feat: add 67 new endpoints across 10 feature groups
Prerequisite refactor:
- Consolidate duplicate _to_dicts into shared obb_utils.to_list
- Add fetch_historical and first_or_empty helpers to obb_utils

Phase 1 - Local computation (no provider risk):
- Group I: 12 technical indicators (ATR, ADX, Stoch, OBV, Ichimoku,
  Donchian, Aroon, CCI, Keltner, Fibonacci, A/D, Volatility Cones)
- Group J: Sortino, Omega ratios + rolling stats (variance, stdev,
  mean, skew, kurtosis, quantile via generic endpoint)
- Group H: ECB currency reference rates

Phase 2 - FRED/Federal Reserve providers:
- Group C: 10 fixed income endpoints (treasury rates, yield curve,
  auctions, TIPS, EFFR, SOFR, HQM, commercial paper, spot rates,
  spreads)
- Group D: 11 economy endpoints (CPI, GDP, unemployment, PCE, money
  measures, CLI, HPI, FRED search, balance of payments, Fed holdings,
  FOMC documents)
- Group E: 5 survey endpoints (Michigan, SLOOS, NFP, Empire State,
  BLS search)

Phase 3 - SEC/stockgrid/FINRA providers:
- Group B: 4 equity fundamental endpoints (management, dividends,
  SEC filings, company search)
- Group A: 4 shorts/dark pool endpoints (short volume, FTD, short
  interest, OTC dark pool)
- Group F: 3 index/ETF enhanced (S&P 500 multiples, index
  constituents, ETF N-PORT)

Phase 4 - Regulators:
- Group G: 5 regulatory endpoints (COT report, COT search, SEC
  litigation, institution search, CIK mapping)

Security hardening:
- Service-layer allowlists for all getattr dynamic dispatch
- Regex validation on date, country, security_type, form_type params
- Exception handling in fetch_historical
- Callable guard on rolling stat dispatch

Total: 32 existing + 67 new = 99 endpoints, all free providers.
2026-03-19 17:28:31 +01:00

217 lines
6.8 KiB
Python

from fastapi import APIRouter, Path, Query
from mappers import (
discover_items_from_list,
metrics_from_dict,
profile_from_dict,
quote_from_dict,
)
from models import (
ApiResponse,
FinancialsResponse,
HistoricalBar,
NewsItem,
PortfolioRequest,
PortfolioResponse,
SummaryResponse,
)
from route_utils import safe, validate_symbol
import openbb_service
import analysis_service
router = APIRouter(prefix="/api/v1")
# --- Stock Data ---
@router.get("/stock/{symbol}/quote", response_model=ApiResponse)
@safe
async def stock_quote(symbol: str = Path(..., min_length=1, max_length=20)):
"""Get current quote for a stock."""
symbol = validate_symbol(symbol)
data = await openbb_service.get_quote(symbol)
return ApiResponse(data=quote_from_dict(symbol, data).model_dump())
@router.get("/stock/{symbol}/profile", response_model=ApiResponse)
@safe
async def stock_profile(symbol: str = Path(..., min_length=1, max_length=20)):
"""Get company profile."""
symbol = validate_symbol(symbol)
data = await openbb_service.get_profile(symbol)
return ApiResponse(data=profile_from_dict(symbol, data).model_dump())
@router.get("/stock/{symbol}/metrics", response_model=ApiResponse)
@safe
async def stock_metrics(symbol: str = Path(..., min_length=1, max_length=20)):
"""Get key financial metrics (PE, PB, ROE, etc.)."""
symbol = validate_symbol(symbol)
data = await openbb_service.get_metrics(symbol)
return ApiResponse(data=metrics_from_dict(symbol, data).model_dump())
@router.get("/stock/{symbol}/financials", response_model=ApiResponse)
@safe
async def stock_financials(symbol: str = Path(..., min_length=1, max_length=20)):
"""Get income statement, balance sheet, and cash flow."""
symbol = validate_symbol(symbol)
data = await openbb_service.get_financials(symbol)
return ApiResponse(data=FinancialsResponse(**data).model_dump())
@router.get("/stock/{symbol}/historical", response_model=ApiResponse)
@safe
async def stock_historical(
symbol: str = Path(..., min_length=1, max_length=20),
days: int = Query(default=365, ge=1, le=3650),
):
"""Get historical price data."""
symbol = validate_symbol(symbol)
data = await openbb_service.get_historical(symbol, days=days)
bars = [
HistoricalBar(
date=str(item.get("date", "")),
open=item.get("open"),
high=item.get("high"),
low=item.get("low"),
close=item.get("close"),
volume=item.get("volume"),
).model_dump()
for item in data
]
return ApiResponse(data=bars)
@router.get("/stock/{symbol}/news", response_model=ApiResponse)
@safe
async def stock_news(symbol: str = Path(..., min_length=1, max_length=20)):
"""Get recent company news."""
symbol = validate_symbol(symbol)
data = await openbb_service.get_news(symbol)
news = [
NewsItem(
title=item.get("title"),
url=item.get("url"),
date=str(item.get("date", "")),
source=item.get("source"),
).model_dump()
for item in data
]
return ApiResponse(data=news)
@router.get("/stock/{symbol}/summary", response_model=ApiResponse)
@safe
async def stock_summary(symbol: str = Path(..., min_length=1, max_length=20)):
"""Get aggregated stock data: quote + profile + metrics + financials."""
symbol = validate_symbol(symbol)
data = await openbb_service.get_summary(symbol)
summary = SummaryResponse(
quote=quote_from_dict(symbol, data.get("quote", {})),
profile=profile_from_dict(symbol, data.get("profile", {})),
metrics=metrics_from_dict(symbol, data.get("metrics", {})),
financials=FinancialsResponse(
**data.get("financials", {"symbol": symbol})
),
)
return ApiResponse(data=summary.model_dump())
# --- Portfolio Analysis ---
@router.post("/portfolio/analyze", response_model=ApiResponse)
@safe
async def portfolio_analyze(request: PortfolioRequest):
"""Analyze portfolio holdings with rule-based engine."""
result: PortfolioResponse = await analysis_service.analyze_portfolio(
request.holdings
)
return ApiResponse(data=result.model_dump())
# --- Discovery ---
@router.get("/discover/gainers", response_model=ApiResponse)
@safe
async def discover_gainers():
"""Get top gainers (US market)."""
data = await openbb_service.get_gainers()
return ApiResponse(data=discover_items_from_list(data))
@router.get("/discover/losers", response_model=ApiResponse)
@safe
async def discover_losers():
"""Get top losers (US market)."""
data = await openbb_service.get_losers()
return ApiResponse(data=discover_items_from_list(data))
@router.get("/discover/active", response_model=ApiResponse)
@safe
async def discover_active():
"""Get most active stocks (US market)."""
data = await openbb_service.get_active()
return ApiResponse(data=discover_items_from_list(data))
@router.get("/discover/undervalued", response_model=ApiResponse)
@safe
async def discover_undervalued():
"""Get undervalued large cap stocks."""
data = await openbb_service.get_undervalued()
return ApiResponse(data=discover_items_from_list(data))
@router.get("/discover/growth", response_model=ApiResponse)
@safe
async def discover_growth():
"""Get growth tech stocks."""
data = await openbb_service.get_growth()
return ApiResponse(data=discover_items_from_list(data))
# --- Equity Fundamentals Extended (Group B) ---
@router.get("/stock/{symbol}/management", response_model=ApiResponse)
@safe
async def stock_management(symbol: str = Path(..., min_length=1, max_length=20)):
"""Get executive team: name, title, compensation."""
symbol = validate_symbol(symbol)
data = await openbb_service.get_management(symbol)
return ApiResponse(data=data)
@router.get("/stock/{symbol}/dividends", response_model=ApiResponse)
@safe
async def stock_dividends(symbol: str = Path(..., min_length=1, max_length=20)):
"""Get historical dividend records."""
symbol = validate_symbol(symbol)
data = await openbb_service.get_dividends(symbol)
return ApiResponse(data=data)
@router.get("/stock/{symbol}/filings", response_model=ApiResponse)
@safe
async def stock_filings(
symbol: str = Path(..., min_length=1, max_length=20),
form_type: str = Query(default=None, max_length=20, pattern=r"^[A-Za-z0-9/-]+$"),
):
"""Get SEC filings (10-K, 10-Q, 8-K, etc.)."""
symbol = validate_symbol(symbol)
data = await openbb_service.get_filings(symbol, form_type=form_type)
return ApiResponse(data=data)
@router.get("/search", response_model=ApiResponse)
@safe
async def company_search(query: str = Query(..., min_length=1, max_length=100)):
"""Search for companies by name (SEC/NASDAQ)."""
data = await openbb_service.search_company(query)
return ApiResponse(data=data)