Skip to main content
Disclosure Alpha

OpenBB Workspace · Self-hosted backend

Score SEC filings inside OpenBB Workspace

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.

Same deterministic pipeline as CLI, HTTP API, and MCP.

Disclosure Company · OpenBB Workspace
Disclosure Company widget in OpenBB Workspace showing AJG FY2025 10-K disclosure scores, active flags, section changes, and OpenBB Copilot summarizing the visible data
AJG FY2025 10-K — Disclosure Company widget with OpenBB Copilot summarizing visible scores.

Setup

Connect in three steps

One local API process powers OpenBB widgets, the Company view, and analyst MCP on the same port.

CONNECTION_TOPOLOGY::v1
self_hosted_backend
01

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
02

Connect OpenBB Workspace

Chrome recommended. In Workspace, open the backend connection dialog and point it at your local server.

OpenBB Workspace · Connect backend
Apps Connect backend
http://127.0.0.1:8000

Fast first run: set demo=1 on the widget to skip SEC fetches.

03

Run the Disclosure Company widget

Overall score, nine headline components, active flags, and section changes — same deterministic pipeline as CLI and HTTP.

Disclosure Company
My Apps Disclosure Alpha Run

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

What the Company widget shows

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)

Ready to connect OpenBB?

Five-minute setup — install, connect backend, run your first widget.