diff --git a/openbb_terminal/sdk_core/models/stocks_sdk_model.py b/openbb_terminal/sdk_core/models/stocks_sdk_model.py index 0d8309323d1..d4b4194f38f 100644 --- a/openbb_terminal/sdk_core/models/stocks_sdk_model.py +++ b/openbb_terminal/sdk_core/models/stocks_sdk_model.py @@ -455,9 +455,6 @@ class StocksInsiders(Category): class StocksOptions(Category): """Options Module. - Submodules: - `screen`: Screen Module - Attributes: `chains`: Get Option Chain For A Stock. No greek data is returned\n `dte`: Gets days to expiration from yfinance option date\n @@ -474,6 +471,7 @@ class StocksOptions(Category): `pcr`: Gets put call ratio over last time window [Source: AlphaQuery.com]\n `pcr_chart`: Display put call ratio [Source: AlphaQuery.com]\n `price`: Get Option current price for a stock.\n + `screen`: Equity options screener [Source: Syncretism]\n `unu`: Get unusual option activity from fdscanner.com\n `unu_chart`: Displays the unusual options table\n `voi`: Plot volume and open interest\n @@ -504,6 +502,7 @@ class StocksOptions(Category): self.pcr = lib.stocks_options_alphaquery_model.get_put_call_ratio self.pcr_chart = lib.stocks_options_alphaquery_view.display_put_call_ratio self.price = lib.stocks_options_sdk_helper.get_option_current_price + self.screen = lib.stocks_options_screen_syncretism_model.get_screener_output self.unu = lib.stocks_options_fdscanner_model.unusual_options self.unu_chart = lib.stocks_options_fdscanner_view.display_options self.voi = lib.stocks_options_view.plot_voi diff --git a/openbb_terminal/sdk_core/trail_map.csv b/openbb_terminal/sdk_core/trail_map.csv index bc3b075882c..1d60b649d4d 100644 --- a/openbb_terminal/sdk_core/trail_map.csv +++ b/openbb_terminal/sdk_core/trail_map.csv @@ -505,8 +505,7 @@ stocks.options.last_price,stocks_options_tradier_model.get_last_price, stocks.options.oi,stocks_options_view.plot_oi, stocks.options.pcr,stocks_options_alphaquery_model.get_put_call_ratio,stocks_options_alphaquery_view.display_put_call_ratio stocks.options.price,stocks_options_sdk_helper.get_option_current_price, -stocks.options.screen.check_presets,stocks_options_screen_syncretism_model.check_presets, -stocks.options.screen.screener_output,stocks_options_screen_syncretism_model.get_screener_output,stocks_options_screen_syncretism_view.view_screener_output +stocks.options.screen,stocks_options_screen_syncretism_model.get_screener_output, stocks.options.unu,stocks_options_fdscanner_model.unusual_options,stocks_options_fdscanner_view.display_options stocks.options.voi,stocks_options_view.plot_voi, stocks.options.vol,stocks_options_view.plot_vol, diff --git a/openbb_terminal/stocks/options/screen/syncretism_model.py b/openbb_terminal/stocks/options/screen/syncretism_model.py index d8cde3bee76..45516d61696 100644 --- a/openbb_terminal/stocks/options/screen/syncretism_model.py +++ b/openbb_terminal/stocks/options/screen/syncretism_model.py @@ -139,12 +139,12 @@ def get_preset_choices() -> Dict: @log_start_end(log=logger) -def get_screener_output(preset: str) -> Tuple[pd.DataFrame, str]: +def get_screener_output(preset: str = "high_iv.ini") -> Tuple[pd.DataFrame, str]: """Screen options based on preset filters Parameters ---------- - preset: str + preset: str [default: "high_iv.ini"] Chosen preset Returns -------