Files
OpenBB/openbb_terminal/stocks/options/alphaquery_view.py
James Maslek cf9b5ad832 Add nasdaq as an options source (#2397)
* Get all nasdaq chains

* Get all expirations

* Add chain by expiry and clean up columns

* add nasdaq to load and exp

* Add OI plot for nasdaq

* add volume plot

* Update vol + oi to have nasdaq + raw flag

* Add VOI functionality with nasdaq

* Add nasdaq chains function

* Run isort

* doesnt

* Change menu for sources and edit yfinance to expiration instead of expiry

* lint

* oops

* unused imports

Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt>
2022-08-23 09:35:18 +01:00

73 lines
2.0 KiB
Python

"""AlphaQuery View"""
__docforma__ = "numpy"
import logging
import os
from datetime import datetime, timedelta
from typing import List, Optional
import matplotlib.pyplot as plt
from openbb_terminal.config_plot import PLOT_DPI
from openbb_terminal.config_terminal import theme
from openbb_terminal.decorators import log_start_end
from openbb_terminal.helper_funcs import (
export_data,
is_valid_axes_count,
plot_autoscale,
)
from openbb_terminal.rich_config import console
from openbb_terminal.stocks.options import alphaquery_model
logger = logging.getLogger(__name__)
@log_start_end(log=logger)
def display_put_call_ratio(
symbol: str,
window: int = 30,
start_date: str = (datetime.now() - timedelta(days=366)).strftime("%Y-%m-%d"),
export: str = "",
external_axes: Optional[List[plt.Axes]] = None,
):
"""Display put call ratio [Source: AlphaQuery.com]
Parameters
----------
symbol : str
Stock ticker symbol
window : int, optional
Window length to look at, by default 30
start_date : str, optional
Starting date for data, by default (datetime.now() - timedelta(days=366)).strftime("%Y-%m-%d")
export : str, optional
Format to export data, by default ""
external_axes : Optional[List[plt.Axes]], optional
External axes (1 axis is expected in the list), by default None
"""
pcr = alphaquery_model.get_put_call_ratio(symbol, window, start_date)
if pcr.empty:
console.print("No data found.\n")
return
if not external_axes:
_, ax = plt.subplots(figsize=plot_autoscale(), dpi=PLOT_DPI)
elif is_valid_axes_count(external_axes, 1):
(ax,) = external_axes
else:
return
ax.plot(pcr.index, pcr.values)
ax.set_title(f"Put Call Ratio for {symbol.upper()}")
theme.style_primary_axis(ax)
if not external_axes:
theme.visualize_output()
export_data(
export,
os.path.dirname(os.path.abspath(__file__)),
"pcr",
pcr,
)