Files
OpenBB/website/versioned_docs/version-v3/sdk/reference/etf/scr/screen.md
Theodore Aptekarev f72bc8ccec Add Versioned Documentation (#5470)
* Adding versioning to docs

---------

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: tehcoderer <me@tehcoderer.com>
2023-09-29 11:49:05 +02:00

1.5 KiB
Vendored

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