mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-03 16:02:04 +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>
41 lines
1.4 KiB
Markdown
Vendored
41 lines
1.4 KiB
Markdown
Vendored
---
|
|
title: pir
|
|
description: Create comprehensive ETF excel reports using the passive investor ETF
|
|
tool 'pir'. This tool generates a detailed report containing significant metrics
|
|
about any ETFs obtained from Yahoo Finance. Modifiable parameters include the ETF
|
|
symbols, report filename, and save location.
|
|
keywords:
|
|
- passive investor ETF
|
|
- ETF excel report
|
|
- Yahoo Finance ETF metrics
|
|
- ETF report generation
|
|
- OpenBBUserData
|
|
- Python programming
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="etf /pir - Reference | OpenBB Terminal Docs" />
|
|
|
|
Create passive investor ETF excel report which contains most of the important metrics about an ETF obtained from Yahoo Finnace. You are able to input any ETF ticker you like within the command to create am extensive report
|
|
|
|
### Usage
|
|
|
|
```python
|
|
pir [-e NAMES] [--filename FILENAME] [--folder FOLDER]
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Description | Default | Optional | Choices |
|
|
| ---- | ----------- | ------- | -------- | ------- |
|
|
| names | Symbols to create a report for (e.g. pir ARKW ARKQ QQQ VOO) | | True | None |
|
|
| filename | Filename of the excel ETF report | ETF_report_20221125_164801 | True | None |
|
|
| folder | Folder where the excel ETF report will be saved | /home/runner/OpenBBUserData/exports | True | None |
|
|
|
|
|
|
|
|
---
|