Skip to content

Latest commit

 

History

History
67 lines (49 loc) · 1.8 KB

README.md

File metadata and controls

67 lines (49 loc) · 1.8 KB

MarketData

A Market Data C++ API

MarketData is a C++ API to fetch market data. This API allows you to download historic market data and some general information about companies that are on public finance websites and APIs.

This library is currently under development and this README will be updated when new features are added.

Getting Started

Before attempting the build the library, make sure you meet all requirements.

Requirements

Installation

  1. Clone the repo
git clone https://github.com/JigsawCorp/MarketData
  1. Create build directory
cd MarketData
mkdir build
cd build
  1. Run CMake with desired options.

The following command will create a static version of MarketData as well as tests.

cmake -DBUILD_STATIC=ON -DDBUILD_TESTS=ON ..

Available options are the following:

  • DBUILD_TESTS: Generates an executable that will run tests on the project.
  • DBUILD_STATIC: Generates a static library version of MarketData.
  • DBUILD_SHARED: Generates a shared library version of MarketData.
  • DBUILD_HEADER: Generates a header-only library version of MarketData.
  • DBUILD_SRC: Generates an uncompiled target allowing you to compile the library with your project.

You can use as many options as you want and generate all 4 library types if desired.

  1. (Optional) Install the library on your system
make install

License

Distributed under the MIT License. See LICENSE for more information.