jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-03 07:51:49 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
cd08218c35aed534ad59309ff2ca99d08e94de6a
OpenBB/website/content/sdk/reference/etf/scr/screen.md
DidierRLopes 4ad995fdd0 Docs/terminalpro and improvement (#5622) 
* 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>
2023-10-30 21:01:29 +00:00

2.1 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
screen This page of the documentation is dedicated to the OpenBB's etf screener; it provides an overview of the functionality, parameters, and return types for two core methods: the ETF 'screen' and 'screen_chart' functions. The website guides the users through the use of these functions as well as their source code, helping them better understand and utilize the ETF screener.
ETF screening
Source code
ETF scraping
Data sorting
Data visualization
Financial data analysis
Data export

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Screens the etfs pulled from my repo (https://github.com/jmaslek/etf_scraper),

Source Code: [link]

openbb.etf.scr.screen(preset: str)

Parameters

Name Type Description Default Optional
preset str Screener to use from presets None False

Returns

Type Description
pd.DataFrame Screened dataframe

Display screener output

Source Code: [link]

openbb.etf.scr.screen_chart(preset: str, num_to_show: int, sortby: str, ascend: bool, export: str = "")

Parameters

Name Type Description Default Optional
preset str Preset to use None False
num_to_show int Number of etfs to show None False
sortby str Column to sort by None False
ascend bool Ascend when sorted None False
export str Output format of export True

Returns

This function does not return anything