Skip to content

Commit 0426d17

Browse files
Update Documentation
Finished Updating Financial News Documentation
1 parent f8c2ff7 commit 0426d17

File tree

1 file changed

+48
-53
lines changed

1 file changed

+48
-53
lines changed

src/docs/FinancialNewsApi.md

Lines changed: 48 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -55,11 +55,11 @@ with IntelligentStockMarketAPI.ApiClient(configuration) as api_client:
5555

5656
### Authorization
5757

58-
No authorization required
58+
api key - obtainable from our website - subscribe here https://eod-stock-api.site/login
5959

6060
### HTTP request headers
6161

62-
- **Content-Type**: Not defined
62+
- **Content-Type**: application/json
6363
- **Accept**: application/json
6464

6565
### HTTP response details
@@ -69,9 +69,7 @@ No authorization required
6969

7070
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
7171

72-
# **v1_news_articles_bounded_upper_bound_get**
73-
> NewsResponseList v1_news_articles_bounded_upper_bound_get(upper_bound)
74-
72+
# **Return News Bounded by an Upper Limit**
7573

7674

7775
Get list of all News Upper Bound is an Integer indicating a total number of articles to return
@@ -87,21 +85,22 @@ from pprint import pprint
8785
# Defining the host is optional and defaults to https://gateway.eod-stock-api.site/api
8886
# See configuration.py for a list of all supported configuration parameters.
8987
configuration = IntelligentStockMarketAPI.Configuration(
90-
host = "https://gateway.eod-stock-api.site/api"
88+
host = "https://gateway.eod-stock-api.site/api",
89+
api_key= "API Key"
9190
)
9291

9392

9493
# Enter a context with an instance of the API client
95-
with IntelligentStockMarketAPI.ApiClient() as api_client:
94+
with IntelligentStockMarketAPI.ApiClient(configuration) as api_client:
9695
# Create an instance of the API class
9796
api_instance = IntelligentStockMarketAPI.FinancialNewsApi(api_client)
98-
upper_bound = 56 # int |
97+
upper_bound = 25 # int |
9998

10099
try:
101100
api_response = api_instance.v1_news_articles_bounded_upper_bound_get(upper_bound)
102101
pprint(api_response)
103102
except ApiException as e:
104-
print("Exception when calling FinancialNewsApi->v1_news_articles_bounded_upper_bound_get: %s\n" % e)
103+
print("Exception when calling Financial News Api : {}".format(e))
105104
```
106105

107106
### Parameters
@@ -116,21 +115,21 @@ with IntelligentStockMarketAPI.ApiClient() as api_client:
116115

117116
### Authorization
118117

119-
No authorization required
118+
api key - obtainable from our website - subscribe here https://eod-stock-api.site/login
120119

121120
### HTTP request headers
122121

123-
- **Content-Type**: Not defined
122+
- **Content-Type**: application/json
124123
- **Accept**: application/json
125124

126125
### HTTP response details
127126
| Status code | Description | Response headers |
128-
|-------------|-------------|------------------|
129-
| **0** | | - |
127+
|------------|-------------|------------------|
128+
| **200** | | - |
130129

131130
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
132131

133-
# **v1_news_articles_by_date_date_get**
132+
# **Articles By Specific Dates**
134133
> News v1_news_articles_by_date_date_get(date)
135134
136135

@@ -148,21 +147,22 @@ from pprint import pprint
148147
# Defining the host is optional and defaults to https://gateway.eod-stock-api.site/api
149148
# See configuration.py for a list of all supported configuration parameters.
150149
configuration = IntelligentStockMarketAPI.Configuration(
151-
host = "https://gateway.eod-stock-api.site/api"
150+
host = "https://gateway.eod-stock-api.site/api",
151+
api_key = "API Key"
152152
)
153153

154154

155155
# Enter a context with an instance of the API client
156-
with IntelligentStockMarketAPI.ApiClient() as api_client:
156+
with IntelligentStockMarketAPI.ApiClient(configuration) as api_client:
157157
# Create an instance of the API class
158158
api_instance = IntelligentStockMarketAPI.FinancialNewsApi(api_client)
159-
date = 'date_example' # str |
159+
date = '2022-04-01' # str |
160160

161161
try:
162162
api_response = api_instance.v1_news_articles_by_date_date_get(date)
163163
pprint(api_response)
164164
except ApiException as e:
165-
print("Exception when calling FinancialNewsApi->v1_news_articles_by_date_date_get: %s\n" % e)
165+
print("Exception when calling Financial News Api {}".format(e))
166166
```
167167

168168
### Parameters
@@ -177,11 +177,11 @@ with IntelligentStockMarketAPI.ApiClient() as api_client:
177177

178178
### Authorization
179179

180-
No authorization required
180+
api key - obtainable from our website - subscribe here https://eod-stock-api.site/login
181181

182182
### HTTP request headers
183183

184-
- **Content-Type**: Not defined
184+
- **Content-Type**: application/json
185185
- **Accept**: application/json
186186

187187
### HTTP response details
@@ -191,125 +191,120 @@ No authorization required
191191

192192
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
193193

194-
# **v1_news_articles_by_publisher_publisher_get**
195-
> NewsResponseList v1_news_articles_by_publisher_publisher_get(publisher)
196-
197-
194+
# **Get Articles By Publisher**
198195

