mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-01 23:12:21 +00:00
4ad995fdd0
* 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>
34 KiB
Vendored
34 KiB
Vendored
title, description, keywords
| title | description | keywords | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| load | The 'load' function allows users to load their portfolio transactions from a given file, optionally assigning a name and setting a risk-free rate. The loaded portfolio details will be presented in a detailed table showcasing each transaction. |
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
Load your portfolio transactions.
Usage
load -f FILE [-n NAME] [-r RISK_FREE_RATE]
Parameters
| Name | Description | Default | Optional | Choices |
|---|---|---|---|---|
| file | The file to be loaded | None | False | Public_Equity_Orderbook.xlsx, Public_Equity_Orderbook_No_Categorization.xlsx, bitcoin.csv, example.csv, market.csv |
| name | The name that you wish to give to your portfolio | None | True | None |
| risk_free_rate | Set the risk free rate. | 0 | True | None |
Examples
2022 May 13, 05:00 (🦋) /portfolio/ $ load Public_Equity_Orderbook.xlsx
Portfolio: Public_Equity_Orderbook.xlsx
Risk Free Rate: 0.00%
2022 May 13, 05:00 (🦋) /portfolio/ $ show
┏━━━━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━┳━━━━━━━━━━┓
┃ Date ┃ Name ┃ Type ┃ Sector ┃ Industry ┃ Country ┃ Region ┃ Price ┃ Quantity ┃ Fees ┃ Premium ┃ Investment ┃ Side ┃ Currency ┃
┡━━━━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━╇━━━━━━━━━━┩
│ 2010-05-03 │ CASH │ CASH │ CASH │ CASH │ CASH │ Unknown │ 60850.00 │ 1 │ 0 │ 0 │ 60850.00 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2010-05-03 │ GOOGL │ STOCK │ Communication Services │ Internet Content & Information │ United States │ North America │ 265.30 │ 2 │ 5 │ 6 │ 530.60 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2010-07-06 │ AMZN │ STOCK │ Technology │ Internet Retail │ United States │ North America │ 110.06 │ 5 │ 3 │ 3 │ 550.30 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2011-08-06 │ AAPL │ STOCK │ Technology │ Consumer Electronics │ United States │ North America │ 12.61 │ 3 │ 1 │ 0 │ 37.83 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2011-12-12 │ APTV │ STOCK │ Consumer Cyclical │ Auto Parts │ United States │ North America │ 18.02 │ 5 │ 0 │ 2 │ 90.10 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2012-02-03 │ ASML │ STOCK │ Technology │ Semiconductor Equipment & Materials │ Netherlands │ Europe │ 59.17 │ 7 │ 0 │ 4 │ 414.19 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2012-05-04 │ NKE │ STOCK │ Consumer Cyclical │ Footwear & Accessories │ Germany │ Europe │ 27.95 │ 3 │ 0 │ 0 │ 83.85 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2012-08-04 │ TSM │ STOCK │ Technology │ Semiconductors │ Taiwan │ Asia │ 14.24 │ 50 │ 0 │ 0 │ 712.00 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2012-10-12 │ DGX │ STOCK │ Healthcare │ Diagnostics & Research │ United States │ North America │ 63.39 │ 6 │ 10 │ 0 │ 380.34 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2013-02-03 │ YUM │ STOCK │ Consumer Cyclical │ Restaurants │ United States │ North America │ 45.98 │ 4 │ 10 │ 0 │ 183.92 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2013-03-04 │ GOOGL │ STOCK │ Communication Services │ Internet Content & Information │ United States │ North America │ 410.75 │ 1 │ 100 │ 2 │ 410.75 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2013-08-08 │ AMZN │ STOCK │ Technology │ Internet Retail │ United States │ North America │ 295.74 │ 1 │ 2 │ 3 │ 295.74 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2013-10-09 │ AAPL │ STOCK │ Technology │ Consumer Electronics │ United States │ North America │ 17.38 │ 5 │ 5 │ 5 │ 86.90 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2014-02-03 │ APTV │ STOCK │ Consumer Cyclical │ Auto Parts │ United States │ North America │ 49.53 │ 5 │ 4 │ 0 │ 247.65 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2014-02-05 │ ASML │ STOCK │ Technology │ Semiconductor Equipment & Materials │ Netherlands │ Europe │ 85.16 │ 3 │ 3 │ 0 │ 255.48 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2014-12-08 │ NKE │ STOCK │ Consumer Cyclical │ Footwear & Accessories │ Germany │ Europe │ 48.86 │ 10 │ 2 │ 0 │ 488.60 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2015-02-02 │ BABA │ STOCK │ Consumer Cyclical │ Internet Retail │ China │ Asia │ 90.13 │ 30 │ 1 │ 0 │ 2703.90 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2015-03-08 │ TSM │ STOCK │ Technology │ Semiconductors │ Taiwan │ Asia │ 23.45 │ 20 │ 6 │ 0 │ 469.00 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2015-12-05 │ DGX │ STOCK │ Healthcare │ Diagnostics & Research │ United States │ North America │ 68.83 │ 21 │ 2 │ 3 │ 1445.43 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2016-02-06 │ YUM │ STOCK │ Consumer Cyclical │ Restaurants │ United States │ North America │ 48.49 │ 2 │ 4 │ 1 │ 96.98 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2016-09-07 │ GOOGL │ STOCK │ Communication Services │ Internet Content & Information │ United States │ North America │ 807.99 │ 2 │ 0 │ 2 │ 1615.98 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2017-01-10 │ AMZN │ STOCK │ Technology │ Internet Retail │ United States │ North America │ 795.90 │ 2 │ 0 │ 0 │ 1591.80 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2017-05-10 │ AAPL │ STOCK │ Technology │ Consumer Electronics │ United States │ North America │ 38.32 │ 10 │ 0 │ 0 │ 383.20 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2017-12-08 │ APTV │ STOCK │ Consumer Cyclical │ Auto Parts │ United States │ North America │ 85.22 │ 10 │ 4 │ 0 │ 852.20 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2018-07-05 │ ASML │ STOCK │ Technology │ Semiconductor Equipment & Materials │ Netherlands │ Europe │ 195.99 │ 5 │ 2 │ 5 │ 979.95 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2018-09-03 │ NKE │ STOCK │ Consumer Cyclical │ Footwear & Accessories │ Germany │ Europe │ 79.60 │ 3 │ 2 │ 4 │ 238.80 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2019-05-04 │ BABA │ STOCK │ Consumer Cyclical │ Internet Retail │ China │ Asia │ 188.24 │ 5 │ 1 │ 2 │ 941.20 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2019-09-09 │ TSM │ STOCK │ Technology │ Semiconductors │ Taiwan │ Asia │ 43.85 │ 3 │ 6 │ 7 │ 131.55 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2019-12-10 │ DGX │ STOCK │ Healthcare │ Diagnostics & Research │ United States │ North America │ 104.94 │ 8 │ 1 │ 4 │ 839.52 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2020-02-03 │ YUM │ STOCK │ Consumer Cyclical │ Restaurants │ United States │ North America │ 106.41 │ 10 │ 10 │ 2 │ 1064.10 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2020-03-08 │ GOOGL │ STOCK │ Communication Services │ Internet Content & Information │ United States │ North America │ 1215.79 │ 3 │ 10 │ 2 │ 3647.37 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2020-06-09 │ AMZN │ STOCK │ Technology │ Internet Retail │ United States │ North America │ 2600.86 │ 2 │ 200 │ 20 │ 5201.72 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2020-12-12 │ AAPL │ STOCK │ Technology │ Consumer Electronics │ United States │ North America │ 121.78 │ 4 │ 10 │ 0 │ 487.12 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2021-01-07 │ APTV │ STOCK │ Consumer Cyclical │ Auto Parts │ United States │ North America │ 144.80 │ 20 │ 10 │ 6 │ 2896.00 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2021-05-06 │ ASML │ STOCK │ Technology │ Semiconductor Equipment & Materials │ Netherlands │ Europe │ 644.34 │ 30 │ 10 │ 3 │ 19330.20 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2021-12-28 │ NKE │ STOCK │ Consumer Cyclical │ Footwear & Accessories │ Germany │ Europe │ 166.42 │ 13 │ 20 │ 3 │ 2163.46 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2022-02-02 │ BABA │ STOCK │ Consumer Cyclical │ Internet Retail │ China │ Asia │ 122.88 │ 30 │ 0 │ 1 │ 3686.40 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2022-03-04 │ TSM │ STOCK │ Technology │ Semiconductors │ Taiwan │ Asia │ 105.06 │ 30 │ 0 │ 2 │ 3151.80 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2022-04-12 │ DGX │ STOCK │ Healthcare │ Diagnostics & Research │ United States │ North America │ 137.27 │ 10 │ 30 │ 1 │ 1372.70 │ 1 │ USD │
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2022-05-02 │ YUM │ STOCK │ Consumer Cyclical │ Restaurants │ United States │ North America │ 115.76 │ 11 │ 40 │ 0 │ 1273.36 │ 1 │ USD │
└────────────┴───────┴───────┴────────────────────────┴─────────────────────────────────────┴───────────────┴───────────────┴──────────┴──────────┴──────┴─────────┴────────────┴──────┴──────────┘