# openbq-org/openbb architecture

> Architecture diagram of the GitHub repository openbq-org/openbb, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-05). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/openbq-org/openbb
- Repository: https://github.com/openbq-org/openbb

## Overview

Open Data Platform (ODP) is a data-integration runtime: users request standardized financial or economic data, provider integrations fetch and shape it, and results are exposed through Python, CLI, REST, and MCP surfaces. The main stages are query definition, provider execution, result handling, and surface-specific delivery; charting is an additional internal capability. The tree and excerpts show representative core, CLI, API, MCP, and provider modules. Other provider and extension wiring is not fully sampled, so uncertain relationships are omitted or marked unverified.

Main entry points: [`cli/openbb_cli/controllers/cli_controller.py`](https://github.com/openbq-org/openbb/blob/develop/cli/openbb_cli/controllers/cli_controller.py) (OpenBB CLI), [`openbb_platform/core/openbb_core/app/router.py`](https://github.com/openbq-org/openbb/blob/develop/openbb_platform/core/openbb_core/app/router.py) (Python API), [`openbb_platform/core/openbb_core/app/model/obbject.py`](https://github.com/openbq-org/openbb/blob/develop/openbb_platform/core/openbb_core/app/model/obbject.py) (Result Object), [`openbb_platform/core/openbb_core/provider/query_executor.py`](https://github.com/openbq-org/openbb/blob/develop/openbb_platform/core/openbb_core/provider/query_executor.py) (Query Executor)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_interfaces["User Interfaces"]
  node_python_api["Python API<br/>[router.py]"]
  node_cli["OpenBB CLI<br/>[cli_controller.py]"]
  node_cli_session["CLI Session<br/>[session.py]"]
  node_cli_completer["CLI Completion<br/>[completer.py]"]
  node_cli_output["CLI JSON Output<br/>[json.py]"]
end

subgraph group_runtime["Core Runtime"]
  node_query_params["Query Parameters<br/>[query_params.py]"]
  node_query_executor["Query Executor<br/>[query_executor.py]"]
  node_fetcher["Fetcher Contract<br/>[fetcher.py]"]
  node_data_model["Standard Data<br/>[data.py]"]
  node_obbject["Result Object<br/>[obbject.py]"]
  node_charting["Charting<br/>[manager.py]"]
end

subgraph group_providers["Data Providers"]
  node_eia_models["EIA Models"]
  node_eia_query["EIA Query Utilities<br/>[api_query.py]"]
  node_usda_model["USDA ERS Model"]
end

subgraph group_delivery["API and Agent Delivery"]
  node_platform_api["Platform REST API<br/>[app.py]"]
  node_mcp_pipeline["MCP Pipeline<br/>[pipeline.py]"]
  node_mcp_app["MCP Server<br/>[app.py]"]
end

node_python_user(("Python User"))
node_cli_user(("CLI User"))
node_workspace(("Workspace"))
node_agent(("AI Agent"))
node_external_data(("External Data Sources"))

node_python_user -->|"requests data"| node_python_api
node_python_api -.->|"defines query"| node_query_params
node_query_executor -->|"executes fetcher"| node_fetcher
node_fetcher -->|"returns typed data"| node_data_model
node_python_api -->|"returns results"| node_obbject
node_obbject -->|"serializes results"| node_cli_output
node_obbject -.->|"supports charts"| node_charting
node_cli_user -->|"runs commands"| node_cli
node_cli -->|"uses session"| node_cli_session
node_cli -->|"updates choices"| node_cli_completer
node_cli -.->|"dispatches queries"| node_query_executor
node_external_data -->|"serves datasets"| node_eia_query
node_eia_models -->|"requests and paginates"| node_eia_query
node_usda_model -->|"fetches crop data"| node_external_data
node_workspace -->|"connects backend"| node_platform_api
node_platform_api -->|"serves platform data"| node_python_api
node_agent -.->|"uses MCP server"| node_mcp_app
node_mcp_app -.->|"processes requests"| node_mcp_pipeline
node_mcp_pipeline -->|"formats JSON"| node_cli_output

click node_python_api "https://github.com/openbq-org/openbb/blob/develop/openbb_platform/core/openbb_core/app/router.py"
click node_cli "https://github.com/openbq-org/openbb/blob/develop/cli/openbb_cli/controllers/cli_controller.py"
click node_cli_session "https://github.com/openbq-org/openbb/blob/develop/cli/openbb_cli/session.py"
click node_cli_completer "https://github.com/openbq-org/openbb/blob/develop/cli/openbb_cli/config/completer.py"
click node_cli_output "https://github.com/openbq-org/openbb/blob/develop/cli/openbb_cli/outputs/json.py"
click node_query_params "https://github.com/openbq-org/openbb/blob/develop/openbb_platform/core/openbb_core/provider/abstract/query_params.py"
click node_query_executor "https://github.com/openbq-org/openbb/blob/develop/openbb_platform/core/openbb_core/provider/query_executor.py"
click node_fetcher "https://github.com/openbq-org/openbb/blob/develop/openbb_platform/core/openbb_core/provider/abstract/fetcher.py"
click node_data_model "https://github.com/openbq-org/openbb/blob/develop/openbb_platform/core/openbb_core/provider/abstract/data.py"
click node_obbject "https://github.com/openbq-org/openbb/blob/develop/openbb_platform/core/openbb_core/app/model/obbject.py"
click node_charting "https://github.com/openbq-org/openbb/blob/develop/openbb_platform/core/openbb_core/app/charting/manager.py"
click node_eia_models "https://github.com/openbq-org/openbb/tree/develop/openbb_platform/providers/eia/openbb_us_eia/models"
click node_eia_query "https://github.com/openbq-org/openbb/blob/develop/openbb_platform/providers/eia/openbb_us_eia/utils/api_query.py"
click node_usda_model "https://github.com/openbq-org/openbb/blob/develop/openbb_platform/providers/government_us/openbb_government_us/usda/models/adoption_of_genetically_engineered_crops_in_the_united_states.py"
click node_platform_api "https://github.com/openbq-org/openbb/blob/develop/openbb_platform/extensions/platform_api/openbb_platform_api/app/app.py"
click node_mcp_pipeline "https://github.com/openbq-org/openbb/blob/develop/openbb_platform/extensions/mcp_server/openbb_mcp_server/app/pipeline.py"
click node_mcp_app "https://github.com/openbq-org/openbb/blob/develop/openbb_platform/extensions/mcp_server/openbb_mcp_server/app/app.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_python_api,node_cli,node_cli_session,node_cli_completer,node_cli_output,node_python_user,node_cli_user toneBlue
class node_query_params,node_query_executor,node_fetcher,node_data_model,node_obbject,node_charting toneAmber
class node_eia_models,node_eia_query,node_usda_model toneMint
class node_platform_api,node_mcp_pipeline,node_mcp_app toneRose
class node_workspace,node_agent,node_external_data toneIndigo
```

## Components

### User Interfaces

- [Python API](https://github.com/openbq-org/openbb/blob/develop/openbb_platform/core/openbb_core/app/router.py): `openbb_platform/core/openbb_core/app/router.py`
- [OpenBB CLI](https://github.com/openbq-org/openbb/blob/develop/cli/openbb_cli/controllers/cli_controller.py): `cli/openbb_cli/controllers/cli_controller.py`
- [CLI Session](https://github.com/openbq-org/openbb/blob/develop/cli/openbb_cli/session.py): `cli/openbb_cli/session.py`
- [CLI Completion](https://github.com/openbq-org/openbb/blob/develop/cli/openbb_cli/config/completer.py): `cli/openbb_cli/config/completer.py`
- [CLI JSON Output](https://github.com/openbq-org/openbb/blob/develop/cli/openbb_cli/outputs/json.py): `cli/openbb_cli/outputs/json.py`

### Core Runtime

- [Query Parameters](https://github.com/openbq-org/openbb/blob/develop/openbb_platform/core/openbb_core/provider/abstract/query_params.py): `openbb_platform/core/openbb_core/provider/abstract/query_params.py`
- [Query Executor](https://github.com/openbq-org/openbb/blob/develop/openbb_platform/core/openbb_core/provider/query_executor.py): `openbb_platform/core/openbb_core/provider/query_executor.py`
- [Fetcher Contract](https://github.com/openbq-org/openbb/blob/develop/openbb_platform/core/openbb_core/provider/abstract/fetcher.py): `openbb_platform/core/openbb_core/provider/abstract/fetcher.py`
- [Standard Data](https://github.com/openbq-org/openbb/blob/develop/openbb_platform/core/openbb_core/provider/abstract/data.py): `openbb_platform/core/openbb_core/provider/abstract/data.py`
- [Result Object](https://github.com/openbq-org/openbb/blob/develop/openbb_platform/core/openbb_core/app/model/obbject.py): `openbb_platform/core/openbb_core/app/model/obbject.py`
- [Charting](https://github.com/openbq-org/openbb/blob/develop/openbb_platform/core/openbb_core/app/charting/manager.py): `openbb_platform/core/openbb_core/app/charting/manager.py`

### Data Providers

- [EIA Models](https://github.com/openbq-org/openbb/tree/develop/openbb_platform/providers/eia/openbb_us_eia/models): `openbb_platform/providers/eia/openbb_us_eia/models`
- [EIA Query Utilities](https://github.com/openbq-org/openbb/blob/develop/openbb_platform/providers/eia/openbb_us_eia/utils/api_query.py): `openbb_platform/providers/eia/openbb_us_eia/utils/api_query.py`
- [USDA ERS Model](https://github.com/openbq-org/openbb/blob/develop/openbb_platform/providers/government_us/openbb_government_us/usda/models/adoption_of_genetically_engineered_crops_in_the_united_states.py): `openbb_platform/providers/government_us/openbb_government_us/usda/models/adoption_of_genetically_engineered_crops_in_the_united_states.py`

### API and Agent Delivery

- [Platform REST API](https://github.com/openbq-org/openbb/blob/develop/openbb_platform/extensions/platform_api/openbb_platform_api/app/app.py): `openbb_platform/extensions/platform_api/openbb_platform_api/app/app.py`
- [MCP Pipeline](https://github.com/openbq-org/openbb/blob/develop/openbb_platform/extensions/mcp_server/openbb_mcp_server/app/pipeline.py): `openbb_platform/extensions/mcp_server/openbb_mcp_server/app/pipeline.py`
- [MCP Server](https://github.com/openbq-org/openbb/blob/develop/openbb_platform/extensions/mcp_server/openbb_mcp_server/app/app.py): `openbb_platform/extensions/mcp_server/openbb_mcp_server/app/app.py`

### Other components

- **Python User**
- **CLI User**
- **Workspace**
- **AI Agent**
- **External Data Sources**

## Connections

- Python User → Python API: requests data (evidence: `README.md`)
- Python API → Query Parameters: defines query
- Query Executor → Fetcher Contract: executes fetcher (evidence: `openbb_platform/core/openbb_core/provider/query_executor.py`)
- Fetcher Contract → Standard Data: returns typed data (evidence: `openbb_platform/core/openbb_core/provider/abstract/fetcher.py`)
- Python API → Result Object: returns results (evidence: `README.md`)
- Result Object → CLI JSON Output: serializes results (evidence: `cli/openbb_cli/outputs/json.py`)
- Result Object → Charting: supports charts (evidence: `openbb_platform/core/openbb_core/app/charting/manager.py`)
- CLI User → OpenBB CLI: runs commands (evidence: `README.md`)
- OpenBB CLI → CLI Session: uses session (evidence: `cli/openbb_cli/controllers/cli_controller.py`)
- OpenBB CLI → CLI Completion: updates choices
- OpenBB CLI → Query Executor: dispatches queries
- External Data Sources → EIA Query Utilities: serves datasets (evidence: `openbb_platform/providers/eia/openbb_us_eia/utils/api_query.py`)
- EIA Models → EIA Query Utilities: requests and paginates (evidence: `openbb_platform/providers/eia/openbb_us_eia/models/natural_gas/us_underground_natural_gas_storage_by_storage_type.py`)
- USDA ERS Model → External Data Sources: fetches crop data (evidence: `openbb_platform/providers/government_us/openbb_government_us/usda/models/adoption_of_genetically_engineered_crops_in_the_united_states.py`)
- Workspace → Platform REST API: connects backend (evidence: `README.md`)
- Platform REST API → Python API: serves platform data (evidence: `README.md`)
- AI Agent → MCP Server: uses MCP server
- MCP Server → MCP Pipeline: processes requests
- MCP Pipeline → CLI JSON Output: formats JSON (evidence: `openbb_platform/extensions/mcp_server/openbb_mcp_server/app/pipeline.py`)
