Skip to content

Commit 920da12

Browse files
committed
Readme update
1 parent 169ff62 commit 920da12

1 file changed

Lines changed: 37 additions & 9 deletions

File tree

README.md

Lines changed: 37 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,49 @@
11
# Official EODHD APIs Python Library
2-
https://eodhd.com
2+
[Full documentation](https://eodhd.com/financial-apis/python-financial-libraries-and-code-samples/)
3+
4+
This is the official Python library developed by [EODHD](https://eodhd.com) for accessing various financial data via API in your code. If you have any feedback or questions, you can reach out to our support team, available 24/7 via live chat on [our website](https://eodhd.com).
5+
6+
To access our APIs, you need to register on our site (it’s free) and obtain an API key. Access to some data requires a subscription to one of [our paid plans](https://eodhd.com/pricing).
7+
8+
## List of supported data:
9+
10+
* End of the Day Historical Stock Market Data
11+
* Live (Delayed) Stock Prices and Macroeconomic Data
12+
* Bonds Fundamentals
13+
* Intraday Historical Data
14+
* Historical Dividends
15+
* Historical Splits
16+
* Bulk API for EOD, Splits and Dividends
17+
* Calendar. Upcoming Earnings, Trends, IPOs and Splits
18+
* Economic Events
19+
* Stock Market and Financial News
20+
* List of supported Exchanges
21+
* Insider Transactions
22+
* Macro Indicators
23+
* Exchange API. Trading Hours, Stock Market Holidays, Symbols Change History
24+
* Stock Market Screener
25+
* Technical Indicator
26+
* Historical Market Capitalization
27+
* Fundamental Data: Stocks, ETFs, Mutual Funds, Indices and Cryptocurrencies
28+
29+
All functions are described in our [documentation](https://eodhd.com/financial-apis/python-financial-libraries-and-code-samples/).
30+
331

432
## Installation
533

6-
python3 -m pip install eodhd -U
34+
In short:
735

8-
## Note
36+
python3 -m pip install eodhd -U
937

10-
Demo API key below is provided by EOD Historial Data for testing purposes
11-
<https://eodhd.com/financial-apis/new-real-time-data-api-websockets?utm_source=github&utm_medium=eod&utm_campaign=python_lib>
38+
If you have any difficulties, go to our full [documentation](https://eodhd.com/financial-apis/python-financial-libraries-and-code-samples/) with step by step instructions.
1239

1340
## Sample code and examples
1441

15-
The files below contain examples of available functions
42+
The files below contain examples of available functions:
43+
44+
* example_api.py: describes the functions that can be used in the APIClient class.
45+
* example_scanner.py: describes the functions that can be used in the ScannerClient class.
46+
* example_websockets.py: describes the functions that can be used in the WebSocketClient class.
1647

17-
* example_api.py - describes the functions that can be used in the apiclient file (APIClient class)
18-
* example_scanner.py - describes the functions that can be used in the apiclient file (ScannerClient class)
19-
* example_websockets.py - describes the functions that can be used in the websocketclient file (WebSocketClient class)
2048

2149
New features will be added to the example files. The most relevant functions can be viewed directly in the code files.

0 commit comments

Comments
 (0)