Skip to content

Commit 3e8c887

Browse files
freelancing-solutionsfreelancing-solutions
committed
Update Documentation
Exchange Documentations
1 parent c98e1e4 commit 3e8c887

File tree

5 files changed

+41
-43
lines changed

5 files changed

+41
-43
lines changed

‎src/docs/ExchangeListResponse.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# ExchangeListResponse
22

33
## Properties
4-
Name | Type | Description | Notes
5-
------------ | ------------- | ------------- | -------------
6-
**message** | **str** | success or error message | [optional]
7-
**payload** | [**Exchange**](Exchange.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** | [**Exchange**](Exchange.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/ExchangeListedStock.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# ExchangeListedStock
2-
1+
# Exchange Listed Stock
2+
this will return all stock data for the exchange
33
## Properties
4-
Name | Type | Description | Notes
5-
------------ | ------------- | ------------- | -------------
6-
**message** | **str** | success or error message | [optional]
7-
**payload** | [**Stock**](Stock.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** | [**Stock**](Stock.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/ExchangeRequest.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# ExchangeRequest
22

33
## Properties
4-
Name | Type | Description | Notes
5-
------------ | ------------- | ------------- | -------------
6-
**payload** | [**Exchange**](Exchange.md) | | [optional]
4+
| Name | Type | Description | Notes |
5+
|-------------|-----------------------------|-------------|------------|
6+
| **payload** | [**Exchange**](Exchange.md) | | [optional] |
77

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

1010

‎src/docs/ExchangeResponse.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# ExchangeResponse
22

33
## Properties
4-
Name | Type | Description | Notes
5-
------------ | ------------- | ------------- | -------------
6-
**message** | **str** | success or error message | [optional]
7-
**payload** | [**Exchange**](Exchange.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** | [**Exchange**](Exchange.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/ExchangesApi.md

+17-19
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# src.IntelligentStockMarketAPI.ExchangesApi
1+
# Intelligent Stock Market API - Exchange API
22

33
All URIs are relative to *https://gateway.eod-stock-api.site/api*
44

@@ -12,39 +12,37 @@ All URIs are relative to *https://gateway.eod-stock-api.site/api*
1212
| [**v1_exchange_post**](ExchangesApi.md#v1_exchange_post) | **POST** /v1/exchange | |
1313
| [**v1_exchanges_get**](ExchangesApi.md#v1_exchanges_get) | **GET** /v1/exchanges | |
1414

15-
# **v1_exchange_code_exchange_code_get**
16-
> ExchangeResponse v1_exchange_code_exchange_code_get(exchange_code)
17-
18-
15+
## **Given Exchange ID or code Return Exchange Data**
1916

2017
given exchange_id or exchange_code code will return exchange_code data
2118

2219
### Example
2320

2421
```python
2522
from __future__ import print_function
26-
import time
2723
import src.IntelligentStockMarketAPI
2824
from src.IntelligentStockMarketAPI.rest import ApiException
2925
from pprint import pprint
3026
# Defining the host is optional and defaults to https://gateway.eod-stock-api.site/api
3127
# See configuration.py for a list of all supported configuration parameters.
3228
configuration = src.IntelligentStockMarketAPI.Configuration(
33-
host = "https://gateway.eod-stock-api.site/api"
29+
host = "https://gateway.eod-stock-api.site/api",
30+
api_key= "API KEY"
3431
)
3532

3633

3734
# Enter a context with an instance of the API client
38-
with src.IntelligentStockMarketAPI.ApiClient() as api_client:
35+
with src.IntelligentStockMarketAPI.ApiClient(configuration) as api_client:
3936
# Create an instance of the API class
4037
api_instance = src.IntelligentStockMarketAPI.ExchangesApi(api_client)
41-
exchange_code = 'exchange_code_example' # str |
38+
exchange_code = 'TO' # str | Code is for Toronto Stock Exchange - see list of exchanges for complete list of codes
4239

4340
try:
4441
api_response = api_instance.v1_exchange_code_exchange_code_get(exchange_code)
4542
pprint(api_response)
4643
except ApiException as e:
47-
print("Exception when calling ExchangesApi->v1_exchange_code_exchange_code_get: %s\n" % e)
44+
print("Exception {}".format(e))
45+
4846
```
4947

5048
### Parameters
@@ -59,17 +57,17 @@ with src.IntelligentStockMarketAPI.ApiClient() as api_client:
5957

6058
### Authorization
6159

62-
No authorization required
60+
api_key -> can be obtained from our website at https://eod-stock-api.site
6361

6462
### HTTP request headers
6563

66-
- **Content-Type**: Not defined
64+
- **Content-Type**: application/json; charset=utf-8
6765
- **Accept**: application/json
6866

6967
### HTTP response details
7068
| Status code | Description | Response headers |
7169
|-------------|-------------|------------------|
72-
| **0** | | - |
70+
| **200** | | - |
7371

7472
[[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)
7573

@@ -120,7 +118,7 @@ with src.IntelligentStockMarketAPI.ApiClient() as api_client:
120118

121119
### Authorization
122120

123-
No authorization required
121+
api_key -> can be obtained from our website at https://eod-stock-api.site
124122

125123
### HTTP request headers
126124

@@ -181,7 +179,7 @@ with src.IntelligentStockMarketAPI.ApiClient() as api_client:
181179

182180
### Authorization
183181

184-
No authorization required
182+
api_key -> can be obtained from our website at https://eod-stock-api.site
185183

186184
### HTTP request headers
187185

@@ -242,7 +240,7 @@ with src.IntelligentStockMarketAPI.ApiClient() as api_client:
242240

243241
### Authorization
244242

245-
No authorization required
243+
api_key -> can be obtained from our website at https://eod-stock-api.site
246244

247245
### HTTP request headers
248246

@@ -303,7 +301,7 @@ with src.IntelligentStockMarketAPI.ApiClient() as api_client:
303301

304302
### Authorization
305303

306-
No authorization required
304+
api_key -> can be obtained from our website at https://eod-stock-api.site
307305

308306
### HTTP request headers
309307

@@ -364,7 +362,7 @@ with src.IntelligentStockMarketAPI.ApiClient() as api_client:
364362

365363
### Authorization
366364

367-
No authorization required
365+
api_key -> can be obtained from our website at https://eod-stock-api.site
368366

369367
### HTTP request headers
370368

@@ -421,7 +419,7 @@ This endpoint does not need any parameter.
421419

422420
### Authorization
423421

424-
No authorization required
422+
api_key -> can be obtained from our website at https://eod-stock-api.site
425423

426424
### HTTP request headers
427425

0 commit comments

Comments
 (0)