README.md

Documentation resources for CoinGecko's 'companies' API functions.

---

Class

namespace gecko {
  // Purpose: class interface to all CoinGecko 'companies' functions found below
  // Refer: https://www.coingecko.com/api/documentations/v3#/companies_(beta)
  // Status: functional - slightly tested
  class companiesFunctions : private web {
    ...
  };
}

Declarations

Below you can find documentation for 'companies' functions.

companies/getCompaniesData

  // Action: Get public companies bitcoin or ethereum holdings
  // Returns: gecko::web::response
  // Refer: https://www.coingecko.com/api/documentations/v3
  // Example(s):
  //    getCompaniesData("bitcoin");
  //    getCompaniesData("ethereum");
  // Notes: none
  gecko::web::response getCompaniesData(
    REQUIRED std::string id
  );