1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
|
""" Ultima News Monitor Model """
__docformat__ = "numpy"
import logging
import os
from urllib.parse import quote
import certifi
import pandas as pd
from openbb_terminal.core.session.current_user import get_current_user
from openbb_terminal.decorators import log_start_end
# from openbb_terminal.decorators import check_api_key
from openbb_terminal.helper_funcs import request
from openbb_terminal.rich_config import console
logger = logging.getLogger(__name__)
ULTIMA_BASE_URL = "https://api.ultimainsights.ai/v1"
NO_API_KEY = "REPLACE_ME"
@log_start_end(log=logger)
# @check_api_key(["API_ULTIMA_KEY"])
def get_news(term: str = "", sort: str = "articlePublishedDate") -> pd.DataFrame:
"""Get news for a given term and source. [Source: Ultima Insights News Monitor]
Parameters
----------
term : str
term to search on the news articles
sort: str
the column to sort by
Returns
-------
articles: pd.DataFrame
term to search on the news articles
Examples
--------
>>> from openbb_terminal.sdk import openbb
>>> openbb.news()
"""
# Necessary for installer so that it can locate the correct certificates for
# API calls and https
# https://stackoverflow.com/questions/27835619/urllib-and-ssl-certificate-verify-failed-error/73270162#73270162
os.environ["REQUESTS_CA_BUNDLE"] = certifi.where()
os.environ["SSL_CERT_FILE"] = certifi.where()
current_user = get_current_user()
if current_user.credentials.API_ULTIMA_KEY == NO_API_KEY:
auth_header = None
else:
auth_header = {
"Authorization": f"Bearer {current_user.credentials.API_ULTIMA_KEY}"
}
have_data = False
limit = 0
while not have_data:
if term:
term = quote(term)
term = term.upper()
term = term.strip()
if term in supported_terms():
if auth_header:
data = request(
f"{ULTIMA_BASE_URL}/getNewsArticles/{term}", headers=auth_header
)
else:
data = request(f"{ULTIMA_BASE_URL}/getNewsArticles/{term}")
else:
console.print(
"[red]Ticker not supported. Unable to retrieve data\n[/red]"
)
return pd.DataFrame()
else:
console.print("[red]No term specified. Unable to retrieve data\n[/red]")
return pd.DataFrame()
if (
hasattr(data, "status") and data.status_code == 200
): # Checking if data has status attribute and if data request succeeded
if data.content:
have_data = True
elif limit == 60: # Breaking if 60 successful requests return no data
console.print("[red]Timeout occurred. Please try again\n[/red]")
break
limit = limit + 1
elif (
hasattr(data, "status") and data.status_code == 429
): # If data request failed
console.print(
"[red]Too many requests. Please get an API Key from https://www.ultimainsights.ai/[/red]"
)
break
elif (
hasattr(data, "status") and data.status_code != 200
): # If data request failed
console.print("[red]Status code not 200. Unable to retrieve data\n[/red]")
break
else:
# console.print("[red]Could not retrieve data\n[/red]")
break
if not data.json():
return pd.DataFrame()
df = pd.DataFrame(
data.json(),
columns=[
"articleHeadline",
"articleURL",
"articlePublishedDate",
"riskCategory",
"riskElaboratedDescription",
"relevancyScore",
],
)
df = df[df["relevancyScore"] < 5]
df = df[df["relevancyScore"] > 3.5]
df["riskElaboratedDescription"] = df["riskElaboratedDescription"].str.replace(
"\n", ""
)
df["riskElaboratedDescription"] = df["riskElaboratedDescription"].str.replace(
"\n", ""
)
df["articlePublishedDate"] = pd.to_datetime(df["articlePublishedDate"])
df = df.sort_values(by=[sort], ascending=False)
return df
@log_start_end(log=logger)
# @check_api_key(["API_ULTIMA_KEY"])
def supported_terms() -> list:
"""Get supported terms for news. [Source: Ultima]
Returns
-------
terms: list
list of supported terms (tickers)
"""
# Necessary for installer so that it can locate the correct certificates for
# API calls and https
# https://stackoverflow.com/questions/27835619/urllib-and-ssl-certificate-verify-failed-error/73270162#73270162
os.environ["REQUESTS_CA_BUNDLE"] = certifi.where()
os.environ["SSL_CERT_FILE"] = certifi.where()
data = request(f"{ULTIMA_BASE_URL}/supportedTickers")
return list(data.json())
@log_start_end(log=logger)
def get_company_info(ticker: str) -> dict:
"""Get company info for a given ticker. [Source: Ultima Insights]
Parameters
----------
ticker : str
ticker to search for company info
Returns
-------
company_info: dict
dictionary of company info
"""
# Necessary for installer so that it can locate the correct certificates for
# API calls and https
# https://stackoverflow.com/questions/27835619/urllib-and-ssl-certificate-verify-failed-error/73270162#73270162
os.environ["REQUESTS_CA_BUNDLE"] = certifi.where()
os.environ["SSL_CERT_FILE"] = certifi.where()
if ticker in supported_terms():
data = request(f"{ULTIMA_BASE_URL}/getCompanyInfo/{ticker}")
return data.json()
console.print("[red]Ticker not supported. Unable to retrieve data\n[/red]")
return {}
@log_start_end(log=logger)
def get_top_headlines(ticker: str) -> dict:
"""Get top headlines for a given ticker. [Source: Ultima Insights]
Parameters
----------
ticker : str
ticker to get top headlines for
Returns
-------
top_headlines: dict
dictionary of top headlines
"""
# Necessary for installer so that it can locate the correct certificates for
# API calls and https
# https://stackoverflow.com/questions/27835619/urllib-and-ssl-certificate-verify-failed-error/73270162#73270162
os.environ["REQUESTS_CA_BUNDLE"] = certifi.where()
os.environ["SSL_CERT_FILE"] = certifi.where()
current_user = get_current_user()
if current_user.credentials.API_ULTIMA_KEY == NO_API_KEY:
auth_header = None
else:
auth_header = {
"Authorization": f"Bearer {current_user.credentials.API_ULTIMA_KEY}"
}
if ticker in supported_terms():
if auth_header:
data = request(
f"{ULTIMA_BASE_URL}/getTopHeadlines/{ticker}", headers=auth_header
)
else:
data = request(f"{ULTIMA_BASE_URL}/getTopHeadlines/{ticker}")
if (
hasattr(data, "status") and data.status_code == 429
): # If data request failed
console.print(
"[red]Too many requests. Please get an API Key from https://www.ultimainsights.ai/[/red]"
)
return {}
if (
hasattr(data, "status") and data.status_code != 200
): # If data request failed
console.print("[red]Status code not 200. Unable to retrieve data\n[/red]")
return {}
json = data.json()
if "message" in json:
console.print(f"[red]{json['message']}[/red]")
return {}
return json
console.print("[red]Ticker not supported. Unable to retrieve data\n[/red]")
return {}
|
