Skip to content

Commit 69dc32b

Browse files
author
Fred BLOT
committed
README.md update
1 parent a37ec97 commit 69dc32b

File tree

1 file changed

+39
-1
lines changed

1 file changed

+39
-1
lines changed

Diff for: README.md

+39-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,41 @@
11
# EODHistoricalData.NET
22

3-
C# Wrapper for EODHistoricalData REST API
3+
4+
EODHistoricalData.NET is an easy-to-use .NET wrapper for EODHistoricalData REST API written in C#.
5+
6+
## Getting Started
7+
EODHistoricalData.NET is a stand-alone .NET project.
8+
You can download the sources and add it as a project if you think you will need Debug possibilities.
9+
Or you can download the binary from the Release folder and add it as a file reference.
10+
11+
## Usage
12+
13+
### Instantiation
14+
Usage of a wrapper can't be more easy.
15+
You instantiate the EODHistoricalDataClient object, which is a Facade pattern, using your API token and you're good to go :
16+
17+
EODHistoricalDataClient client = new EODHistoricalDataClient(Consts.ApiToken, true);
18+
19+
The boolean parameter, which is optional, is the use of system-defined proxy.
20+
Specific full proxy configuration is not supported yet.
21+
22+
### Api calls
23+
Then you just have to call the API you want, which returns the response in the corresponding structure.
24+
Here are a few examples :
25+
26+
List<HistoricalPrice> prices = client.GetHistoricalPrices(Consts.TestSymbol, Consts.StartDate, Consts.EndDate);
27+
28+
List<RealTimePrice> prices = client.GetRealTimePrices(Consts.MultipleTestSymbol);
29+
30+
Each method as its own set of parameters corresponding of the REST API parameters.
31+
32+
For an exhaustive list of possible calls, you can check the units tests in the folder EODHistoricalData.NET.Tests folder.
33+
34+
## Authors
35+
36+
### Fred Blot : initial work
37+
Autoquant (https://www.autoquant.fr)
38+
going-striker (https://github.com/going-striker)
39+
40+
### EODHistoricalData
41+
https://eodhistoricaldata.com/

0 commit comments

Comments
 (0)