mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-28 13:01:38 +00:00
bae3225070
* Test * Test * Update to 'Load' feature description on HugoServer * Grammar correction. * Revision 1 - Formatting changes. * Revision 2 - Updated Image * Updated description; added image. * Changed wording. * Updated text and image * Added text and Image * updated image * Updated image * updated link * Updated Image * Updated Image * Updated image, updated source URL * Updated image * Added Image * Added Image, updated text. * Updated text and image. * Added screenshot; updated text. * Added image; updated text * added image; updated source link. * Updated Image and source URL * Updated text/URL * added image/updated URL * Added image/source URL * added image/updated URL * Added Images/updated description * updated text * Updated text/added images * Added images/updated text * added image/updated source URL * Added images/updated text and source URLs * Added Image/Source URL * added image/updated text and source URL * added images/updated source URL * Added Images/Updated Text/Source URL * updated text/image * Update _index.md * Updated Source URL * Updated source URL * Update _index.md * Updated Source URL * updated source URL * Update _index.md * Updated Source URL * Updated images/source URL * Updated Source URL * added image/updated source url * Updated description/source URL * Updated description/source URL * Update _index.md * Update _index.md * Update _index.md * Update _index.md * Update _index.md * Update _index.md * Updated source URL * Updated description * Updated description. * Updated description. * Updated description. * Updated description. * Updated description * Updated description. * Updated description. * Updated description. * Updated description. * Updated description. * Update _index.md * Updated description/added image. * Updated description. * updated description. * Update _index.md * Delete folder for merge conflict * Removed re: "/stocks/discover/latest" * Spelling * Spelling * Updated description/added images. * added image/updated description. * added image/updated description * Updated URL * updated image/source URL * Updated source URL * Updated image/source URL * Updated image/source URL * Updated image/source URL * Updated Source URL * updated description * added image/updated source URL * Updated description with sample output text/added link to explanation of process. * Added image/updated text/source URL * added image/updated text/source URL * added image/updated text/source URL * Updated Text * Updated text * added image/updated description/source URL * Added image/updated description/source URL * Added Image/updated text * added image/updated text/source URL * Added image/updated text * added image * updated text. * Added image/updated text * added image * feature/command no longer exists * Added image/updated source URL * Added Image/updated URL * Added image * Updated text * added image/updated URL * For premium members only. * Added Image/Updated description. * Added image/updated URL * Added image/updated URL * Added image/updated source URL * Added image/updated URL * updated text * Added image/updated source URL * command does not exist. * replacing accidental deletion * Added image/updated URL * Added image/updated URL * Added Images * added image * Added image * Added image. * Updated text. * Updated text * added image. * updated text * added image * Spelling * Spelling * Spelling * Added image/source URL Co-authored-by: jmaslek <jmaslek11@gmail.com>
34 lines
2.6 KiB
Markdown
Executable File
Vendored
34 lines
2.6 KiB
Markdown
Executable File
Vendored
```
|
|
usage: load [-t S_TICKER] [-s S_START_DATE] [-e S_END_DATE] [-i {1,5,15,30,60}] [--source {yf,av,iex}] [-p] [-h]
|
|
```
|
|
|
|
Load a symbol to perform analysis using the string above as a template. Optional arguments and their descriptions are listed above.
|
|
|
|
The default source is, yFinance (https://pypi.org/project/yfinance/). Alternatively, one may select either AlphaVantage (https://www.alphavantage.co/documentation/) or IEX Cloud (https://iexcloud.io/docs/api/) as the data source for the analysis. Please note that certain analytical features are exclusive to the source.
|
|
|
|
To load a symbol from an exchange outside of the NYSE/NASDAQ default, use yFinance as the source and add the corresponding exchange to the end of the symbol. i.e. 'BNS.TO'.
|
|
|
|
BNS is a dual-listed stock, there are separate options chains and order books for each listing. Opportunities for arbitrage may arise from momentary pricing discrepancies between listings with a dynamic exchange rate as a second order opportunity in ForEx spreads.
|
|
|
|
Find the full list of supported exchanges here: https://help.yahoo.com/kb/exchanges-data-providers-yahoo-finance-sln2310.html
|
|
|
|
Certain analytical features, such as VWAP, require the ticker to be loaded as intraday using the '-i x' argument. When encountering this error, simply reload the symbol using the interval argument. i.e. 'load -t BNS -s YYYY-MM-DD -i 1 -p' loads one-minute intervals, including Pre/After Market data, using the default source, yFinance.
|
|
|
|
Certain features, such as the Prediction menu, require the symbol to be loaded as daily and not intraday.
|
|
|
|
```
|
|
optional arguments:
|
|
-t S_TICKER, --ticker S_TICKER
|
|
Stock ticker (default: None)
|
|
-s S_START_DATE, --start S_START_DATE
|
|
The starting date (format YYYY-MM-DD) of the stock (default: 2020-11-07)
|
|
-e S_END_DATE, --end S_END_DATE
|
|
The ending date (format YYYY-MM-DD) of the stock (default: 2021-11-08)
|
|
-i {1,5,15,30,60}, --interval {1,5,15,30,60}
|
|
Intraday stock minutes (default: 1440)
|
|
--source {yf,av,iex} Source of historical data. (default: yf)
|
|
-p, --prepost Pre/After market hours. Only works for 'yf' source, and intraday data (default: False)
|
|
-h, --help show this help message (default: False)
|
|
```
|
|
<img width="1400" alt="Feature Screenshot - Load" src="https://user-images.githubusercontent.com/85772166/139967994-82e42c75-3ff5-4a04-80a2-c9c9b870934c.png">
|
|
<img width="1400" alt="Feature Screenshot - Load" src="https://user-images.githubusercontent.com/85772166/139967994-82e42c75-3ff5-4a04-80a2-c9c9b870934c.png"> |