jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-28 21:12:16 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
f68929fa1efaa5e9abb7911029e287c975b37fd3
OpenBB/website/content/sdk/reference/etf/scr/screen.md
jose-donato 2e7eb4c9b6 New documentation website (#3526) 
* fix(docs): added margin between sections

* feat: removed unused files; updated ga

* fix: juan stuff doesnt work

* fix: random fix

* moon at noon

* fix: update docusaurus config

* Update controller_doc_classes.py

* fix: temp fix

* fix: temp fix

* Update controller_doc_classes.py

* fix: remove old content

* fix: taggfix

* init

* fix: styling and moved file

* Update generate_terminal_markdown.py

* fix: removed unused images

* fix: port new files

* Update generate_sdk_markdown.py

* Update controller_doc_classes.py

Co-authored-by: teh_coderer <me@tehcoderer.com>
2022-11-22 16:47:03 +00:00

1.5 KiB
Vendored
Raw Blame History

title, description
title description
screen OpenBB SDK Function

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

screen

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