Skip to content

Python SDK for our Intelligent Stock Market , Financial News & Financial Social Media Trends API

License

Notifications You must be signed in to change notification settings

MJ-API-Development/stock-api-pythonsdk

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

51 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Intelligent EOD Stock Market API Python SDK

PyPI

Intelligent EOD Stocks API

Intelligent Stock Market API provides end-of-day stock data worldwide, financial news, and financial social media trends for web application developers, researchers and service providers. The API covers over 150,000 tickers, stocks, mutual funds, and more from around the world. It offers information for any period, including daily, weekly.

  • Exchange Information
  • Stock Tickers Data
  • End of Day (EOD) Stock Data
  • Fundamental Data
  • Stock Options And Splits Data
  • Financial News API
  • Social Media Trend Data For Stocks
  • Sentiment Analysis for News & Social Media
The information provided covers more than 150 000 tickers, stocks, mutual funds and more around the world. we provide information for any period, including daily, weekly.

  • API version: v1
  • Package version: 0.0.3

Requirements.

Python 3.4+

Installation & Usage

pip install

you can install directly from pypi - find our package at Intelligent-Stock-Market-API

On Windows

    pip install Intelligent-Stock-Market-API
    

On Linux you may need to run pip with root permission:

  sudo pip install Intelligent-Stock-Market-API

Then import the package:

import IntelligentStockMarketAPI

Setuptools

Install via Setuptools.

On Windows

python setup.py install --user

On Linux (or sudo python setup.py install to install the package for all users)

Then import the package:

import IntelligentStockMarketAPI

Getting Started

Please follow the installation procedure and then run the following:

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.

EOD Data By Exchange and Date

from __future__ import print_function

import time
import IntelligentStockMarketAPI
from IntelligentStockMarketAPI.rest import ApiException
from pprint import pprint

# To get your API KEY visit [Intelligent EOD Stock Market API](https://eod-stock-market-api.site/login) 
# and create your free acoount 
configuration = IntelligentStockMarketAPI.Configuration(
    host = "https://gateway.eod-stock-api.site/api",
    api_key = "SECRET API KEY"
)

# 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.
# 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.EodApi(api_client)
    date = '2022-02-02' # str | 
    exchange_code = 'TO' # str | "Country"="Canada", "name": "Toronto Exchange", "operating_mic": "XTSE" 

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

Exchange Details with Complete Ticker List Endpoint

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 = "SECRET API KEY"
)
# To get your API KEY visit [Intelligent EOD Stock Market API](https://eod-stock-market-api.site/login)

# 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 | Toronto Exchange Canada 

    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->v1_exchange_exchange_with_tickers_code_exchange_code_get: %s\n" % e)

Latest Financial News Feed

This will return the latest financial news articles grouped by their related tickers

