rodolfobandeira / iex-cpp-client Goto Github PK

View Code? Open in Web Editor NEW

7.0 3.0 4.0 45 KB

IEX Finance API C++ Client. Stock Tracking, Companies Information, Financial Reports, Dividends, Statistics, Etc

License: MIT License

C++ 97.32% Shell 0.80% CMake 1.87%

iex stocks stock-data finance financial-data cpp hacktoberfest

iex-cpp-client's Introduction

IEX Finance C++ Client

C++ client to consume the IEX Finance API.

Usage

IEX C++ Client 

./main stock_symbol option
    ex: ./main AMZN -p 

 options:
   -c Company Information
   -l Company Logo
   -p Stock Latest Price
   -s Stock Statistics
   -r Stock Financial Reports
   -d Stock Dividends

Compilation

On Debian-based distributions you can install the required dependencies using the following command:

sudo apt-get install libjsoncpp-dev libcurl4-gnutls-dev

On MacOS using Homebrew:

brew install jsoncpp; brew install curl

g++ -o main main.cpp -lcurl -ljsoncpp -std=c++11

./main AMZN -p

Called Endpoint: https://api.iextrading.com/1.0/stock/AMZN/price
Stock Symbol: AMZN
Latest Price: $1952.07

Compiling Using CMake

Compile this project using standing CMake:

mkdir build
cd build
cmake ..
make
./main AMZN

Or, for an optimized build:

mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Release
make
./main AMZN

Contributing

See CONTRIBUTING.

Copyright and License

This project is licensed under the MIT License.

Data provided for free by IEX, see terms.

iex-cpp-client's People

Contributors

Stargazers

Watchers

Forkers

mvilkin mpherg nlipiarski chudleyj

iex-cpp-client's Issues

Implement getEarnings

Reference: https://iextrading.com/developer/docs/#earnings

Implement getDividends

Reference: https://iextrading.com/developer/docs/#dividends

Add error handler when stock symbol is invalid

./main STOCK_SYMBOL_THAT_DOESNT_EXIST -d
Error from reader: * Line 1, Column 1
  Syntax error: value, object or array expected.
terminate called after throwing an instance of 'Json::RuntimeError'
  what():  * Line 1, Column 1
  Syntax error: value, object or array expected.

Aborted (core dumped)

IEX Cloud

#rip to the free, open and public IEX API. Looks like now everyone that wants to use it will need to create an account on https://iexcloud.io/ and get its own token.

That being said, we might need to implement support to this new logic on the project.

I didn't scope the effort to implement it here yet. I'll take a look on how it was implemented on https://github.com/dblock/iex-ruby-client and update here before starting this task

Implement getCompanyInfo

Reference: https://iextrading.com/developer/docs/#company

To use or not to use clang-format

@rodolfobandeira how to you feel about adding a clause to the README.md requiring clang-formatting for all contributions? It's a nice way to keep the formatting of the code consistently readable and maintainable. However, it also requires another tool. I like it because it can be easily integrated into nearly every editor, as well as git (git clang-format, anyone?).

Fix deprecation warnings on MacOS and libjsoncpp > 1.7

Homebrew installs the latest jsoncpp library. (Version: 1.8.4). On this version there is a deprecation warning message saying that we should replace Json::Reader to Json::CharReaderBuilder

There is no deprecation warnings when using jsoncpp 1.7.*.

Work in progress: #8