Files
OpenBB/openbb_terminal/stocks/options/chartexchange_model.py
Danglewood 581fd94276 hotfix/options-hist: Fixes options/hist to display date column when raw is True (#5304)
* fix options hist to display date column when raw is True

* make raw table title same as other sources

* if export
2023-08-09 21:36:35 +00:00

85 lines
2.8 KiB
Python

"""Chartexchange model"""
import logging
from typing import Optional, Union
import pandas as pd
from bs4 import BeautifulSoup
from openbb_terminal.decorators import log_start_end
from openbb_terminal.helper_funcs import get_user_agent, request
from openbb_terminal.rich_config import console
from openbb_terminal.stocks.options.op_helpers import convert
logger = logging.getLogger(__name__)
@log_start_end(log=logger)
def get_option_history(
symbol: str = "GME",
date: str = "2021-02-05",
call: bool = True,
price: Union[str, Union[int, float]] = "90",
chain_id: Optional[str] = None,
) -> pd.DataFrame:
"""Historic prices for a specific option [chartexchange]
Parameters
----------
symbol : str
Ticker symbol to get historical data from
date : str
Date as a string YYYYMMDD
call : bool
Whether to show a call or a put
price : Union[str, Union[int, float]]
Strike price for a specific option
chain_id: str
Option symbol. Overwrites other inputs. ChartExchange uses the format:
`{TICKER}{YYYYMMDD}{C/P}{PRICE}`, where the price has no leading and trailing zeros.
Returns
-------
historical : pd.Dataframe
Historic information for an option
"""
if chain_id is None:
url = f"https://chartexchange.com/symbol/opra-{symbol.lower()}{date.replace('-', '')}"
url += f"{'c' if call else 'p'}{float(price):g}/historical/"
else:
url = f"https://chartexchange.com/symbol/opra-{chain_id}/historical/"
data = request(url, headers={"User-Agent": get_user_agent()}).content
soup = BeautifulSoup(data, "html.parser")
table = soup.find("div", attrs={"style": "display: table; font-size: 0.9em; "})
if table:
rows = table.find_all("div", attrs={"style": "display: table-row;"})
else:
return pd.DataFrame()
clean_rows = []
if rows:
for row in rows[1:]:
item = row.find_all("div")
clean_rows.append([x.text for x in item])
else:
if chain_id is not None:
console.print(
f"No data for {chain_id}. Check that you are using OPRA notation.\n"
)
return pd.DataFrame()
console.print("No data for this option\n")
return pd.DataFrame()
df = pd.DataFrame()
df["Date"] = [x[0] for x in clean_rows]
df["Open"] = [convert(x[2], ",") for x in clean_rows]
df["High"] = [convert(x[3], ",") for x in clean_rows]
df["Low"] = [convert(x[4], ",") for x in clean_rows]
df["Close"] = [convert(x[5], ",") for x in clean_rows]
df["Change"] = [convert(x[6], "%") for x in clean_rows]
df["Volume"] = [convert(x[7], ",") for x in clean_rows]
df["Open Interest"] = [convert(x[8], ",") for x in clean_rows]
df["Change Since"] = [convert(x[9], "%") for x in clean_rows]
return df