mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-12 12:22:35 +00:00
cf9670303c
* fred decorator * fmp decorator * quandl decorator * reddit decorator * polygon decorator * twitter decorator * news decorator * tradier decorator * cmc decorator * binance decorator * finnhub decorator * iex decorator * sentiment investor * walert decorator * glassnode decorator * coinglass decorator * cryptopanic decorator * bitquery decorator * smartstake decorator * messari decorator * github decorator * santiment decorator * eodhd decorator * import check_api_decorator * fix some decorators * fix some decorators * remove some decorator * decorator fixes * black * mypy * mypy again * mypy again * pylint * decorator * too many line * fix fred ycrv * mypy * rewrite events test * another try Co-authored-by: minhhoang1023 <40023817+minhhoang1023@users.noreply.github.com>
74 lines
2.1 KiB
Python
74 lines
2.1 KiB
Python
"""eodhd Model"""
|
|
__docformat__ = "numpy"
|
|
|
|
import logging
|
|
|
|
import pandas as pd
|
|
import numpy as np
|
|
import requests
|
|
|
|
from openbb_terminal import config_terminal as cfg
|
|
from openbb_terminal.decorators import check_api_key, log_start_end
|
|
from openbb_terminal.rich_config import console
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
@log_start_end(log=logger)
|
|
@check_api_key(["API_EODHD_TOKEN"])
|
|
def get_financials(
|
|
symbol: str, statement: str, quarterly: bool = False, ratios: bool = False
|
|
) -> pd.DataFrame:
|
|
"""Get ticker financial statements from eodhd
|
|
|
|
Parameters
|
|
----------
|
|
symbol: str
|
|
Stock ticker symbol
|
|
statement: str
|
|
Financial statement data to retrieve, can be balance, income or cash
|
|
quarterly:bool
|
|
Flag to get quarterly reports, by default False
|
|
ratios: bool
|
|
Shows percentage change, by default False
|
|
|
|
Returns
|
|
-------
|
|
pd.DataFrame
|
|
Balance Sheets or Income Statements or cashflow
|
|
"""
|
|
|
|
# Note the filing date is over 30 years so will always get as many as allowed
|
|
request_url = (
|
|
"https://eodhistoricaldata.com/api/fundamentals/"
|
|
f"{symbol}?"
|
|
f"api_token={cfg.API_EODHD_KEY}"
|
|
f"&filter=Financials::{statement}"
|
|
f"::{['yearly', 'quarterly'][quarterly]}"
|
|
)
|
|
|
|
r = requests.get(request_url)
|
|
if r.status_code != 200:
|
|
console.print("[red]Invalid API Key for eodhistoricaldata [/red]")
|
|
console.print(
|
|
"Get your Key here: https://eodhistoricaldata.com/r/?ref=869U7F4J\n"
|
|
)
|
|
return pd.DataFrame()
|
|
|
|
r_json = r.json()
|
|
|
|
df_financials = pd.DataFrame(r_json)
|
|
df_financials.drop("date", inplace=True)
|
|
df_financials.drop("filing_date", inplace=True)
|
|
df_financials.drop("currency_symbol", inplace=True)
|
|
|
|
df_financials = df_financials.fillna(value=np.nan)
|
|
df_financials = df_financials.dropna(how="all")
|
|
|
|
if ratios:
|
|
df_financials = df_financials.iloc[:, :5]
|
|
df_financials = df_financials.replace("-", "0")
|
|
df_financials = df_financials.astype(float)
|
|
df_financials = df_financials.pct_change(axis="columns", periods=-1).fillna(0)
|
|
return df_financials
|