Skip to content

Latest commit

 

History

History
54 lines (48 loc) · 3.88 KB

README.md

File metadata and controls

54 lines (48 loc) · 3.88 KB
Raw

A C++20 library for the cryptocurrency data provider, CoinGecko.

Description

CoinGecko is a service that provides a fundamental analysis of the crypto market. As one of the largest and earliest crypto data aggregators--operating since early 2014--it currently tracks nearly 6283 tokens from more than 428 cryptocurrency exchanges. In addition to tracking price, volume and market capitalization, it tracks community growth, open-source code development, major events, and on-chain metrics. Its objective is to elevate crypto participants’ understanding of fundamental factors that drive the market.

With this C++ library--being one of many open-source API libraries--you can retrieve useful cryptocurrency and market-related information on the fly within any respective application using a simple syntax.


Installation

To use in your project(s), simply download the latest CoinGecko release and link to the appropriate set of included libraries. Keep in mind that if the release you choose--or the latest available--is a pre-release, expect untested functionality.

You can find a starting point, sample code, and all other documentation within /documentation.


Dependencies

Note All dependencies used to compile CoinGecko were implemented via vcpkg.

CoinGecko depends on the following packages:

  • cURL : C library for HTTP(S) things (v7.84.0)
  • CPR : cURL wrapper to make it less monotonous (v1.8.3)
  • OpenSSL : to be able to make HTTPS requests (v3.0.5)
  • zlib : used internally in cURL for compression (v1.2.12#1)

Structure

This repository abides by the following structure:

  CoinGecko/            : root
    src/                   : source files directory
      include/                : header files directory
    documentation/         : base documentation folder
      coins/                  : API 'coins' functions
      contract/               : API 'contract' functions
      derivatives/            : API 'derivatives' functions
      exchange_rates/         : API 'exchange_rates' functions 
      exchanges/              : API 'exchanges' functions
      finance/                : API 'finance' functions
      global/                 : API 'global' functions
      indexes/                : API 'indexes' functions
      simple/                 : API 'simple' functions
      status_updates/         : API 'status_updates' functions
      trending/               : API 'trending' functions
      asset_platforms/        : API 'asset_platforms' functions
      categories/             : API 'categories' functions
      companies/              : API 'companies' functions
    vs/                    : Visual Studio solution folder  
    images/                : image folder for repository