Skip to content

Commit ef6189d

Browse files
freelancing-solutionsfreelancing-solutions
committed
Update Documentation
Exchange Documentations
1 parent 80c0036 commit ef6189d

File tree

3 files changed

+60
-61
lines changed

3 files changed

+60
-61
lines changed

‎src/docs/ExchangeWithListedTickers.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# ExchangeWithListedTickers
22

33
## Properties
4-
Name | Type | Description | Notes
5-
------------ | ------------- | ------------- | -------------
6-
**message** | **str** | success or error message | [optional]
7-
**payload** | [**ExchangeWithTickers**](ExchangeWithTickers.md) | | [optional]
8-
**status** | **bool** | True if data is found and valid | [optional]
4+
| Name | Type | Description | Notes |
5+
|-------------|---------------------------------------------------|---------------------------------|------------|
6+
| **message** | **str** | success or error message | [optional] |
7+
| **payload** | [**ExchangeWithTickers**](ExchangeWithTickers.md) | | [optional] |
8+
| **status** | **bool** | True if data is found and valid | [optional] |
99

10-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
1111

1212

‎src/docs/ExchangeWithTickers.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# ExchangeWithTickers
22

33
## Properties
4-
Name | Type | Description | Notes
5-
------------ | ------------- | ------------- | -------------
6-
**code** | **str** | exchange_code code | [optional]
7-
**country** | **str** | the country the exchange_code operates in | [optional]
8-
**currency_symbol** | **str** | the currency symbol of the country the exchange_code operates in | [optional]
9-
**exchange_id** | **str** | exchange_code unique id | [optional]
10-
**name** | **str** | name of exchange_code | [optional]
11-
**operating_mic** | **str** | exchange_code operating mic | [optional]
12-
**tickers_list** | [**TickerExchangeCode**](TickerExchangeCode.md) | | [optional]
4+
| Name | Type | Description | Notes |
5+
|---------------------|-------------------------------------------------|------------------------------------------------------------------|------------|
6+
| **code** | **str** | exchange_code code | [optional] |
7+
| **country** | **str** | the country the exchange_code operates in | [optional] |
8+
| **currency_symbol** | **str** | the currency symbol of the country the exchange_code operates in | [optional] |
9+
| **exchange_id** | **str** | exchange_code unique id | [optional] |
10+
| **name** | **str** | name of exchange_code | [optional] |
11+
| **operating_mic** | **str** | exchange_code operating mic | [optional] |
12+
| **tickers_list** | [**TickerExchangeCode**](TickerExchangeCode.md) | | [optional] |
1313

14-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
14+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
1515

1616

‎src/docs/FinancialNewsApi.md‎

Lines changed: 44 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
1-
# openapi_client.FinancialNewsApi
1+
# Intelligent Stock Market API
22

