README.md

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

---

Class

namespace gecko {
  // Purpose: class interface to all CoinGecko 'finance' functions found below
  // Refer: https://www.coingecko.com/api/documentations/v3#/finance_(beta)
  // Status: beta, likely unstable - slightly tested
  class financeFunctions : private web {
    ...
  };
}

Declarations

Below you can find documentation for 'finance' functions.

finance/listFinancePlatforms

  // Action: fetches all finance platforms
  // Returns: gecko::web::response
  // Refer: https://www.coingecko.com/api/documentations/v3
  // Example(s):
  //    listFinancePlatforms()
  // Notes: none
  gecko::web::response listFinancePlatforms(
    OPTIONAL unsigned short per_page = 100,
    OPTIONAL unsigned short page = 1
  );

finance/listFinanceProducts

  // Action: fetches all finance products
  // Returns: gecko::web::response
  // Refer: https://www.coingecko.com/api/documentations/v3
  // Example(s):
  //    listFinanceProducts()
  // Notes: none
  gecko::web::response listFinanceProducts(
    OPTIONAL const char* start_at = NULL,
    OPTIONAL const char* end_at = NULL,
    OPTIONAL unsigned short per_page = 100,
    OPTIONAL unsigned short page = 1
  );