# exchangeratesapi-client

> Exchange rates API is a free service for current and historical foreign exchange rates published by the European Central Bank

Latest version **1.0.2** (published 2020-07-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install exchangeratesapi-client
pnpm add exchangeratesapi-client
yarn add exchangeratesapi-client
bun add exchangeratesapi-client
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2020-07-20 |
| First published | 2020-02-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 50.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | pallxk |

## Links

- npm: https://www.npmjs.com/package/exchangeratesapi-client
- Repository: https://github.com/pallxk/exchangeratesapi
- Homepage: https://github.com/pallxk/exchangeratesapi#readme
- Issues: https://github.com/pallxk/exchangeratesapi/issues
- npm.io page: https://npm.io/package/exchangeratesapi-client

## Dependencies (2)

- [@babel/cli](https://npm.io/package/@babel/cli.md) ^7.0.0
- [superagent](https://npm.io/package/superagent.md) 3.7.0

## Recent versions

- 1.0.2 (latest) — 2020-07-20
- 1.0.1 — 2020-04-07
- 1.0.0 — 2020-02-18

## 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](https://openapi-generator.tech) 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/](https://exchangeratesapi.io/)

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
npm install exchangeratesapi --save
```

Finally, you need to build the module:

```shell
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:

```shell
npm install
```

Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:

```shell
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:

```shell
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
```

Finally, you need to build the module:

```shell
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:

```shell
    npm install YOUR_USERNAME/exchangeratesapi --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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):

```shell
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:

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

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
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**](docs/DefaultApi.md#historical) | **GET** /{date} | Get historical rates for any day since 1999.
*Exchangeratesapi.DefaultApi* | [**history**](docs/DefaultApi.md#history) | **GET** /history | Get historical rates for a time period.
*Exchangeratesapi.DefaultApi* | [**latest**](docs/DefaultApi.md#latest) | **GET** /latest | Get the latest foreign exchange reference rates.


## Documentation for Models

 - [Exchangeratesapi.Currency](docs/Currency.md)
 - [Exchangeratesapi.DailyRates](docs/DailyRates.md)
 - [Exchangeratesapi.Error](docs/Error.md)
 - [Exchangeratesapi.HistoryRates](docs/HistoryRates.md)


## Documentation for Authorization

All endpoints do not require authorization.

---
_Source: https://npm.io/package/exchangeratesapi-client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._