exchangeratesapi-client
v1.0.2
Published
Exchange rates API is a free service for current and historical foreign exchange rates published by the European Central Bank
Downloads
10
Readme
exchangeratesapi
Exchangeratesapi - JavaScript client for exchangeratesapi Exchange rates API is a free service for current and historical foreign exchange rates published by the European Central Bank This SDK is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Package version: 1.0.2
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://exchangeratesapi.io/
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 exchangeratesapi --save
Finally, you need to build the module:
npm run build
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
To use the link you just defined in your project, switch to the directory you want to use your exchangeratesapi from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
Finally, you need to build the module:
npm run build
git
If the library is hosted at a git repository, e.g.https://github.com/YOUR_USERNAME/exchangeratesapi then install it via:
npm install YOUR_USERNAME/exchangeratesapi --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):
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 Exchangeratesapi = require('exchangeratesapi');
var api = new Exchangeratesapi.DefaultApi()
var _date = new Date("2013-10-20"); // {Date} Date in format YYYY-MM-DD
var opts = {
'base': new Exchangeratesapi.Currency(), // {Currency} Rates are quoted against the Euro by default. Quote against a different currency by setting the base parameter in your request.
'symbols': USD,GBP // {String} Request specific exchange rates by setting the symbols parameter.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.historical(_date, opts, callback);
Documentation for API Endpoints
All URIs are relative to https://api.exchangeratesapi.io
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- Exchangeratesapi.DefaultApi | historical | GET /{date} | Get historical rates for any day since 1999. Exchangeratesapi.DefaultApi | history | GET /history | Get historical rates for a time period. Exchangeratesapi.DefaultApi | latest | GET /latest | Get the latest foreign exchange reference rates.
Documentation for Models
- Exchangeratesapi.Currency
- Exchangeratesapi.DailyRates
- Exchangeratesapi.Error
- Exchangeratesapi.HistoryRates
Documentation for Authorization
All endpoints do not require authorization.