Skip to content

Latest commit

 

History

History
365 lines (256 loc) · 13.2 KB

ExchangesApi.md

File metadata and controls

365 lines (256 loc) · 13.2 KB
Raw

Intelligent Stock Market API - Exchange API

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

Method HTTP request Description
v1_exchange_code_exchange_code_get GET /v1/exchange/code/{exchange_code}
v1_exchange_exchange_with_tickers_code_exchange_code_get GET /v1/exchange/exchange-with-tickers/code/{exchange_code}
v1_exchange_id_exchange_id_get GET /v1/exchange/id/{exchange_id}
v1_exchange_listed_companies_exchange_code_get GET /v1/exchange/listed-companies/{exchange_code}
v1_exchange_listed_stocks_exchange_code_get GET /v1/exchange/listed-stocks/{exchange_code}
v1_exchange_post POST /v1/exchange
v1_exchanges_get GET /v1/exchanges

Given Exchange ID or code Return Exchange Data

given exchange_id or exchange_code code will return exchange_code data

Example

from __future__ import print_function
import IntelligentStockMarketAPI
from IntelligentStockMarketAPI.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://gateway.eod-stock-api.site/api
# See configuration.py for a list of all supported configuration parameters.
configuration = IntelligentStockMarketAPI.Configuration(
    host = "https://gateway.eod-stock-api.site/api",
    api_key= "API KEY"
)


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

    try:
        api_response = api_instance.v1_exchange_code_exchange_code_get(exchange_code)
        pprint(api_response)
    except ApiException as e:
        print("Exception {}".format(e))

Parameters

Name Type Description Notes
exchange_code str

Return type

ExchangeResponse

Authorization

api_key -> can be obtained from our website at https://eod-stock-api.site

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Get Exchange With Its Ticker Symbols

Exchange Data with a total list of stock_codes and stock_id's

Example

from __future__ import print_function
import IntelligentStockMarketAPI
from IntelligentStockMarketAPI.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://gateway.eod-stock-api.site/api
# See configuration.py for a list of all supported configuration parameters.
configuration = IntelligentStockMarketAPI.Configuration(
    host = "https://gateway.eod-stock-api.site/api",
    api_key = "API Key"
)


# Enter a context with an instance of the API client
with IntelligentStockMarketAPI.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = IntelligentStockMarketAPI.ExchangesApi(api_client)
    exchange_code = 'TO' # str | 

    try:
        api_response = api_instance.v1_exchange_exchange_with_tickers_code_exchange_code_get(exchange_code)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExchangesApi: {}".format(e))

Parameters

Name Type Description Notes
exchange_code str

Return type

ExchangeWithListedTickers

Authorization

api_key -> can be obtained from our website at https://eod-stock-api.site

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
0 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v1_exchange_id_exchange_id_get

ExchangeResponse v1_exchange_id_exchange_id_get(exchange_id)

given exchange_id or exchange_code code will return exchange_code data

Example

from __future__ import print_function
import time
import IntelligentStockMarketAPI
from IntelligentStockMarketAPI.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://gateway.eod-stock-api.site/api
# See configuration.py for a list of all supported configuration parameters.
configuration = IntelligentStockMarketAPI.Configuration(
    host = "https://gateway.eod-stock-api.site/api"
)


# Enter a context with an instance of the API client
with IntelligentStockMarketAPI.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = IntelligentStockMarketAPI.ExchangesApi(api_client)
    exchange_id = 'exchange_id_example' # str | 

    try:
        api_response = api_instance.v1_exchange_id_exchange_id_get(exchange_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExchangesApi->v1_exchange_id_exchange_id_get: %s\n" % e)

Parameters

Name Type Description Notes
exchange_id str

Return type

ExchangeResponse

Authorization

api_key -> can be obtained from our website at https://eod-stock-api.site

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Exchange Listed Companies By Exchange Code

returns a list of listed companies in exchange_code

Example

from __future__ import print_function
import IntelligentStockMarketAPI
from IntelligentStockMarketAPI.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://gateway.eod-stock-api.site/api
# See configuration.py for a list of all supported configuration parameters.
configuration = IntelligentStockMarketAPI.Configuration(
    host = "https://gateway.eod-stock-api.site/api",
    api_key= "API KEY"
)


# Enter a context with an instance of the API client
with IntelligentStockMarketAPI.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = IntelligentStockMarketAPI.ExchangesApi(api_client)
    exchange_code = 'TO' # str | 

    try:
        api_response = api_instance.v1_exchange_listed_companies_exchange_code_get(exchange_code)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExchangesApi->v1_exchange_listed_companies_exchange_code_get: %s\n" % e)

Parameters

Name Type Description Notes
exchange_code str

Return type

ExchangeListedCompaniesResponse

Authorization

api_key -> can be obtained from our website at https://eod-stock-api.site

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
0 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Exchange Listed Stocks By Exchange Code

returns a list of listed stocks in exchange_code

Example

from __future__ import print_function
import time
import IntelligentStockMarketAPI
from IntelligentStockMarketAPI.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://gateway.eod-stock-api.site/api
# See configuration.py for a list of all supported configuration parameters.
configuration = IntelligentStockMarketAPI.Configuration(
    host = "https://gateway.eod-stock-api.site/api",
    api_key= "API Key"
)


# Enter a context with an instance of the API client
with IntelligentStockMarketAPI.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = IntelligentStockMarketAPI.ExchangesApi(api_client)
    exchange_code = 'exchange_code_example' # str | 

    try:
        api_response = api_instance.v1_exchange_listed_stocks_exchange_code_get(exchange_code)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExchangesApi->v1_exchange_listed_stocks_exchange_code_get: %s\n" % e)

Parameters

Name Type Description Notes
exchange_code str

Return type

ExchangeListedStock

Authorization

api_key -> can be obtained from our website at https://eod-stock-api.site

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
0 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Exchange List

returns a list of exchanges

Example

from __future__ import print_function
import IntelligentStockMarketAPI
from IntelligentStockMarketAPI.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://gateway.eod-stock-api.site/api
# See configuration.py for a list of all supported configuration parameters.
configuration = IntelligentStockMarketAPI.Configuration(
    host = "https://gateway.eod-stock-api.site/api",
    api_key = "API Key"
)


# Enter a context with an instance of the API client
with IntelligentStockMarketAPI.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = IntelligentStockMarketAPI.ExchangesApi(api_client)
    
    try:
        api_response = api_instance.v1_exchanges_get()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExchangesApi : {}".format(e))

Parameters

This endpoint does not need any parameter.

Return type

ExchangeListResponse

Authorization

api_key -> can be obtained from our website at https://eod-stock-api.site

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]