How openbq-org/openbb works
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_controller.py OpenBB CLI · router.py Python API · obbject.py Result Object · query_executor.py Query Executor
Components 22
User Interfaces
- Python API
openbb_platform/core/openbb_core/app/router.py - OpenBB CLI
cli/openbb_cli/controllers/cli_controller.py - CLI Session
cli/openbb_cli/session.py - CLI Completion
cli/openbb_cli/config/completer.py - CLI JSON Output
cli/openbb_cli/outputs/json.py
Core Runtime
- Query Parameters
openbb_platform/core/openbb_core/provider/abstract/query_params.py - Query Executor
openbb_platform/core/openbb_core/provider/query_executor.py - Fetcher Contract
openbb_platform/core/openbb_core/provider/abstract/fetcher.py - Standard Data
openbb_platform/core/openbb_core/provider/abstract/data.py - Result Object
openbb_platform/core/openbb_core/app/model/obbject.py - Charting
openbb_platform/core/openbb_core/app/charting/manager.py
Data Providers
- EIA Models
openbb_platform/providers/eia/openbb_us_eia/models - EIA Query Utilities
openbb_platform/providers/eia/openbb_us_eia/utils/api_query.py - USDA ERS Model
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
openbb_platform/extensions/platform_api/openbb_platform_api/app/app.py - MCP Pipeline
openbb_platform/extensions/mcp_server/openbb_mcp_server/app/pipeline.py - MCP Server
openbb_platform/extensions/mcp_server/openbb_mcp_server/app/app.py
Other components
- Python User
- CLI User
- Workspace
- AI Agent
- External Data Sources
Connections 19
- Python User → Python API: requests data
README.md - Python API → Query Parameters: defines query
- Query Executor → Fetcher Contract: executes fetcher
openbb_platform/core/openbb_core/provider/query_executor.py - Fetcher Contract → Standard Data: returns typed data
openbb_platform/core/openbb_core/provider/abstract/fetcher.py - Python API → Result Object: returns results
README.md - Result Object → CLI JSON Output: serializes results
cli/openbb_cli/outputs/json.py - Result Object → Charting: supports charts
openbb_platform/core/openbb_core/app/charting/manager.py - CLI User → OpenBB CLI: runs commands
README.md - OpenBB CLI → CLI Session: uses session
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
openbb_platform/providers/eia/openbb_us_eia/utils/api_query.py - EIA Models → EIA Query Utilities: requests and paginates
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
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
README.md - Platform REST API → Python API: serves platform data
README.md - AI Agent → MCP Server: uses MCP server
- MCP Server → MCP Pipeline: processes requests
- MCP Pipeline → CLI JSON Output: formats JSON
openbb_platform/extensions/mcp_server/openbb_mcp_server/app/pipeline.py