[Feature] Add Finviz Screener Presets (V3 Compatible)

[deeleeramone]

1. Why?:

   • Porting a popular Terminal/V3 feature to Platform.
   • See Feature/finviz screener #6586 for discussion and implementation requirements.

2. What?:

Below is copied from the README.md

Screener

The screener is a faithful replication of the public-facing stock screener - https://finviz.com/screener.ashx?

Some options are directly accessible through the function parameters, all others are exposed via presets or filters_dict.
The filters list below are exposed in the function, with choices visible in the docstring:

• exchange
• index
• sector
• industry
• mktcap
• recommendation (analyst's mean score from 1-5)
• signal (same as the "Signal" on the Finviz page)

When the function is run without any parameters, it will default to the "top_gainers" signal.

res = obb.equity.screener(provider="finviz")

Metric

The metric parameter defines the type of data fields to return. Choices are:

• overview
• ownership
• performance
• techincal
• valuation

Default is, "overview".

res = obb.equity.screener(provider="finviz", metric="performance")

Preset Files

Presets can be created and customized in the "OpenBBUserData" folder. Template and default presets are created on the first run of the function.

Files are loaded on run time, changes are effective without restarting the Python interpreter.

The preset parameter will override all others, except metric and limit.

Run the function to create the template and default presets in your OpenBBUserData folder.

Presets from the legacy OpenBB Terminal will continue to work, simply move your presets into the folder below.

res = obb.equity.screener(provider="finviz", index="nasdaq")

Then find the presets here: $HOME/OpenBBUserData/presets/finviz

res = obb.equity.screener(provider="finviz", preset="short_squeeze")

Filters Dict

The filters_dict parameter acts as an alternative to preset, accepting a dictionary or JSON encoded string.

res = obb.equity.screener(provider="finviz", filters_dict={"Index": "NASDAQ 100"})

Or as a JSON:

res = obb.equity.screener(provider="finviz", filters_dict='{"Index": "NASDAQ 100"}')

When using the Fast API, this is sent in the request body.

Error Messages

All parameters are validated, incorrect keys and choices will raise an error with information to help correct. For example:

obb.equity.screener(provider="finviz", filters_dict='{"Index": "NASDAQ"}')

Invalid filter option 'NASDAQ'. Possible filter options: ['Any', 'S&P 500', 'NASDAQ 100', 'DJIA', 'RUSSELL 2000']

3. Impact:

   • The function will attempt to read/write to the file system in order to populate the user data folder.
   • Makes the function's docstring substantially larger.

4. Testing Done:

   • Unit/integration tests.
   • CLI

5. Reviewer Notes:

   • To test the function directly from the Swagger docs, the contents of the "Request Body" must be deleted.

[mmistroni]

Brilliant! works as a charm! when will be available via pip? i guess i'll have to install a new version of openbb-finviz?
tried also the REST API.. works fine but the filter_dict params cannot be used.. seems because the method is a GET it does not allow a body? i guess this is expected..
Kind regards
Marco

[yolotrader]

@IgorWounds I'm getting the following error when running the preset:

Could you pls take a look?

Thank you for this great work, btw!

[mmistroni]

uh, thats my preset :( i'll have a look at it tomorrow morning.... sorry about this Kind regards Marco

…

On Thu, Aug 29, 2024 at 6:24 PM yolotrader ***@***.***> wrote: @IgorWounds <https://github.com/IgorWounds> I'm getting the following error when running the preset: Screenshot.2024-08-29.at.10.19.54.AM.png (view on web) <https://github.com/user-attachments/assets/d91ee2f5-a458-4c68-a5c7-4c46197439f1> Could you pls take a look? Thank you for this great work, btw! — Reply to this email directly, view it on GitHub <#6601 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACPNCDWH7FEN3BEYTXP5ED3ZT5KNLAVCNFSM6AAAAABLUSP3NGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGMJYGQZTMOJXGE> . You are receiving this because you commented.Message ID: ***@***.***>

[mmistroni]

@yolotrader that's just a warning, which is controlled by your preferences

"preferences" : {
"output_type" : "dataframe",
"show_warnings" : "False"

}

if you print out the result you will see data
Note, you will see this warningr for any presets you use..

hth

[yolotrader]

@mmistroni thanks!