mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-03 07:51:49 +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>
39 lines
1009 B
Markdown
Vendored
39 lines
1009 B
Markdown
Vendored
---
|
|
title: whatif
|
|
description: Learn about the 'whatif' command line tool which provides a hypothetical
|
|
scenario of having bought a certain number of shares on a specific date. This tool
|
|
can be used for backward investment analysis and scenario planning.
|
|
keywords:
|
|
- whatif
|
|
- shares
|
|
- share trading
|
|
- investment scenario
|
|
- investment analysis
|
|
- command line tool
|
|
- DATE_SHARES_ACQUIRED
|
|
- NUM_SHARES_ACQUIRED
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="stocks/backtesting/whatif - Reference | OpenBB Terminal Docs" />
|
|
|
|
Displays what if scenario of having bought X shares at date Y
|
|
|
|
### Usage
|
|
|
|
```python
|
|
whatif [-d DATE_SHARES_ACQUIRED] [-n NUM_SHARES_ACQUIRED]
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Description | Default | Optional | Choices |
|
|
| ---- | ----------- | ------- | -------- | ------- |
|
|
| date_shares_acquired | Date at which the shares were acquired | None | True | None |
|
|
| num_shares_acquired | Number of shares acquired | 1.0 | True | None |
|
|
|
|
---
|