199196
Get News Financial News by publisher
200197

201198
### Example
202199

203200
```python
204201
from __future__ import print_function
205-
import time
206202
import IntelligentStockMarketAPI
207203
from IntelligentStockMarketAPI.rest import ApiException
208204
from pprint import pprint
209205
# Defining the host is optional and defaults to https://gateway.eod-stock-api.site/api
210206
# See configuration.py for a list of all supported configuration parameters.
211207
configuration = IntelligentStockMarketAPI.Configuration(
212-
host = "https://gateway.eod-stock-api.site/api"
208+
host = "https://gateway.eod-stock-api.site/api",
209+
api_key = "API Key"
213210
)
214211

215212

216213
# Enter a context with an instance of the API client
217-
with IntelligentStockMarketAPI.ApiClient() as api_client:
214+
with IntelligentStockMarketAPI.ApiClient(configuration) as api_client:
218215
# Create an instance of the API class
219216
api_instance = IntelligentStockMarketAPI.FinancialNewsApi(api_client)
220-
publisher = 'publisher_example' # str |
217+
publisher = 'new york times' # str |
221218

222219
try:
223220
api_response = api_instance.v1_news_articles_by_publisher_publisher_get(publisher)
224221
pprint(api_response)
225222
except ApiException as e:
226-
print("Exception when calling FinancialNewsApi->v1_news_articles_by_publisher_publisher_get: %s\n" % e)
223+
print("Exception when calling Financial News Api {}".format(e))
224+
227225
```
228226

229227
### Parameters
230228

231-
| Name | Type | Description | Notes |
232-
|---------------|---------|-------------|-------|
233-
| **publisher** | **str** | | |
229+
| Name | Type | Description | Notes |
230+
|---------------|---------|-----------------------|-------|
231+
| **publisher** | **str** | **Name of Publisher** | |
234232

235233
### Return type
236234

237235
[**NewsResponseList**](NewsResponseList.md)
238236

239237
### Authorization
240238

241-
No authorization required
239+
api key - obtainable from our website - subscribe here https://eod-stock-api.site/login
242240

243241
### HTTP request headers
244242

245-
- **Content-Type**: Not defined
243+
- **Content-Type**: application/json
246244
- **Accept**: application/json
247245

248246
### HTTP response details
249247
| Status code | Description | Response headers |
250248
|-------------|-------------|------------------|
251-
| **0** | | - |
249+
| **200** | | - |
252250

253251
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
254252

255-
# **v1_news_articles_by_ticker_stock_code_get**
256-
> NewsResponseList v1_news_articles_by_ticker_stock_code_get(stock_code)
253+
## **Return News Articles By Stock Code / Ticker Symbol**
257254

258-
259-
260-
Get Financial News Articles By Ticker
255+
Get Financial News Articles By Ticker Symbol / Stock Code
261256

262257
### Example
263258

264259
```python
265260
from __future__ import print_function
266-
import time
267261
import IntelligentStockMarketAPI
268262
from IntelligentStockMarketAPI.rest import ApiException
269263
from pprint import pprint
270264
# Defining the host is optional and defaults to https://gateway.eod-stock-api.site/api
271265
# See configuration.py for a list of all supported configuration parameters.
272266
configuration = IntelligentStockMarketAPI.Configuration(
273-
host = "https://gateway.eod-stock-api.site/api"
267+
host = "https://gateway.eod-stock-api.site/api",
268+
api_key = "API Key"
274269
)
275270

276271

277272
# Enter a context with an instance of the API client
278-
with IntelligentStockMarketAPI.ApiClient() as api_client:
273+
with IntelligentStockMarketAPI.ApiClient(configuration) as api_client:
279274
# Create an instance of the API class
280275
api_instance = IntelligentStockMarketAPI.FinancialNewsApi(api_client)
281-
stock_code = 'stock_code_example' # str |
276+
stock_code = 'TSLA' # str | Tesla Stock Code
282277

283278
try:
284279
api_response = api_instance.v1_news_articles_by_ticker_stock_code_get(stock_code)
285280
pprint(api_response)
286281
except ApiException as e:
287-
print("Exception when calling FinancialNewsApi->v1_news_articles_by_ticker_stock_code_get: %s\n" % e)
282+
print("Exception when calling Financial News Api {}".format(e))
283+
288284
```
289285

290286
### Parameters
291287

292-
| Name | Type | Description | Notes |
293-
|----------------|---------|-------------|-------|
294-
| **stock_code** | **str** | | |
288+
| Name | Type | Description | Notes |
289+
|----------------|---------|---------------|-------|
290+
| **stock_code** | **str** | Ticker Symbol | |
295291

296292
### Return type
297293

298294
[**NewsResponseList**](NewsResponseList.md)
299295

300296
### Authorization
301-
302-
No authorization required
297+
api key - obtainable from our website - subscribe here https://eod-stock-api.site/login
303298

304299
### HTTP request headers
305300

306-
- **Content-Type**: Not defined
301+
- **Content-Type**: application/json
307302
- **Accept**: application/json
308303

309304
### HTTP response details
310305
| Status code | Description | Response headers |
311-
|-------------|-------------|------------------|
312-
| **0** | | - |
306+
|------------|-------------|------------------|
307+
| **200** | | - |
313308

314309
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
315310

0 commit comments

Comments
 (0)