Data Extensions

Relevant source files

• openbb_platform/core/openbb_core/app/model/charts/chart.py
• openbb_platform/core/openbb_core/provider/standard_models/bond_indices.py
• openbb_platform/core/openbb_core/provider/standard_models/primary_dealer_fails.py
• openbb_platform/core/tests/app/model/charts/test_chart.py
• openbb_platform/extensions/economy/integration/test_economy_api.py
• openbb_platform/extensions/economy/integration/test_economy_python.py
• openbb_platform/extensions/economy/openbb_economy/economy_router.py
• openbb_platform/extensions/economy/openbb_economy/survey/survey_router.py
• openbb_platform/extensions/equity/integration/test_equity_api.py
• openbb_platform/extensions/equity/integration/test_equity_python.py
• openbb_platform/extensions/etf/integration/test_etf_api.py
• openbb_platform/extensions/etf/integration/test_etf_python.py
• openbb_platform/extensions/platform_api/openbb_platform_api/assets/default_apps.json
• openbb_platform/extensions/tests/test_integration_tests_api.py
• openbb_platform/extensions/tests/test_integration_tests_python.py
• openbb_platform/extensions/tests/utils/integration_tests_api_generator.py
• openbb_platform/extensions/tests/utils/integration_tests_testers.py
• openbb_platform/providers/federal_reserve/openbb_federal_reserve/__init__.py
• openbb_platform/providers/federal_reserve/openbb_federal_reserve/assets/historical_releases.json
• openbb_platform/providers/federal_reserve/openbb_federal_reserve/models/fomc_documents.py
• openbb_platform/providers/federal_reserve/openbb_federal_reserve/models/primary_dealer_positioning.py
• openbb_platform/providers/federal_reserve/openbb_federal_reserve/utils/fomc_documents.py
• openbb_platform/providers/federal_reserve/openbb_federal_reserve/utils/primary_dealer_statistics.py
• openbb_platform/providers/federal_reserve/tests/record/http/test_federal_reserve_fetchers/test_federal_reserve_fomc_documents_fetcher_urllib3_v2.yaml
• openbb_platform/providers/federal_reserve/tests/record/http/test_federal_reserve_fetchers/test_federal_reserve_primary_dealer_fails_fetcher_urllib3_v2.yaml
• openbb_platform/providers/federal_reserve/tests/test_federal_reserve_fetchers.py
• openbb_platform/providers/fmp/openbb_fmp/__init__.py
• openbb_platform/providers/fmp/pyproject.toml
• openbb_platform/providers/fmp/tests/test_fmp_fetchers.py
• openbb_platform/providers/fred/openbb_fred/__init__.py
• openbb_platform/providers/fred/openbb_fred/models/bond_indices.py
• openbb_platform/providers/fred/openbb_fred/models/manufacturing_outlook_ny.py
• openbb_platform/providers/fred/tests/record/http/test_fred_fetchers/test_fred_manufacturing_outlook_ny_fetcher_urllib3_v2.yaml
• openbb_platform/providers/fred/tests/test_fred_fetchers.py
• openbb_platform/providers/intrinio/openbb_intrinio/__init__.py
• openbb_platform/providers/intrinio/tests/test_intrinio_fetchers.py

Overview

Data extensions organize the OpenBB Platform's financial data capabilities into logical business domains such as equity, economy, ETF, fixed income, currency, crypto, and regulatory data. Each extension exposes a set of endpoints (commands) that accept multiple provider implementations through a unified interface.

For information about the provider system that supplies data to these extensions, see Provider Architecture. For details on the extension discovery and loading mechanism, see Extension System. For the command execution flow, see Command Execution Engine.

Sources: openbb_platform/extensions/economy/openbb_economy/economy_router.py1-636 openbb_platform/extensions/equity/integration/test_equity_python.py1-100

Extension Architecture

Directory Structure

Each data extension follows a standard directory layout:

openbb_platform/extensions/{extension_name}/
├── openbb_{extension_name}/
│   ├── {extension_name}_router.py     # Main router with command definitions
│   ├── {sub_domain}/                  # Optional sub-routers
│   │   └── {sub_domain}_router.py
│   └── __init__.py
├── integration/
│   ├── test_{extension_name}_api.py   # API integration tests
│   └── test_{extension_name}_python.py # Python interface tests
└── pyproject.toml                      # Entry point registration

Sources: openbb_platform/extensions/economy/openbb_economy/economy_router.py1-25 openbb_platform/extensions/economy/openbb_economy/survey/survey_router.py1-14

Router Definition Pattern

Extensions use the Router class to define their command structure:

Diagram: Extension Router Hierarchy and Command Execution Pattern

All commands follow this pattern from openbb_platform/extensions/economy/openbb_economy/economy_router.py56-63:

Sources: openbb_platform/extensions/economy/openbb_economy/economy_router.py21-24 openbb_platform/extensions/economy/openbb_economy/economy_router.py36-63

Extension Endpoints and Models

Command Registration

Each command specifies:

• Model: Standard data model name (e.g., "ConsumerPriceIndex")
• Examples: API and Python usage examples via APIEx and PythonEx
• Parameters: Injected via StandardParams, ExtraParams, ProviderChoices

Diagram: Command to Provider Resolution Flow

Sources: openbb_platform/extensions/economy/openbb_economy/economy_router.py66-96

