Package: openbb
OpenBB PlatformOpenBB is committed to build the future of investment research by focusing on an open source infrastructure accessible to everyone, everywhere.Check our website atopenbb.coOverviewThe OpenBB Platform provides a convenient way to access raw financial data from multiple data providers. The package comes with a ready to use REST API - this allows developers from any language to easily create applications on top of OpenBB Platform.InstallationThe command below provides access to the core functionalities behind the OpenBB Platform.pipinstallopenbbThis will install the following data providers:Extension NameDescriptionInstallation CommandMinimum Subscription Type Requiredopenbb-benzingaBenzingadata connectorpip install openbb-benzingaPaidopenbb-biztocBiztocNews data connectorpip install openbb-biztocFreeopenbb-ecbECBdata connectorpip install openbb-ecbFreeopenbb-finraFINRAdata connectorpip install openbb-finraFreeopenbb-finvizFinvizdata connectorpip install openbb-finraFreeopenbb-fmpFMPdata connectorpip install openbb-fmpFreeopenbb-fredFREDdata connectorpip install openbb-fredFreeopenbb-intrinioIntriniodata connectorpip install openbb-intrinioPaidopenbb-oecdOECDdata connectorpip install openbb-oecdFreeopenbb-polygonPolygondata connectorpip install openbb-polygonFreeopenbb-secSECdata connectorpip install openbb-secFreeopenbb-tiingoTiingodata connectorpip install openbb-tiingoFreeopenbb-tradingeconomicsTradingEconomicsdata connectorpip install openbb-tradingeconomicsPaidTo install extensions that expand the core functionalities specify the extension name or useallto install all.# Install a single extension, e.g. openbb-charting and yahoo financepipinstallopenbb[charting]pipinstallopenbb-yfinanceAlternatively, you can install all extensions at once.pipinstallopenbb[all]Note: These instruction are specific to v4. For installation instructions and documentation for v3 go to ourwebsite.Python>>>fromopenbbimportobb>>>output=obb.equity.price.historical("AAPL")>>>df=output.to_dataframe()>>>df.head()openhighlow...change_percentlabelchange_over_timedate...2022-09-19149.31154.56149.10...3.46000September19,220.0346002022-09-20153.40158.08153.08...2.28000September20,220.0228002022-09-21157.34158.74153.60...-2.30000September21,22-0.0230002022-09-22152.38154.47150.91...0.23625September22,220.0023632022-09-23151.19151.47148.56...-0.50268September23,22-0.005027[5rowsx12columns]API keysTo fully leverage the OpenBB Platform you need to get some API keys to connect with data providers. Here are the 3 options on where to set them:OpenBB HubRuntimeLocal file1. OpenBB HubSet your keys atOpenBB Huband get your personal access token fromhttps://my.openbb.co/app/sdk/patto connect with your account.>>>fromopenbbimportobb>>>openbb.account.login(pat="OPENBB_PAT")>>># Persist changes in OpenBB Hub>>>obb.account.save()2. Runtime>>>fromopenbbimportobb>>>obb.user.credentials.fmp_api_key="REPLACE_ME">>>obb.user.credentials.polygon_api_key="REPLACE_ME">>># Persist changes in ~/.openbb_platform/user_settings.json>>>obb.account.save()3. Local fileYou can specify the keys directly in the~/.openbb_platform/user_settings.jsonfile.Populate this file with the following template and replace the values with your keys:{"credentials":{"fmp_api_key":"REPLACE_ME","polygon_api_key":"REPLACE_ME","benzinga_api_key":"REPLACE_ME","fred_api_key":"REPLACE_ME"}}REST APIThe OpenBB Platform comes with a ready to use REST API built with FastAPI. Start the application using this command:uvicornopenbb_core.api.rest_api:app--host0.0.0.0--port8000--reloadCheckopenbb-coreREADMEfor additional info.Install for developmentTo develop the OpenBB Platform you need to have the following:GitPython 3.8 or higherVirtual Environment withpoetryandtomlpackages installedTo install these packages activate your virtual environment and runpip install poetry tomlHow to install the platform in editable mode?Activate your virtual environmentNavigate into theopenbb_platformfolderRunpython dev_install.pyto install the packages in editable mode