Get list of all News Upper Bound is an Integer indicating a total number of articles to return

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 http://https://gateway.eod-stock-api.site/api
# See configuration.py for a list of all supported configuration parameters.
configuration = IntelligentStockMarketAPI.Configuration(
    host = "http://https://gateway.eod-stock-api.site/api",
    api_key = "SECRET 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.FinancialNewsApi(api_client)
    upper_bound = 56 # int | 
    try:
        api_response = api_instance.v1_news_articles_bounded_upper_bound_get(upper_bound)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling FinancialNewsApi->v1_news_articles_bounded_upper_bound_get: %s\n" % e)

Get Financial News Articles By Ticker

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 http://https://gateway.eod-stock-api.site/api
# See configuration.py for a list of all supported configuration parameters.
configuration = IntelligentStockMarketAPI.Configuration(
    host = "http://https://gateway.eod-stock-api.site/api",
    api_key = "SECRET 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.FinancialNewsApi(api_client)
    stock_code = 'stock_code_example' # str | 

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

Documentation for API Endpoints

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

End of Day API Documentations

Class Method HTTP request Description
EodApi v1_eod_date_exchange_code_get GET /v1/eod/{_date}/{exchange_code}
EodApi v1_eod_date_exchange_code_stock_code_get GET /v1/eod/{_date}/{exchange_code}.{stock_code}
EodApi v1_eod_from_to_exchange_code_get GET /v1/eod/{_from}.{_to}/{exchange_code}
EodApi v1_eod_from_to_stock_code_get GET /v1/eod/{_from}.{_to}/{stock_code}

Exchange Data API Documentations

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

Financial News & Social Media Trends APi Documentations

Class Method HTTP request Description
FinancialNewsApi v1_news_article_uuid_get GET /v1/news/article/{uuid}
FinancialNewsApi v1_news_articles_bounded_upper_bound_get GET /v1/news/articles-bounded/{upper_bound}
FinancialNewsApi v1_news_articles_by_date_date_get GET /v1/news/articles-by-date/{_date}
FinancialNewsApi v1_news_articles_by_publisher_publisher_get GET /v1/news/articles-by-publisher/{publisher}
FinancialNewsApi v1_news_articles_by_ticker_stock_code_get GET /v1/news/articles-by-ticker/{stock_code}

Fundamental Data API Documentations

Class Method HTTP request Description
FundamentalsApi v1_fundamental_company_stock_code_get GET /v1/fundamental/company/{stock_code}
FundamentalsApi v1_fundamental_general_get GET /v1/fundamental/general
FundamentalsApi v1_fundamentals_annual_balance_sheet_filing_date_stock_code_get GET /v1/fundamentals/annual-balance-sheet/{filing_date}/{stock_code}
FundamentalsApi v1_fundamentals_company_address_id_fundamental_id_get GET /v1/fundamentals/company-address/id/{fundamental_id}
FundamentalsApi v1_fundamentals_company_address_stock_stock_code_get GET /v1/fundamentals/company-address/stock/{stock_code}
FundamentalsApi v1_fundamentals_company_details_id_fundamental_id_get GET /v1/fundamentals/company-details/id/{fundamental_id}
FundamentalsApi v1_fundamentals_company_details_stock_stock_code_get GET /v1/fundamentals/company-details/stock/{stock_code}
FundamentalsApi v1_fundamentals_company_insider_transactions_stock_code_stock_code_year_get GET /v1/fundamentals/company-insider-transactions/stock-code/{stock_code}/{year}
FundamentalsApi v1_fundamentals_company_valuations_stock_code_stock_code_year_get GET /v1/fundamentals/company-valuations/stock-code/{stock_code}/{year}
FundamentalsApi v1_fundamentals_exchange_analyst_rankings_exchange_code_exchange_code_year_get GET /v1/fundamentals/exchange-analyst-rankings/exchange-code/{exchange_code}/{year}
FundamentalsApi v1_fundamentals_exchange_outstanding_shares_exchange_code_exchange_code_year_get GET /v1/fundamentals/exchange-outstanding-shares/exchange-code/{exchange_code}/{year}
FundamentalsApi v1_fundamentals_financial_statements_by_term_from_to_stock_code_term_get GET /v1/fundamentals/financial-statements/by-term/{_from}.{_to}/{stock_code}/{term}
FundamentalsApi v1_fundamentals_financial_statements_company_statement_stock_code_year_get GET /v1/fundamentals/financial-statements/company-statement/{stock_code}/{year}
FundamentalsApi v1_fundamentals_financial_statements_exchange_year_exchange_code_year_get GET /v1/fundamentals/financial-statements/exchange-year/{exchange_code}/{year}
FundamentalsApi v1_fundamentals_financial_statements_filing_date_ticker_filing_date_stock_code_get GET /v1/fundamentals/financial-statements/filing-date-ticker/{filing_date}/{stock_code}
FundamentalsApi v1_fundamentals_financial_statements_ticker_date_range_from_to_stock_code_get GET /v1/fundamentals/financial-statements/ticker-date-range/{_from}.{_to}/{stock_code}
FundamentalsApi v1_fundamentals_financials_income_statements_statement_id_get GET /v1/fundamentals/financials/income-statements/{statement_id}
FundamentalsApi v1_fundamentals_highlights_id_fundamental_id_get GET /v1/fundamentals/highlights/id/{fundamental_id}
FundamentalsApi v1_fundamentals_highlights_stock_stock_code_get GET /v1/fundamentals/highlights/stock/{stock_code}
FundamentalsApi v1_fundamentals_quarterly_balance_sheet_filing_date_stock_code_get GET /v1/fundamentals/quarterly-balance-sheet/{filing_date}/{stock_code}
FundamentalsApi v1_fundamentals_tech_indicators_by_company_stock_code_stock_code_year_get GET /v1/fundamentals/tech-indicators-by-company/stock-code/{stock_code}/{year}
FundamentalsApi v1_fundamentals_tech_indicators_by_exchange_exchange_code_exchange_code_year_get GET /v1/fundamentals/tech-indicators-by-exchange/exchange-code/{exchange_code}/{year}

Calls & Options API Documentations

Class Method HTTP request Description
OptionsApi v1_stocks_contract_call_put_id_get GET /v1/stocks/contract/{call_put_id}
OptionsApi v1_stocks_options_stock_stock_code_get GET /v1/stocks/options/stock/{stock_code}

Sentiment Analysis API Documentations

Class Method HTTP request Description
SentimentApi v1_sentiment_trend_setters_stock_stock_code_get GET /v1/sentiment/trend-setters/stock/{stock_code}
SentimentApi v1_sentiment_trending_stock_stock_code_get GET /v1/sentiment/trending/stock/{stock_code}
SentimentApi v1_sentiment_tweet_stock_stock_code_get GET /v1/sentiment/tweet/stock/{stock_code}

Stock Data / Tickers API Documentations

Class Method HTTP request Description
StocksApi v1_stock_code_stock_code_get GET /v1/stock/code/{stock_code}
StocksApi v1_stocks_country_country_get GET /v1/stocks/country/{country}
StocksApi v1_stocks_currency_currency_get GET /v1/stocks/currency/{currency}
StocksApi v1_stocks_exchange_code_exchange_code_get GET /v1/stocks/exchange/code/{exchange_code}
StocksApi v1_stocks_exchange_id_exchange_id_get GET /v1/stocks/exchange/id/{exchange_id}
StocksApi v1_stocks_get GET /v1/stocks
StocksApi v1_stocks_post POST /v1/stocks

Documentation For Models

Documentation For Authorization

basicAuth

  • Type:
    • apikey

To authenticate your API requests, you will need to include your API key in the request parameters. The API key is a unique identifier that associates your API usage with your account.

To include your API key in a request, simply include it as a parameter named "apikey" in the request URL. For example:

    https://gateway.eod-stock-api.site/api/v1/exchanges?apikey=YOUR_API_KEY

Make sure to replace "YOUR_API_KEY" with your actual API key value.

Note that when using our SDK you need to initialize your SDK with your API key refer to getting started section above.

Author

Community