mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-30 05:52:23 +00:00
db844a567f
* fixed Pandas SettingWithCopyWarnings * fixed typo in test_google_view * fixed typo in test_google_view
89 lines
2.0 KiB
Python
89 lines
2.0 KiB
Python
"""Google Model"""
|
|
__docformat__ = "numpy"
|
|
|
|
import logging
|
|
|
|
import pandas as pd
|
|
from pytrends.request import TrendReq
|
|
|
|
from openbb_terminal.decorators import log_start_end
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
@log_start_end(log=logger)
|
|
def get_mentions(symbol: str) -> pd.DataFrame:
|
|
"""Get interest over time from google api [Source: google]
|
|
|
|
Parameters
|
|
----------
|
|
symbol: str
|
|
Stock ticker symbol
|
|
|
|
Returns
|
|
-------
|
|
pd.DataFrame
|
|
Dataframe of interest over time
|
|
"""
|
|
pytrend = TrendReq()
|
|
pytrend.build_payload(kw_list=[symbol])
|
|
return pytrend.interest_over_time()
|
|
|
|
|
|
@log_start_end(log=logger)
|
|
def get_regions(symbol: str) -> pd.DataFrame:
|
|
"""Get interest by region from google api [Source: google]
|
|
|
|
Parameters
|
|
----------
|
|
symbol: str
|
|
Ticker symbol to look at
|
|
|
|
Returns
|
|
-------
|
|
pd.DataFrame
|
|
Dataframe of interest by region
|
|
"""
|
|
pytrend = TrendReq()
|
|
pytrend.build_payload(kw_list=[symbol])
|
|
return pytrend.interest_by_region().sort_values([symbol], ascending=False)
|
|
|
|
|
|
@log_start_end(log=logger)
|
|
def get_queries(symbol: str) -> dict:
|
|
"""Get related queries from google api [Source: google]
|
|
|
|
Parameters
|
|
----------
|
|
symbol: str
|
|
Stock ticker symbol to compare
|
|
|
|
Returns
|
|
-------
|
|
dict : {'top': pd.DataFrame or None, 'rising': pd.DataFrame or None}
|
|
|
|
"""
|
|
pytrend = TrendReq()
|
|
pytrend.build_payload(kw_list=[symbol])
|
|
return pytrend.related_queries()
|
|
|
|
|
|
@log_start_end(log=logger)
|
|
def get_rise(symbol: str) -> pd.DataFrame:
|
|
"""Get top rising related queries with this stock's query [Source: google]
|
|
|
|
Parameters
|
|
----------
|
|
symbol: str
|
|
Stock ticker symbol
|
|
|
|
Returns
|
|
-------
|
|
pd.DataFrame
|
|
Dataframe containing rising related queries
|
|
"""
|
|
pytrend = TrendReq()
|
|
pytrend.build_payload(kw_list=[symbol])
|
|
df_related_queries = pytrend.related_queries()
|
|
return df_related_queries[symbol]["rising"]
|