mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-28 21:12:16 +00:00
79046608b6
* Update generate_terminal_markdown.py * updates * update workflows * Automated Change * tests * tests * Automated Change * Update test_generate_docs.py * Automated Change * updates * Automated Change * Update gen-docs.yml * Update test.yml * Automated Change * Update test.yml * Automated Change * Update generate_sdk_markdown.py * Automated Change * test * Automated Change * testtt23 * Automated Change * Update generate_sdk_markdown.py * Automated Change * Automated Change * added empting reference folders before autogen docs * updates * Automated Change * update tests gitactions * Automated Change * up * Automated Change * Automated Change * update pytest * Automated Change * tests * Automated Change * examples update * Automated Change * Update generate_sdk_markdown.py * Automated Change * Update test.yml * Update generate_sdk_markdown.py * strip * Automated Change * Workflow : check test update * Automated Change * Automated Change * Automated Change * Update test.yml * Automated Change * Update test.yml * Automated Change * Automated Change * up * Automated Change * Update generate_sdk_markdown.py * Automated Change * update workflows * fix guides * testing * Update gh-pages.yml * Update gh-pages.yml Co-authored-by: tehcoderer <tehcoderer@users.noreply.github.com> Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com> Co-authored-by: Chavithra PARANA <chavithra@gmail.com> Co-authored-by: Chavithra <Chavithra@users.noreply.github.com> Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: jose-donato <jose-donato@users.noreply.github.com>
67 lines
1.9 KiB
Markdown
Vendored
67 lines
1.9 KiB
Markdown
Vendored
---
|
|
title: load
|
|
description: OpenBB Terminal Function
|
|
---
|
|
|
|
# load
|
|
|
|
Load stock ticker to perform analysis on. When the data source is syf', an Indian ticker can be loaded by using '.NS' at the end, e.g. 'SBIN.NS'. See available market in https://help.yahoo.com/kb/exchanges-data-providers-yahoo-finance-sln2310.html.
|
|
|
|
### Usage
|
|
|
|
```python
|
|
load -t TICKER [-s START] [-e END] [-i {1,5,15,30,60}] [-p] [-f FILEPATH] [-m] [-w] [-r {ytd,1y,2y,5y,6m}]
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Description | Default | Optional | Choices |
|
|
| ---- | ----------- | ------- | -------- | ------- |
|
|
| ticker | Stock ticker | None | False | None |
|
|
| start | The starting date (format YYYY-MM-DD) of the stock | 2019-11-21 | True | None |
|
|
| end | The ending date (format YYYY-MM-DD) of the stock | 2022-11-25 | True | None |
|
|
| interval | Intraday stock minutes | 1440 | True | 1, 5, 15, 30, 60 |
|
|
| prepost | Pre/After market hours. Only works for 'yf' source, and intraday data | False | True | None |
|
|
| filepath | Path to load custom file. | None | True | None |
|
|
| monthly | Load monthly data | False | True | None |
|
|
| weekly | Load weekly data | False | True | None |
|
|
| iexrange | Range for using the iexcloud api. Longer range requires more tokens in account | ytd | True | ytd, 1y, 2y, 5y, 6m |
|
|
|
|
|
|
---
|
|
|
|
## Examples
|
|
|
|
```python
|
|
txt
|
|
2022 Feb 16, 08:29 (🦋) /stocks/ $ load TSLA
|
|
|
|
Loading Daily TSLA stock with starting period 2019-02-11 for analysis.
|
|
|
|
Datetime: 2022 Feb 16 08:30
|
|
Timezone: America/New_York
|
|
Currency: USD
|
|
Market: OPEN
|
|
|
|
2022 Feb 16, 08:30 (🦋) /stocks/ $ load AAPL
|
|
|
|
Loading Daily AAPL stock with starting period 2019-02-11 for analysis.
|
|
|
|
Datetime: 2022 Feb 16 08:30
|
|
Timezone: America/New_York
|
|
Currency: USD
|
|
Market: OPEN
|
|
|
|
2022 Feb 16, 08:30 (🦋) /stocks/ $ load AMZN
|
|
|
|
Loading Daily AMZN stock with starting period 2019-02-11 for analysis.
|
|
|
|
Datetime: 2022 Feb 16 08:30
|
|
Timezone: America/New_York
|
|
Currency: USD
|
|
Market: OPEN
|
|
```
|
|
---
|