derivatives

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

---

Class

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

Declarations

Below you can find documentation for 'derivatives' functions.

derivatives/listDerivativeTickers

  // Action: fetches all derivative tickers
  // Returns: gecko::web::response
  // Refer: https://www.coingecko.com/api/documentations/v3
  // Example(s):
  //    listDerivativeTickers()
  //    listDerivativeTickers("all")
  // Notes: none
  gecko::web::response listDerivativeTickers(
    OPTIONAL std::string include_tickers = "unexpired"
  );

derivatives/getDerivativeMarketExchanges

  // Action: fetches all derivative market exchanges
  // Returns: gecko::web::response
  // Refer: https://www.coingecko.com/api/documentations/v3
  // Example(s):
  //    getDerivativeMarketExchanges()
  //    getDerivativeMarketExchanges("trade_volume_24h_btc_asc")
  //    getDerivativeMarketExchanges("trade_volume_24h_btc_asc", 20, 1)
  // Notes: none
  gecko::web::response getDerivativeMarketExchanges(
    OPTIONAL std::string order = "name_desc",
    OPTIONAL unsigned short per_page = 100,
    OPTIONAL unsigned short page = 1
  );

derivatives/getDerivativeExchangesData

  // Action: fetches derivative exchange data
  // Returns: gecko::web::response
  // Refer: https://www.coingecko.com/api/documentations/v3
  // Example(s):
  //    getDerivativeExchangeData("bitmex")
  //    getDerivativeExchangeData("bitmex", "all")
  // Notes: none
  gecko::web::response getDerivativeExchangesData(
    REQUIRED std::string id,
    OPTIONAL std::string include_tickers = "unexpired"
  );

derivatives/getDerivativeExchangesNameAndID

  // Action: fetches all derivative exchanges name and identifier
  // Returns: gecko::web::response
  // Refer: https://www.coingecko.com/api/documentations/v3
  // Example(s):
  //    getDerivativeExchangesNameAndID()
  // Notes: none
  gecko::web::response getDerivativeExchangesNameAndID();