Major Data Extensions

Economy Extension

The economy extension provides macroeconomic data through the main router and three sub-routers:

Router	Prefix	Key Endpoints
Main	/economy	calendar, cpi, fred_search, fred_series, unemployment, balance_of_payments, interest_rates, retail_prices
GDP	/economy/gdp	forecast, nominal, real
Survey	/economy/survey	university_of_michigan, sloos, economic_conditions_chicago, manufacturing_outlook_texas, manufacturing_outlook_ny
Shipping	/economy/shipping	port_volume, shipping_index

Notable Features:

• FRED integration: fred_search and fred_series for Federal Reserve Economic Data
• Regional data: fred_regional for state-level series groups
• Central bank data: central_bank_holdings, primary_dealer_positioning
• International data: Supports multiple countries via OECD, IMF, EconDB providers

Sources: openbb_platform/extensions/economy/openbb_economy/economy_router.py21-636 openbb_platform/extensions/economy/integration/test_economy_python.py20-906

Equity Extension

The equity extension covers company-level financial data:

Diagram: Equity Extension Endpoint Organization

Supported Providers: FMP, Intrinio, YFinance, TMX, Nasdaq, SEC, Finviz, Benzinga, Seeking Alpha

Sources: openbb_platform/extensions/equity/integration/test_equity_python.py21-1590

ETF Extension

The ETF extension provides exchange-traded fund data:

Endpoint	Description	Providers
search	ETF symbol search	FMP, TMX, Intrinio
historical	Price history	Alpha Vantage, CBOE, FMP, Intrinio, YFinance, Tiingo, Tradier, Polygon, TMX
info	ETF information/profile	FMP, Intrinio, TMX, YFinance
holdings	Fund holdings	FMP, Intrinio, TMX
sectors	Sector exposure	FMP, Intrinio
countries	Geographic exposure	FMP
price_performance	Performance metrics	FMP, Intrinio

Sources: openbb_platform/extensions/etf/integration/test_etf_python.py20-370

Provider Integration Pattern

Multi-Provider Support

Extensions define standard interfaces that multiple providers implement:

Diagram: Multi-Provider Data Flow for CPI Endpoint

The provider is selected via:

1. User specification: obb.economy.cpi(provider='fred')
2. Default priority: First available provider in user credentials
3. Command-specific defaults: Some commands specify preferred providers

Sources: openbb_platform/extensions/economy/openbb_economy/economy_router.py66-96 openbb_platform/extensions/economy/integration/test_economy_python.py62-113

Provider-Specific Parameters

Commands accept both standard and provider-specific parameters:

Sources: openbb_platform/extensions/economy/integration/test_economy_python.py62-113

Integration Testing

Test Structure

Each extension maintains comprehensive integration tests for both Python and API interfaces:

Diagram: Integration Test Execution Pattern

Sources: openbb_platform/extensions/equity/integration/test_equity_python.py1-100 openbb_platform/extensions/economy/integration/test_economy_api.py1-100

Test Coverage Verification

The platform includes automated checks to ensure complete test coverage:

Diagram: Test Coverage Validation System

The system verifies:

• All commands have integration tests
• All providers are tested for each command
• Both Python and API interfaces are covered

Sources: openbb_platform/extensions/tests/utils/integration_tests_testers.py22-96 openbb_platform/extensions/tests/test_integration_tests_python.py1-50

Example Test Implementation

From openbb_platform/extensions/economy/integration/test_economy_python.py62-113:

Sources: openbb_platform/extensions/economy/integration/test_economy_python.py62-113

Extension Development Patterns

Command Definition Template

Sources: openbb_platform/extensions/economy/openbb_economy/economy_router.py66-96

Sub-Router Integration

Extensions can organize related functionality into sub-routers:

From openbb_platform/extensions/economy/openbb_economy/economy_router.py17-24:

Sources: openbb_platform/extensions/economy/openbb_economy/economy_router.py17-24 openbb_platform/extensions/economy/openbb_economy/survey/survey_router.py1-14

Provider Coverage Matrix

Economy Extension Providers

Endpoint	FRED	OECD	IMF	FMP	EconDB	Federal Reserve	Trading Economics	Nasdaq
calendar	-	-	-	✓	-	-	✓	✓
cpi	✓	✓	✓	-	-	-	-	-
fred_search	✓	-	-	-	-	-	-	-
fred_series	✓	-	-	-	-	✓	-	-
unemployment	-	✓	-	-	-	-	-	-
balance_of_payments	✓	-	-	-	-	-	-	-
central_bank_holdings	-	-	-	-	-	✓	-	-
indicators	-	-	✓	-	✓	-	-	-

Sources: openbb_platform/extensions/economy/integration/test_economy_python.py20-906

Equity Extension Providers

Endpoint Category	FMP	Intrinio	YFinance	SEC	TMX	Nasdaq	Finviz	Benzinga
Fundamentals	✓	✓	✓	-	-	-	-	-
Price Data	✓	✓	✓	-	✓	-	-	-
Estimates	✓	✓	✓	-	-	-	✓	✓
Ownership	✓	✓	-	✓	✓	-	-	-
Filings	✓	✓	-	✓	✓	✓	-	-
Search	-	✓	-	✓	✓	✓	-	-

Sources: openbb_platform/extensions/equity/integration/test_equity_python.py21-1590