3160a84ad0
* bump minimum version of fastapi to get starlette > 1 * fix test fixture broken by newer version of vitest * another round of lock file syncs * need to pin fastapi until breaking changes in 0.137 can be dealt with * relock cli * cli needs to run openbb-build before running test suite * wrong solution, cli needs fastapi pin until handled. revert nox
OpenBB Nasdaq Provider
This extension integrates the Nasdaq data provider into the OpenBB Platform.
Installation
To install the extension:
pip install openbb-nasdaq
Coverage
The following endpoints are covered by this extension:
obb.economy.calendarobb.equity.calendar.dividendobb.equity.calendar.earningsobb.equity.calendar.ipoobb.equity.searchobb.equity.screenerobb.equity.fundamental.dividendobb.equity.fundamental.filings
Router extensions are required (openbb-economy & openbb-equity) to populate endpoints, but fetchers can be used independent of the Python and API interfaces.
from openbb_nasdaq import nasdaq_provider
nasdaq_provider.fetcher_dict
{'CalendarDividend': openbb_nasdaq.models.calendar_dividend.NasdaqCalendarDividendFetcher,
'CalendarEarnings': openbb_nasdaq.models.calendar_earnings.NasdaqCalendarEarningsFetcher,
'CalendarIpo': openbb_nasdaq.models.calendar_ipo.NasdaqCalendarIpoFetcher,
'CompanyFilings': openbb_nasdaq.models.company_filings.NasdaqCompanyFilingsFetcher,
'EconomicCalendar': openbb_nasdaq.models.economic_calendar.NasdaqEconomicCalendarFetcher,
'EquitySearch': openbb_nasdaq.models.equity_search.NasdaqEquitySearchFetcher,
'EquityScreener': openbb_nasdaq.models.equity_screener.NasdaqEquityScreenerFetcher,
'HistoricalDividends': openbb_nasdaq.models.historical_dividends.NasdaqHistoricalDividendsFetcher,
'TopRetail': openbb_nasdaq.models.top_retail.NasdaqTopRetailFetcher}
OpenBB Workspace App
This package includes a standalone Workspace application for viewing market calendars and company filings.
Launch it from the command line, with the environment active, by entering:
openbb-api --app openbb_nasdaq.app:main --factory
This will start the FastAPI application via Uvicorn and serve the configuration files to Workspace when added as a backend data source.
To see all the launch arguments, use:
openbb-api --help
The application is served by a factory function, and the FastAPI instance can be utilized by calling the main function.
from openbb_nasdaq.app import main
app = main()
OpenBB Documentation
OpenBB Platform documentation is available here.
OpenBB Workspace documentation is available here.