Install and run the API
pip install "disclosure-alpha[api,mcp]"
export SEC_USER_AGENT="YourName your@email.com"
disclosure-alpha-api
# listens on 0.0.0.0:8000 OpenBB Workspace · Self-hosted backend
Connect Disclosure Alpha as a custom backend. One disclosure-alpha-api process
powers the Disclosure Company widget — overall score, headline components, active flags, and section changes.
Setup
One local API process powers OpenBB widgets, the Company view, and analyst MCP on the same port.
local backend
browser app
widget output
same process also serves widgets · Company view · analyst MCP
pip install "disclosure-alpha[api,mcp]"
export SEC_USER_AGENT="YourName your@email.com"
disclosure-alpha-api
# listens on 0.0.0.0:8000 Chrome recommended. In Workspace, open the backend connection dialog and point it at your local server.
http://127.0.0.1:8000 Fast first run:
set demo=1 on the widget to skip SEC fetches.
Overall score, nine headline components, active flags, and section changes — same deterministic pipeline as CLI and HTTP.
overall_disclosure_risk_score: 34.7
OpenBB Copilot summaries are an OpenBB Workspace feature — not part of the Disclosure Alpha backend. Scores summarize language and change signals; not investment advice. Scope and claims ↗
Widget
After Run on a live filing: overall disclosure risk score, nine headline-weighted components, active flags grouped by section, and year-over-year section changes vs the prior filing.
| Param | Default | Notes |
|---|---|---|
| ticker | AAPL | Company ticker |
| fiscal_year | 2025 | Fiscal year (1994–2100) |
| form_type | 10-K | 10-K or 10-Q |
| quarter | — | Required for 10-Q: Q1, Q2, or Q3 |
| demo | — | Set to 1 for sample data (no EDGAR fetch) |
Five-minute setup — install, connect backend, run your first widget.