3-
All URIs are relative to *http://https://gateway.eod-stock-api.site/api*
4-
5-
Method | HTTP request | Description
6-
------------- | ------------- | -------------
7-
[**v1_news_article_uuid_get**](FinancialNewsApi.md#v1_news_article_uuid_get) | **GET** /v1/news/article/{uuid} |
8-
[**v1_news_articles_bounded_upper_bound_get**](FinancialNewsApi.md#v1_news_articles_bounded_upper_bound_get) | **GET** /v1/news/articles-bounded/{upper_bound} |
9-
[**v1_news_articles_by_date_date_get**](FinancialNewsApi.md#v1_news_articles_by_date_date_get) | **GET** /v1/news/articles-by-date/{_date} |
10-
[**v1_news_articles_by_publisher_publisher_get**](FinancialNewsApi.md#v1_news_articles_by_publisher_publisher_get) | **GET** /v1/news/articles-by-publisher/{publisher} |
11-
[**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} |
3+
All URIs are relative to *https://gateway.eod-stock-api.site/api*
124

5+
| Method | HTTP request | Description |
6+
|--------------------------------------------------------------------------------------------------------------------|----------------------------------------------------|-------------|
7+
| [**v1_news_article_uuid_get**](FinancialNewsApi.md#v1_news_article_uuid_get) | **GET** /v1/news/article/{uuid} | |
8+
| [**v1_news_articles_bounded_upper_bound_get**](FinancialNewsApi.md#v1_news_articles_bounded_upper_bound_get) | **GET** /v1/news/articles-bounded/{upper_bound} | |
9+
| [**v1_news_articles_by_date_date_get**](FinancialNewsApi.md#v1_news_articles_by_date_date_get) | **GET** /v1/news/articles-by-date/{_date} | |
10+
| [**v1_news_articles_by_publisher_publisher_get**](FinancialNewsApi.md#v1_news_articles_by_publisher_publisher_get) | **GET** /v1/news/articles-by-publisher/{publisher} | |
11+
| [**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} | |
1312

1413
# **v1_news_article_uuid_get**
1514
> News v1_news_article_uuid_get(uuid)
@@ -23,20 +22,20 @@ Obtain Financial News Information related to listed companies
2322
```python
2423
from __future__ import print_function
2524
import time
26-
import openapi_client
27-
from openapi_client.rest import ApiException
25+
import IntelligentStockMarketAPI
26+
from IntelligentStockMarketAPI.rest import ApiException
2827
from pprint import pprint
29-
# Defining the host is optional and defaults to http://https://gateway.eod-stock-api.site/api
28+
# Defining the host is optional and defaults to https://gateway.eod-stock-api.site/api
3029
# See configuration.py for a list of all supported configuration parameters.
31-
configuration = openapi_client.Configuration(
32-
host = "http://https://gateway.eod-stock-api.site/api"
30+
configuration = IntelligentStockMarketAPI.Configuration(
31+
host = "https://gateway.eod-stock-api.site/api"
3332
)
3433

3534

3635
# Enter a context with an instance of the API client
37-
with openapi_client.ApiClient() as api_client:
36+
with IntelligentStockMarketAPI.ApiClient() as api_client:
3837
# Create an instance of the API class
39-
api_instance = openapi_client.FinancialNewsApi(api_client)
38+
api_instance = IntelligentStockMarketAPI.FinancialNewsApi(api_client)
4039
uuid = 'uuid_example' # str |
4140

4241
try:
@@ -84,20 +83,20 @@ Get list of all News Upper Bound is an Integer indicating a total number of arti
8483
```python
8584
from __future__ import print_function
8685
import time
87-
import openapi_client
88-
from openapi_client.rest import ApiException
86+
import IntelligentStockMarketAPI
87+
from IntelligentStockMarketAPI.rest import ApiException
8988
from pprint import pprint
90-
# Defining the host is optional and defaults to http://https://gateway.eod-stock-api.site/api
89+
# Defining the host is optional and defaults to https://gateway.eod-stock-api.site/api
9190
# See configuration.py for a list of all supported configuration parameters.
92-
configuration = openapi_client.Configuration(
93-
host = "http://https://gateway.eod-stock-api.site/api"
91+
configuration = IntelligentStockMarketAPI.Configuration(
92+
host = "https://gateway.eod-stock-api.site/api"
9493
)
9594

9695

9796
# Enter a context with an instance of the API client
98-
with openapi_client.ApiClient() as api_client:
97+
with IntelligentStockMarketAPI.ApiClient() as api_client:
9998
# Create an instance of the API class
100-
api_instance = openapi_client.FinancialNewsApi(api_client)
99+
api_instance = IntelligentStockMarketAPI.FinancialNewsApi(api_client)
101100
upper_bound = 56 # int |
102101

103102
try:
@@ -145,20 +144,20 @@ Get Articles Financial News By Date
145144
```python
146145
from __future__ import print_function
147146
import time
148-
import openapi_client
149-
from openapi_client.rest import ApiException
147+
import IntelligentStockMarketAPI
148+
from IntelligentStockMarketAPI.rest import ApiException
150149
from pprint import pprint
151-
# Defining the host is optional and defaults to http://https://gateway.eod-stock-api.site/api
150+
# Defining the host is optional and defaults to https://gateway.eod-stock-api.site/api
152151
# See configuration.py for a list of all supported configuration parameters.
153-
configuration = openapi_client.Configuration(
154-
host = "http://https://gateway.eod-stock-api.site/api"
152+
configuration = IntelligentStockMarketAPI.Configuration(
153+
host = "https://gateway.eod-stock-api.site/api"
155154
)
156155

157156

158157
# Enter a context with an instance of the API client
159-
with openapi_client.ApiClient() as api_client:
158+
with IntelligentStockMarketAPI.ApiClient() as api_client:
160159
# Create an instance of the API class
161-
api_instance = openapi_client.FinancialNewsApi(api_client)
160+
api_instance = IntelligentStockMarketAPI.FinancialNewsApi(api_client)
162161
date = 'date_example' # str |
163162

164163
try:
@@ -206,20 +205,20 @@ Get News Financial News by publisher
206205
```python
207206
from __future__ import print_function
208207
import time
209-
import openapi_client
210-
from openapi_client.rest import ApiException
208+
import IntelligentStockMarketAPI
209+
from IntelligentStockMarketAPI.rest import ApiException
211210
from pprint import pprint
212-
# Defining the host is optional and defaults to http://https://gateway.eod-stock-api.site/api
211+
# Defining the host is optional and defaults to https://gateway.eod-stock-api.site/api
213212
# See configuration.py for a list of all supported configuration parameters.
214-
configuration = openapi_client.Configuration(
215-
host = "http://https://gateway.eod-stock-api.site/api"
213+
configuration = IntelligentStockMarketAPI.Configuration(
214+
host = "https://gateway.eod-stock-api.site/api"
216215
)
217216

218217

219218
# Enter a context with an instance of the API client
220-
with openapi_client.ApiClient() as api_client:
219+
with IntelligentStockMarketAPI.ApiClient() as api_client:
221220
# Create an instance of the API class
222-
api_instance = openapi_client.FinancialNewsApi(api_client)
221+
api_instance = IntelligentStockMarketAPI.FinancialNewsApi(api_client)
223222
publisher = 'publisher_example' # str |
224223

225224
try:
@@ -267,20 +266,20 @@ Get Financial News Articles By Ticker
267266
```python
268267
from __future__ import print_function
269268
import time
270-
import openapi_client
271-
from openapi_client.rest import ApiException
269+
import IntelligentStockMarketAPI
270+
from IntelligentStockMarketAPI.rest import ApiException
272271
from pprint import pprint
273-
# Defining the host is optional and defaults to http://https://gateway.eod-stock-api.site/api
272+
# Defining the host is optional and defaults to https://gateway.eod-stock-api.site/api
274273
# See configuration.py for a list of all supported configuration parameters.
275-
configuration = openapi_client.Configuration(
276-
host = "http://https://gateway.eod-stock-api.site/api"
274+
configuration = IntelligentStockMarketAPI.Configuration(
275+
host = "https://gateway.eod-stock-api.site/api"
277276
)
278277

279278

280279
# Enter a context with an instance of the API client
281-
with openapi_client.ApiClient() as api_client:
280+
with IntelligentStockMarketAPI.ApiClient() as api_client:
282281
# Create an instance of the API class
283-
api_instance = openapi_client.FinancialNewsApi(api_client)
282+
api_instance = IntelligentStockMarketAPI.FinancialNewsApi(api_client)
284283
stock_code = 'stock_code_example' # str |
285284

286285
try:

0 commit comments

Comments
 (0)