Skip to content

Commit f8c2ff7

Browse files
freelancing-solutionsfreelancing-solutions
committed
Update Documentation
Financial News API
1 parent ef6189d commit f8c2ff7

File tree

1 file changed

+31
-33
lines changed

1 file changed

+31
-33
lines changed

‎src/docs/FinancialNewsApi.md

Lines changed: 31 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -10,30 +10,28 @@ All URIs are relative to *https://gateway.eod-stock-api.site/api*
1010
| [**v1_news_articles_by_publisher_publisher_get**](FinancialNewsApi.md#v1_news_articles_by_publisher_publisher_get) | **GET** /v1/news/articles-by-publisher/{publisher} | |
1111
| [**v1_news_articles_by_ticker_stock_code_get**](FinancialNewsApi.md#v1_news_articles_by_ticker_stock_code_get) | **GET** /v1/news/articles-by-ticker/{stock_code} | |
1212

13-
# **v1_news_article_uuid_get**
14-
> News v1_news_article_uuid_get(uuid)
15-
16-
13+
# **Return News Articles By UUID**
1714

1815
Obtain Financial News Information related to listed companies
1916

2017
### Example
2118

2219
```python
2320
from __future__ import print_function
24-
import time
21+
2522
import IntelligentStockMarketAPI
2623
from IntelligentStockMarketAPI.rest import ApiException
2724
from pprint import pprint
2825
# Defining the host is optional and defaults to https://gateway.eod-stock-api.site/api
2926
# See configuration.py for a list of all supported configuration parameters.
3027
configuration = IntelligentStockMarketAPI.Configuration(
31-
host = "https://gateway.eod-stock-api.site/api"
28+
host = "https://gateway.eod-stock-api.site/api",
29+
api_key = "API KEY"
3230
)
3331

3432

3533
# Enter a context with an instance of the API client
36-
with IntelligentStockMarketAPI.ApiClient() as api_client:
34+
with IntelligentStockMarketAPI.ApiClient(configuration) as api_client:
3735
# Create an instance of the API class
3836
api_instance = IntelligentStockMarketAPI.FinancialNewsApi(api_client)
3937
uuid = 'uuid_example' # str |
@@ -42,14 +40,14 @@ with IntelligentStockMarketAPI.ApiClient() as api_client:
4240
api_response = api_instance.v1_news_article_uuid_get(uuid)
4341
pprint(api_response)
4442
except ApiException as e:
45-
print("Exception when calling FinancialNewsApi->v1_news_article_uuid_get: %s\n" % e)
43+
print("Exception {}".format(e))
4644
```
4745

4846
### Parameters
4947

50-
Name | Type | Description | Notes
51-
------------- | ------------- | ------------- | -------------
52-
**uuid** | **str**| |
48+
| Name | Type | Description | Notes |
49+
|----------|---------|-------------|-------|
50+
| **uuid** | **str** | | |
5351

5452
### Return type
5553

@@ -67,9 +65,9 @@ No authorization required
6765
### HTTP response details
6866
| Status code | Description | Response headers |
6967
|-------------|-------------|------------------|
70-
**0** | | - |
68+
| **200** | | - |
7169

72-
[[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)
70+
[[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)
7371

7472
# **v1_news_articles_bounded_upper_bound_get**
7573
> NewsResponseList v1_news_articles_bounded_upper_bound_get(upper_bound)
@@ -108,9 +106,9 @@ with IntelligentStockMarketAPI.ApiClient() as api_client:
108106

109107
### Parameters
110108

111-
Name | Type | Description | Notes
112-
------------- | ------------- | ------------- | -------------
113-
**upper_bound** | **int**| |
109+
| Name | Type | Description | Notes |
110+
|-----------------|---------|-------------|-------|
111+
| **upper_bound** | **int** | | |
114112

115113
### Return type
116114

@@ -128,9 +126,9 @@ No authorization required
128126
### HTTP response details
129127
| Status code | Description | Response headers |
130128
|-------------|-------------|------------------|
131-
**0** | | - |
129+
| **0** | | - |
132130

133-
[[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)
131+
[[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)
134132

135133
# **v1_news_articles_by_date_date_get**
136134
> News v1_news_articles_by_date_date_get(date)
@@ -169,9 +167,9 @@ with IntelligentStockMarketAPI.ApiClient() as api_client:
169167

170168
### Parameters
171169

172-
Name | Type | Description | Notes
173-
------------- | ------------- | ------------- | -------------
174-
**date** | **str**| |
170+
| Name | Type | Description | Notes |
171+
|----------|---------|-------------|-------|
172+
| **date** | **str** | | |
175173

176174
### Return type
177175

@@ -189,9 +187,9 @@ No authorization required
189187
### HTTP response details
190188
| Status code | Description | Response headers |
191189
|-------------|-------------|------------------|
192-
**0** | | - |
190+
| **0** | | - |
193191

194-
[[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)
192+
[[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)
195193

196194
# **v1_news_articles_by_publisher_publisher_get**
197195
> NewsResponseList v1_news_articles_by_publisher_publisher_get(publisher)
@@ -230,9 +228,9 @@ with IntelligentStockMarketAPI.ApiClient() as api_client:
230228

231229
### Parameters
232230

233-
Name | Type | Description | Notes
234-
------------- | ------------- | ------------- | -------------
235-
**publisher** | **str**| |
231+
| Name | Type | Description | Notes |
232+
|---------------|---------|-------------|-------|
233+
| **publisher** | **str** | | |
236234

237235
### Return type
238236

@@ -250,9 +248,9 @@ No authorization required
250248
### HTTP response details
251249
| Status code | Description | Response headers |
252250
|-------------|-------------|------------------|
253-
**0** | | - |
251+
| **0** | | - |
254252

255-
[[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)
253+
[[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)
256254

257255
# **v1_news_articles_by_ticker_stock_code_get**
258256
> NewsResponseList v1_news_articles_by_ticker_stock_code_get(stock_code)
@@ -291,9 +289,9 @@ with IntelligentStockMarketAPI.ApiClient() as api_client:
291289

292290
### Parameters
293291

294-
Name | Type | Description | Notes
295-
------------- | ------------- | ------------- | -------------
296-
**stock_code** | **str**| |
292+
| Name | Type | Description | Notes |
293+
|----------------|---------|-------------|-------|
294+
| **stock_code** | **str** | | |
297295

298296
### Return type
299297

@@ -311,7 +309,7 @@ No authorization required
311309
### HTTP response details
312310
| Status code | Description | Response headers |
313311
|-------------|-------------|------------------|
314-
**0** | | - |
312+
| **0** | | - |
315313

316-
[[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)
314+
[[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)
317315

0 commit comments

Comments
 (0)