Skip to content

Commit 80c0036

Browse files
Update Documentation
Exchange Documentations
1 parent 7f39e58 commit 80c0036

File tree

1 file changed

+18
-86
lines changed

1 file changed

+18
-86
lines changed

src/docs/ExchangesApi.md

Lines changed: 18 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -187,37 +187,34 @@ api_key -> can be obtained from our website at https://eod-stock-api.site
187187
### HTTP response details
188188
| Status code | Description | Response headers |
189189
|-------------|-------------|------------------|
190-
| **0** | | - |
190+
| **200** | | - |
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_exchange_listed_companies_exchange_code_get**
195-
> ExchangeListedCompaniesResponse v1_exchange_listed_companies_exchange_code_get(exchange_code)
196-
197-
194+
# **Exchange Listed Companies By Exchange Code**
198195

199196
returns a list of listed companies in exchange_code
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.ExchangesApi(api_client)
220-
exchange_code = 'exchange_code_example' # str |
217+
exchange_code = 'TO' # str |
221218

222219
try:
223220
api_response = api_instance.v1_exchange_listed_companies_exchange_code_get(exchange_code)
@@ -252,10 +249,7 @@ api_key -> can be obtained from our website at https://eod-stock-api.site
252249

253250
[[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)
254251

255-
# **v1_exchange_listed_stocks_exchange_code_get**
256-
> ExchangeListedStock v1_exchange_listed_stocks_exchange_code_get(exchange_code)
257-
258-
252+
# **Exchange Listed Stocks By Exchange Code**
259253

260254
returns a list of listed stocks in exchange_code
261255

@@ -270,12 +264,13 @@ 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.ExchangesApi(api_client)
281276
exchange_code = 'exchange_code_example' # str |
@@ -313,99 +308,36 @@ api_key -> can be obtained from our website at https://eod-stock-api.site
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

316-
# **v1_exchange_post**
317-
> ExchangeResponse v1_exchange_post(body=body)
318-
319-
320-
321-
given exchange_code data create new exchange_code
322-
323-
### Example
324-
325-
```python
326-
from __future__ import print_function
327-
import time
328-
import IntelligentStockMarketAPI
329-
from IntelligentStockMarketAPI.rest import ApiException
330-
from pprint import pprint
331-
# Defining the host is optional and defaults to https://gateway.eod-stock-api.site/api
332-
# See configuration.py for a list of all supported configuration parameters.
333-
configuration = IntelligentStockMarketAPI.Configuration(
334-
host = "https://gateway.eod-stock-api.site/api"
335-
)
336-
337-
338-
# Enter a context with an instance of the API client
339-
with IntelligentStockMarketAPI.ApiClient() as api_client:
340-
# Create an instance of the API class
341-
api_instance = IntelligentStockMarketAPI.ExchangesApi(api_client)
342-
body = IntelligentStockMarketAPI.ExchangeRequest() # ExchangeRequest | (optional)
343-
344-
try:
345-
api_response = api_instance.v1_exchange_post(body=body)
346-
pprint(api_response)
347-
except ApiException as e:
348-
print("Exception when calling ExchangesApi->v1_exchange_post: %s\n" % e)
349-
```
350-
351-
### Parameters
352-
353-
| Name | Type | Description | Notes |
354-
|----------|-------------------------------------------|-------------|------------|
355-
| **body** | [**ExchangeRequest**](ExchangeRequest.md) | | [optional] |
356-
357-
### Return type
358-
359-
[**ExchangeResponse**](ExchangeResponse.md)
360-
361-
### Authorization
362-
363-
api_key -> can be obtained from our website at https://eod-stock-api.site
364-
365-
### HTTP request headers
366-
367-
- **Content-Type**: application/json
368-
- **Accept**: application/json
369-
370-
### HTTP response details
371-
| Status code | Description | Response headers |
372-
|-------------|-------------|------------------|
373-
| **0** | | - |
374-
375-
[[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)
376-
377-
# **v1_exchanges_get**
378-
> ExchangeListResponse v1_exchanges_get()
379-
380-
311+
# **Exchange List**
381312

382313
returns a list of exchanges
383314

384315
### Example
385316

386317
```python
387318
from __future__ import print_function
388-
import time
389319
import IntelligentStockMarketAPI
390320
from IntelligentStockMarketAPI.rest import ApiException
391321
from pprint import pprint
392322
# Defining the host is optional and defaults to https://gateway.eod-stock-api.site/api
393323
# See configuration.py for a list of all supported configuration parameters.
394324
configuration = IntelligentStockMarketAPI.Configuration(
395-
host = "https://gateway.eod-stock-api.site/api"
325+
host = "https://gateway.eod-stock-api.site/api",
326+
api_key = "API Key"
396327
)
397328

398329

399330
# Enter a context with an instance of the API client
400-
with IntelligentStockMarketAPI.ApiClient() as api_client:
331+
with IntelligentStockMarketAPI.ApiClient(configuration) as api_client:
401332
# Create an instance of the API class
402333
api_instance = IntelligentStockMarketAPI.ExchangesApi(api_client)
403334

404335
try:
405336
api_response = api_instance.v1_exchanges_get()
406337
pprint(api_response)
407338
except ApiException as e:
408-
print("Exception when calling ExchangesApi->v1_exchanges_get: %s\n" % e)
339+
print("Exception when calling ExchangesApi : {}".format(e))
340+
409341
```
410342

411343
### Parameters
@@ -421,13 +353,13 @@ api_key -> can be obtained from our website at https://eod-stock-api.site
421353

422354
### HTTP request headers
423355

424-
- **Content-Type**: Not defined
356+
- **Content-Type**: application/json
425357
- **Accept**: application/json
426358

427359
### HTTP response details
428360
| Status code | Description | Response headers |
429361
|-------------|-------------|------------------|
430-
| **0** | | - |
362+
| **200** | | - |
431363

432364
[[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)
433365

0 commit comments

Comments
 (0)