Skip to content

Commit 4513126

Browse files
freelancing-solutionsfreelancing-solutions
committed
Update Documentation
updated package for release
1 parent d28bbbc commit 4513126

File tree

3 files changed

+239
-25
lines changed

3 files changed

+239
-25
lines changed

‎README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@
22

33
<h2>Intelligent EOD Stocks API</h2>
44
<p>
5-
End of day stock world wide STOCK API, this api is intended for use by web application developers,
6-
and service providers looking for up-to-date always available.
5+
Intelligent Stock Market API provides end-of-day stock data worldwide, financial news, and financial social
6+
media trends for web application developers, researchers and service providers.
7+
The API covers over 150,000 tickers, stocks, mutual funds, and more from around the world.
8+
It offers information for any period, including daily, weekly.
79
<ul>
810
<li>Exchange Information</li>
911
<li>Stock Tickers Data</li>

‎src/PROJECT_README.MD

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

‎src/setup.py

Lines changed: 26 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,33 @@
33
"""
44
EOD STOCK API
55
6-
<h2>Intelligent EOD Stocks API</h2> <p> End of day stock world wide STOCK API, this api is intended for use by web application developers, and service providers looking for up-to-date always available. <ul> <li>Exchange Information</li> <li>Stock Tickers Data</li> <li>End of Day (EOD) Stock Data</li> <li>Fundamental Data</li> <li>Stock Options And Splits Data</li> <li>Financial News API</li> <li>Social Media Trend Data For Stocks</li> <li>Sentiment Analysis for News & Social Media</li> </ul> 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. </p> # noqa: E501
6+
<h2>Intelligent EOD Stocks API</h2>
7+
<p>
8+
Intelligent Stock Market API provides end-of-day stock data worldwide, financial news, and financial social
9+
media trends for web application developers, researchers and service providers.
10+
The API covers over 150,000 tickers, stocks, mutual funds, and more from around the world.
11+
It offers information for any period, including daily, weekly.
12+
</p>
13+
<ul>
14+
<li>Exchange Information</li>
15+
<li>Stock Tickers Data</li>
16+
<li>End of Day (EOD) Stock Data</li>
17+
<li>Fundamental Data</li>
18+
<li>Stock Options And Splits Data</li>
19+
<li>Financial News API</li>
20+
<li>Social Media Trend Data For Stocks</li>
21+
<li>Sentiment Analysis for News & Social Media</li>
22+
</ul>
23+
<p>
24+
The information provided covers more than 150 000 tickers, stocks, mutual funds and more around the world.
25+
we provide information for any period, including daily, weekly.
26+
</p>
727
8-
The version of the OpenAPI document: v1
928
Contact: [email protected]
10-
Generated by: https://openapi-generator.tech
1129
"""
30+
from pathlib import Path
31+
this_directory = Path(__file__).parent
32+
long_description = (this_directory / "PROJECT_README.md").read_text()
1233

1334

1435
from setuptools import setup, find_packages # noqa: H301
@@ -45,24 +66,6 @@
4566
packages=find_packages(exclude=["test", "tests"]),
4667
include_package_data=True,
4768
license="Apache 2.0",
48-
49-
long_description="""
50-
The Intelligent EOD Stocks API is an end-of-day stock API that provides worldwide stock information.
51-
This API is intended for use by web application developers and service providers who need up-to-date and always
52-
available stock data. The API offers the following endpoints
53-
54-
exchange information,
55-
stock tickers data,
56-
end-of-day (EOD) stock data,
57-
fundamental data,
58-
stock options
59-
splits data,
60-
financial news API,
61-
social media trend data for stocks,
62-
sentiment analysis for news and social media.
63-
64-
The API covers more than 150,000 tickers, stocks, mutual funds, and more around the world and provides information
65-
for any period, including daily and weekly.
66-
"""
67-
69+
long_description=long_description,
70+
long_description_content_type='text/markdown'
6871
)

0 commit comments

Comments
 (0)