mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-04 08:22:26 +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>
42 lines
1.3 KiB
Markdown
Vendored
42 lines
1.3 KiB
Markdown
Vendored
---
|
|
title: screen
|
|
description: Documentation for the ETF screen tool, a command-line Python application
|
|
that scrapes and sorts data from stockanalysis.com. The tool offers various sorting
|
|
options, including by assets, expense, and volume, among others.
|
|
keywords:
|
|
- ETF Screen
|
|
- Stock Analysis
|
|
- Data Scraping
|
|
- Github Repository
|
|
- CLI
|
|
- Parameters
|
|
- Sort
|
|
- Limit
|
|
- Reverse
|
|
- Financial Data
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="etf/screener/screen - Reference | OpenBB Terminal Docs" />
|
|
|
|
Screens ETFS from a personal scraping github repository. Data scraped from stockanalysis.com
|
|
|
|
### Usage
|
|
|
|
```python
|
|
screen [-l LIMIT] [-s {Assets,NAV,Expense,PE,SharesOut,Div,DivYield,Volume,Open,PrevClose,YrLow,YrHigh,Beta,N_Hold}] [-r]
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Description | Default | Optional | Choices |
|
|
| ---- | ----------- | ------- | -------- | ------- |
|
|
| limit | Limit of etfs to display | 10 | True | None |
|
|
| sortby | Sort by given column. Default: Assets | Assets | True | Assets, NAV, Expense, PE, SharesOut, Div, DivYield, Volume, Open, PrevClose, YrLow, YrHigh, Beta, N_Hold |
|
|
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
|
|
|
|
---
|