mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-16 06:11:57 +00:00
* Adding versioning to docs --------- Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com> Co-authored-by: tehcoderer <me@tehcoderer.com>
1.5 KiB
Vendored
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