Files
All-in-one-Financial-Analysis/atlas-terminal/server/routers/edgar.py
T
shawnkim1997 e38ef038d4 feat: extend SEC parser for foreign private issuer annual filings (20-F)
- sec_parser detects 20-F filings and maps Item 3D/5/15/18 to the existing risk/MD&A/controls section keys
- edgar router copy reads "annual filing" instead of "10-K" so the API surface covers both 10-K and 20-F
- filings page renders a foreign-issuer section tab variant when the latest annual filing is a 20-F
- New test_sec_parser covers the 20-F mapping plus regression on the original 10-K paths
2026-05-10 23:56:35 +01:00

134 lines
4.8 KiB
Python

"""SEC EDGAR router -- annual filing section download, cache lookup, and comparison."""
from fastapi import APIRouter, HTTPException, Query
from server.models.schemas import (
EdgarSectionsResponse,
Item7Response,
CompareResponse,
)
router = APIRouter()
@router.get(
"/sections/{ticker}",
response_model=EdgarSectionsResponse,
summary="Get annual SEC filing sections (cached or download)",
)
async def get_sections(
ticker: str,
email: str = Query(..., description="SEC EDGAR fair-access email"),
include_html: bool = Query(
False,
description="Include original HTML (with section anchors) for iframe viewing",
),
):
"""Return cleaned annual filing sections for *ticker*.
If the sections are already cached locally the download is skipped.
When *include_html* is true, the response includes ``html`` (wrapped filing
slice with ``id=atlas-item7`` etc. for in-page scrolling).
"""
try:
from server.services.sec_parser import (
download_and_extract_all_items_with_form,
get_annual_sections_with_form,
get_sec_filing_url,
load_10k_html_slice,
)
sections, status, filing_form = get_annual_sections_with_form(ticker.upper(), email)
html_payload = ""
if include_html:
html_payload = load_10k_html_slice(ticker.upper()) or ""
if not html_payload:
sections, filing_form = download_and_extract_all_items_with_form(ticker.upper(), email)
status = "downloaded"
html_payload = load_10k_html_slice(ticker.upper()) or ""
# Resolve actual filing document URL from SEC EDGAR
filing_url = get_sec_filing_url(ticker.upper(), preferred_forms=[filing_form])
links = {}
if filing_url:
links[f"View Original {filing_form} Filing"] = filing_url
links["SEC EDGAR Filings"] = (
f"https://www.sec.gov/cgi-bin/browse-edgar?action=getcompany"
f"&CIK={ticker.upper()}&type={filing_form}&dateb=&owner=include&count=5"
)
return EdgarSectionsResponse(
status=status,
filing_form=filing_form,
filing_label=f"{filing_form} Annual Report (SEC)",
message=(
f"Loaded {filing_form} annual filing for {ticker.upper()}."
if filing_form != "10-K"
else None
),
item1a=sections.get("item1a", ""),
item3=sections.get("item3", ""),
item7=sections.get("item7", ""),
item8=sections.get("item8", ""),
item9a=sections.get("item9a", ""),
html=html_payload,
links=links,
)
except FileNotFoundError as exc:
raise HTTPException(status_code=404, detail=str(exc)) from exc
except ValueError as exc:
raise HTTPException(status_code=422, detail=str(exc)) from exc
except Exception as exc:
raise HTTPException(status_code=500, detail=f"EDGAR download failed: {exc}") from exc
@router.get(
"/item7/{ticker}",
response_model=Item7Response,
summary="Get annual filing MD&A / OFR text",
)
async def get_item7(
ticker: str,
email: str = Query(..., description="SEC EDGAR fair-access email"),
):
"""Return the main management discussion section from the latest annual filing."""
try:
from server.services.sec_parser import download_and_extract_item7_and_1a
_, _item1a, item7 = download_and_extract_item7_and_1a(ticker.upper(), email)
return Item7Response(item7=item7)
except FileNotFoundError as exc:
raise HTTPException(status_code=404, detail=str(exc)) from exc
except Exception as exc:
raise HTTPException(status_code=500, detail=f"Item 7 extraction failed: {exc}") from exc
@router.get(
"/compare/{ticker}",
response_model=CompareResponse,
summary="Latest vs 3-year-ago annual filing comparison",
)
async def compare_item7(
ticker: str,
email: str = Query(..., description="SEC EDGAR fair-access email"),
):
"""Download up to 5 annual filings and return the latest and 3-year-ago Item 7/OFR for
comparative analysis. Also returns the latest Item 1A.
"""
try:
from server.services.sec_parser import download_item7_latest_and_3y_ago
item1a, item7_latest, item7_3y_ago, has_comparison = (
download_item7_latest_and_3y_ago(ticker.upper(), email)
)
return CompareResponse(
item1a_latest=item1a or "",
item7_latest=item7_latest or "",
item7_3y_ago=item7_3y_ago,
has_comparison=has_comparison,
)
except FileNotFoundError as exc:
raise HTTPException(status_code=404, detail=str(exc)) from exc
except Exception as exc:
raise HTTPException(status_code=500, detail=f"Comparison failed: {exc}") from exc