Skip to main content

Custom Data

The OpenBB Terminal not only allows access to a world of financial data through our data aggregation and standardization. We also allow users to bring their own data to the terminal and export data.

The OpenBBUserData Folder​

The OpenBBUserData folder's default location is the home of the system user account. By default this will be the following paths:

  • macOS: Macintosh HD/Users/<YOUR_USERNAME>/OpenBBUserData
  • Windows: C:/Users/<YOUR_USERNAME>/OpenBBUserData

Within the folder you can find files that you have exported as well as files that you wish to import directly into the OpenBB Terminal. For example, this could be an orderbook which you can store in OpenBBUserData/portfolio/holdings.

OpenBBUserData Folder

This folder contains all things user-created. For example:

  • Screener presets
  • Portfolio files
  • Exported files
  • Files to be imported by various functions
  • Styles and themes
  • Preferred data sources
note

Note: With a WSL-enabled Windows installation, this folder will be under the Linux partition

Update export folder location​

The location of this folder can be set by the user from the /settings menu. There should be no need to update paths in this menu unless the folders have been moved manually. If the location of the OpenBBUserData folder must be changed, it is best to move the entire existing folder to the new path. The path is then changed under the settings menu with:

/settings/ $ userdata --folder "/complete_path_to/OpenBBUserData"

Import data​

Menus, such as Econometrics or Forecast, allow the user to import their own dataset. Files available to import will be included with the selections made available by auto-complete. In the Econometrics menu, this is activated after pressing the space bar with load -f

Importing Data

Both menus look in the exports and custom_imports folders within the /OpenBBUserData folder.

On this page