jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-08 02:11:44 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
4ad995fdd0b0719cde5bb2cec540db01b24d9ff0
OpenBB/website/content/terminal/usage/data/custom-data.md
DidierRLopes 4ad995fdd0 Docs/terminalpro and improvement (#5622) 
* add first iteration of content for Terminal Pro

* Update index.md

* Update dashboards.md

* Update folders.md

* Update grouping.md

* Update report.md

* Update templates.md

* Update quick-start.md

* Update index.md

* Update index.md

* Update home.md

* Update news.md

* Update index.md

* Update index.md

* Update index.md

* Update data-provider.md

* Update chat-with-widget.md

* Update data-manipulation.md

* Update forecasting.md

* fix: images self closing tags

* fix: only pro visitors can see pro

* inter font

* improve SEO content and restructuring

* add new package for toggle on tutorials

* move folder around

* improve main page of each prod

* small updates and improvements

* fix logo above

* small improvement in headtitle for portfolio funcs

* fix typos from OpenAI's GPT-4

* fix _category_ json

* remove generic SEO words

* add script that generates SEO for documentation

* add missing file

* remove sdk warning message

* fix links for andrew

---------

Co-authored-by: jose-donato <zmcdonato@gmail.com>
Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>
Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
2023-10-30 21:01:29 +00:00

3.2 KiB
Vendored
Raw Blame History

title, sidebar_position, description, keywords
title sidebar_position description keywords
Custom Data 3 Documentation detailing usage of the OpenBB Terminal for financial data aggregation, standardization, and user data import. It explains the OpenBBUserData folder functions, how to modify settings, and how to import or export user data.
financial data
data aggregation
data standardization
OpenBBUserData folder
import data
export data
Econometrics
Portfolio
Portfolio Optimization
settings menu
export folder location
userdata command
user-created files

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

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: 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 Portfolio, 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

  • The Econometrics /econometrics menu looks into the exports and custom_imports/econometrics folder.
  • The Portfolio /portfolio menu looks into the portfolio/holdings folder
  • The Portfolio Optimization /portfolio/po menu looks into the portfolio/allocation folder for the load command; and into the portfolio/optimization folder for the file command.

Please make sure to read the relevant guides to understand how this works.