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>
79 lines
2.3 KiB
Markdown
Vendored
79 lines
2.3 KiB
Markdown
Vendored
---
|
|
title: load
|
|
description: This documentation page provides detailed information on how to load
|
|
stock tickers using various parameters for analysis. Users can customize their usage
|
|
through options like start and end dates, interval, pre/after market hours, load
|
|
monthly or weekly data, among others.
|
|
keywords:
|
|
- Stock Analysis
|
|
- Load Stock Tickers
|
|
- Investment Analysis
|
|
- Financial Data
|
|
- Stock Market
|
|
- Yahoo Finance
|
|
- Custom Stock Data
|
|
- Intraday Stock
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="stocks /load - Reference | OpenBB Terminal Docs" />
|
|
|
|
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 |
|
|
|
|
---
|
|
|
|
## 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
|
|
```
|
|
---
|