1.0.0 • Published 3 years ago

recreationms_coingecko_api v1.0.0

Weekly downloads
-
License
Unlicense
Repository
-
Last release
3 years ago

recreationms_coingecko_api

RecreationmsCoingeckoApi - JavaScript client for recreationms_coingecko_api this is an api to test the skill of the RecreationMS programming department This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install recreationms_coingecko_api --save
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your recreationms_coingecko_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('recreationms_coingecko_api') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/recreationms_coingecko_api then install it via:

    npm install YOUR_USERNAME/recreationms_coingecko_api --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var RecreationmsCoingeckoApi = require('recreationms_coingecko_api');

var api = new RecreationmsCoingeckoApi.CoinsApi()

var id = "id_example"; // {String} 

var opts = { 
  '_date': "_date_example", // {String} date of data of price that was recorded in format dd-mm-yyyy. e.g. 04-12-2020
  'localization': "localization_example" // {String} there are only two options, true/false, choose false if you don't want localized languages
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.coinsIdHistoryGet(id, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://api.coingecko.com/api/v3

ClassMethodHTTP requestDescription
RecreationmsCoingeckoApi.CoinsApicoinsIdHistoryGetGET /coins/{id}/historyreturn data of coin by id
RecreationmsCoingeckoApi.CoinsApicoinsListGetGET /coins/listreturn coin data
RecreationmsCoingeckoApi.CoinsApisimpleSupportedVsCurrenciesGetGET /simple/supported_vs_currenciesget supported vs currencies
RecreationmsCoingeckoApi.PingApipingGetGET /pingcheck server

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.