|
| 1 | +Metadata-Version: 2.1 |
| 2 | +Name: Intelligent-Stock-Market-API |
| 3 | +Version: 0.0.6 |
| 4 | +Summary: An Intelligent EOD Stock Market, Financial News & Financial Social Media Trends API |
| 5 | +Home-page: https://eod-stock-api.site |
| 6 | +Author: MJ API Development |
| 7 | + |
| 8 | +License: Apache 2.0 |
| 9 | +Project-URL: Documentation, https://github.com/MJ-API-Development/stock-api-pythonsdk |
| 10 | +Project-URL: Source, https://github.com/MJ-API-Development/stock-api-pythonsdk |
| 11 | +Project-URL: Tracker, https://github.com/MJ-API-Development/stock-api-pythonsdk/issues |
| 12 | +Project-URL: Subscribe - API Keys, https://eod-stock-api.site/login#signup |
| 13 | +Project-URL: Intelligent Stock Market API, https://eod-stock-api.site |
| 14 | +Project-URL: API Gateway, https://gateway.eod-stock-api.site |
| 15 | +Keywords: OpenAPI,Intelligent EOD Stock Market API,EOD STOCK API,Financial News API,Financial Social Media Trends |
| 16 | +Requires-Python: >=3.7 |
| 17 | +Description-Content-Type: text/markdown |
| 18 | + |
| 19 | +# Intelligent EOD Stock Market API Python SDK |
| 20 | + |
| 21 | +<h2>Intelligent EOD Stocks API</h2> |
| 22 | + <p> |
| 23 | + Intelligent Stock Market API provides end-of-day stock data worldwide, financial news, and financial social |
| 24 | + media trends for web application developers, researchers and service providers. |
| 25 | + The API covers over 150,000 tickers, stocks, mutual funds, and more from around the world. |
| 26 | + It offers information for any period, including daily, weekly. |
| 27 | + <ul> |
| 28 | + <li>Exchange Information</li> |
| 29 | + <li>Stock Tickers Data</li> |
| 30 | + <li>End of Day (EOD) Stock Data</li> |
| 31 | + <li>Fundamental Data</li> |
| 32 | + <li>Stock Options And Splits Data</li> |
| 33 | + <li>Financial News API</li> |
| 34 | + <li>Social Media Trend Data For Stocks</li> |
| 35 | + <li>Sentiment Analysis for News & Social Media</li> |
| 36 | + </ul> |
| 37 | + The information provided covers more than 150 000 tickers, stocks, mutual funds and more around the world. |
| 38 | + we provide information for any period, including daily, weekly. |
| 39 | + </p> |
| 40 | + |
| 41 | +- API version: v1 |
| 42 | +- Package version: 0.0.3 |
| 43 | + |
| 44 | +## Requirements. |
| 45 | + |
| 46 | +Python 3.4+ |
| 47 | + |
| 48 | +## Installation & Usage |
| 49 | +### pip install |
| 50 | + |
| 51 | +you can install directly from pypi - |
| 52 | +find our package at [Intelligent-Stock-Market-API](https://pypi.org/project/Intelligent-Stock-Market-API) |
| 53 | + |
| 54 | +On Windows |
| 55 | +```sh |
| 56 | + pip install Intelligent-Stock-Market-API |
| 57 | + |
| 58 | +``` |
| 59 | + |
| 60 | +On Linux |
| 61 | + you may need to run `pip` with root permission: |
| 62 | +```sh |
| 63 | + sudo pip install Intelligent-Stock-Market-API |
| 64 | +``` |
| 65 | + |
| 66 | + |
| 67 | +Then import the package: |
| 68 | +```python |
| 69 | +import IntelligentStockMarketAPI |
| 70 | +``` |
| 71 | + |
| 72 | +### Setuptools |
| 73 | + |
| 74 | + |
| 75 | +Install via [Setuptools](http://pypi.python.org/pypi/setuptools). |
| 76 | + |
| 77 | +On Windows |
| 78 | +```sh |
| 79 | +python setup.py install --user |
| 80 | +``` |
| 81 | + |
| 82 | +On Linux |
| 83 | +(or `sudo python setup.py install` to install the package for all users) |
| 84 | + |
| 85 | +Then import the package: |
| 86 | +```python |
| 87 | +import IntelligentStockMarketAPI |
| 88 | +``` |
| 89 | + |
| 90 | +## Getting Started |
| 91 | + |
| 92 | +Please follow the [installation procedure](#installation--usage) and then run the following: |
| 93 | + |
| 94 | + |
| 95 | +#### Defining the host is optional and defaults to https://gateway.eod-stock-api.site/api |
| 96 | +#### See configuration.py for a list of all supported configuration parameters. |
| 97 | + |
| 98 | +### EOD Data By Exchange and Date |
| 99 | + |
| 100 | +```python |
| 101 | +from __future__ import print_function |
| 102 | + |
| 103 | +import time |
| 104 | +import IntelligentStockMarketAPI |
| 105 | +from IntelligentStockMarketAPI.rest import ApiException |
| 106 | +from pprint import pprint |
| 107 | + |
| 108 | +# To get your API KEY visit [Intelligent EOD Stock Market API](https://eod-stock-market-api.site/login) |
| 109 | +# and create your free acoount |
| 110 | +configuration = IntelligentStockMarketAPI.Configuration( |
| 111 | + host = "https://gateway.eod-stock-api.site/api", |
| 112 | + api_key = "SECRET API KEY" |
| 113 | +) |
| 114 | + |
| 115 | +# Defining the host is optional and defaults to https://gateway.eod-stock-api.site/api |
| 116 | +# See configuration.py for a list of all supported configuration parameters. |
| 117 | +# Enter a context with an instance of the API client |
| 118 | +with IntelligentStockMarketAPI.ApiClient(configuration) as api_client: |
| 119 | + # Create an instance of the API class |
| 120 | + api_instance = IntelligentStockMarketAPI.EodApi(api_client) |
| 121 | + date = '2022-02-02' # str | |
| 122 | + exchange_code = 'TO' # str | "Country"="Canada", "name": "Toronto Exchange", "operating_mic": "XTSE" |
| 123 | + |
| 124 | + try: |
| 125 | + api_response = api_instance.v1_eod_date_exchange_code_get(date, exchange_code) |
| 126 | + pprint(api_response) |
| 127 | + except ApiException as e: |
| 128 | + print("Exception when calling EodApi->v1_eod_date_exchange_code_get: %s\n" % e) |
| 129 | +``` |
| 130 | + |
| 131 | + |
| 132 | +### Exchange Details with Complete Ticker List Endpoint |
| 133 | +```python |
| 134 | + |
| 135 | +from __future__ import print_function |
| 136 | +import time |
| 137 | +import IntelligentStockMarketAPI |
| 138 | +from IntelligentStockMarketAPI.rest import ApiException |
| 139 | +from pprint import pprint |
| 140 | +# Defining the host is optional and defaults to https://gateway.eod-stock-api.site/api |
| 141 | +# See configuration.py for a list of all supported configuration parameters. |
| 142 | +configuration = IntelligentStockMarketAPI.Configuration( |
| 143 | + host = "https://gateway.eod-stock-api.site/api", |
| 144 | + api_key = "SECRET API KEY" |
| 145 | +) |
| 146 | +# To get your API KEY visit [Intelligent EOD Stock Market API](https://eod-stock-market-api.site/login) |
| 147 | + |
| 148 | +# Enter a context with an instance of the API client |
| 149 | +with IntelligentStockMarketAPI.ApiClient(configuration) as api_client: |
| 150 | + # Create an instance of the API class |
| 151 | + api_instance = IntelligentStockMarketAPI.ExchangesApi(api_client) |
| 152 | + exchange_code = 'TO' # str | Toronto Exchange Canada |
| 153 | + |
| 154 | + try: |
| 155 | + api_response = api_instance.v1_exchange_exchange_with_tickers_code_exchange_code_get(exchange_code) |
| 156 | + pprint(api_response) |
| 157 | + except ApiException as e: |
| 158 | + print("Exception when calling ExchangesApi->v1_exchange_exchange_with_tickers_code_exchange_code_get: %s\n" % e) |
| 159 | +``` |
| 160 | + |
| 161 | +### Latest Financial News Feed |
| 162 | +### This will return the latest financial news articles grouped by their related tickers |
| 163 | + |
| 164 | +Get list of all News Upper Bound is an Integer indicating a total number of articles to return |
| 165 | + |
| 166 | +```python |
| 167 | +from __future__ import print_function |
| 168 | +import time |
| 169 | +import IntelligentStockMarketAPI |
| 170 | +from IntelligentStockMarketAPI.rest import ApiException |
| 171 | +from pprint import pprint |
| 172 | +# Defining the host is optional and defaults to http://https://gateway.eod-stock-api.site/api |
| 173 | +# See configuration.py for a list of all supported configuration parameters. |
| 174 | +configuration = IntelligentStockMarketAPI.Configuration( |
| 175 | + host = "http://https://gateway.eod-stock-api.site/api", |
| 176 | + api_key = "SECRET API KEY", |
| 177 | +) |
| 178 | + |
| 179 | + |
| 180 | +# Enter a context with an instance of the API client |
| 181 | +with IntelligentStockMarketAPI.ApiClient(configuration) as api_client: |
| 182 | + # Create an instance of the API class |
| 183 | + api_instance = IntelligentStockMarketAPI.FinancialNewsApi(api_client) |
| 184 | + upper_bound = 56 # int | |
| 185 | + try: |
| 186 | + api_response = api_instance.v1_news_articles_bounded_upper_bound_get(upper_bound) |
| 187 | + pprint(api_response) |
| 188 | + except ApiException as e: |
| 189 | + print("Exception when calling FinancialNewsApi->v1_news_articles_bounded_upper_bound_get: %s\n" % e) |
| 190 | +``` |
| 191 | + |
| 192 | + |
| 193 | +### Get Financial News Articles By Ticker |
| 194 | + |
| 195 | +### Example |
| 196 | + |
| 197 | +```python |
| 198 | +from __future__ import print_function |
| 199 | +import time |
| 200 | +import IntelligentStockMarketAPI |
| 201 | +from IntelligentStockMarketAPI.rest import ApiException |
| 202 | +from pprint import pprint |
| 203 | +# Defining the host is optional and defaults to http://https://gateway.eod-stock-api.site/api |
| 204 | +# See configuration.py for a list of all supported configuration parameters. |
| 205 | +configuration = IntelligentStockMarketAPI.Configuration( |
| 206 | + host = "http://https://gateway.eod-stock-api.site/api", |
| 207 | + api_key = "SECRET API KEY", |
| 208 | +) |
| 209 | + |
| 210 | + |
| 211 | +# Enter a context with an instance of the API client |
| 212 | +with IntelligentStockMarketAPI.ApiClient(configuration) as api_client: |
| 213 | + # Create an instance of the API class |
| 214 | + api_instance = IntelligentStockMarketAPI.FinancialNewsApi(api_client) |
| 215 | + stock_code = 'stock_code_example' # str | |
| 216 | + |
| 217 | + try: |
| 218 | + api_response = api_instance.v1_news_articles_by_ticker_stock_code_get(stock_code) |
| 219 | + pprint(api_response) |
| 220 | + except ApiException as e: |
| 221 | + print("Exception when calling FinancialNewsApi->v1_news_articles_by_ticker_stock_code_get: %s\n" % e) |
| 222 | +``` |
| 223 | + |
| 224 | + |
| 225 | +## Documentation for API Endpoints |
| 226 | + |
| 227 | +All URIs are relative to *https://gateway.eod-stock-api.site/api* |
0 commit comments