jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-09 10:51:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update docs for the load command (#1941)

Browse Source
This commit is contained in:
Sam Kerr
2022-06-13 14:17:46 -04:00
committed by GitHub
parent a89b3dca61
commit 9a79e9e992
1 changed files with 24 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
website/content/terminal/portfolio/load/_index.md vendored
View File

@@ -1,10 +1,6 @@
```
usage: load [-f {}] [-n NAME] [-r RISK_FREE_RATE] [-h]
```
Load your portfolio
```
optional arguments:
-f {}, --file {}
The file to be loaded (default: None)
@@ -15,6 +11,29 @@ optional arguments:
```
Load your portfolio for analysis.
This command works by taking in a list of trades you have made and constructs the resulting portfolio from them. It can accept either an Excel or CSV file with this information. Each row in the file should have the following information:
Required:
* Date - The date the trade occurred
* Name - The name of the security
* Type - The type of the security. Use `Cash`/`Stock`/`Crypto`/`ETF` as appropriate
* Price - The price the security was added or removed at, on a per-unit basis
* Quantity - How much of the security in question was added or removed
* Side - Whether or not you bought or sold. Use `Buy`/`Deposit`/`1` to add to the portfolio or `Sell`/`Withdrawal`/`0` to remove from the portfolio
Optional:
* Investment - Total value of the investment, less any fees. Calculated dynamically as price * quantity by the terminal
* Fees - Any fees paid as part of the transaction
* Premium - Any premiums received or paid
* Quantity - How much of the security in question was added or removed
* Currency - The currency the transaction was made in
* Sector - The sector of the security. Required for `alloc` commands
* Industry - The industry of the security. Required for `alloc` commands
* Country - The country of the security. Required for `alloc` commands
Example:
```
2022 May 13, 05:00 (🦋) /portfolio/ $ load Public_Equity_Orderbook.xlsx
@@ -106,4 +125,4 @@ Risk Free Rate: 0.00%
├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤
│ 2022-05-02 │ YUM │ STOCK │ Consumer Cyclical │ Restaurants │ United States │ North America │ 115.76 │ 11 │ 40 │ 0 │ 1273.36 │ 1 │ USD │
└────────────┴───────┴───────┴────────────────────────┴─────────────────────────────────────┴───────────────┴───────────────┴──────────┴──────────┴──────┴─────────┴────────────┴──────┴──────────┘
```
```