# @everapi/freecurrencyapi-js

> A JavaScript wrapper for the freecurrencyapi.com's API

Latest version **1.0.1** (published 2023-07-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install @everapi/freecurrencyapi-js
pnpm add @everapi/freecurrencyapi-js
yarn add @everapi/freecurrencyapi-js
bun add @everapi/freecurrencyapi-js
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2023-07-26 |
| First published | 2023-05-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 12 |
| Author | Dominik Kukacka |
| Maintainers | everapi-user |
| Keywords | freecurrencyapi, api, fx api, exchange rates API, rates API, currency API, exchange rates, free currency API |

## Links

- npm: https://www.npmjs.com/package/@everapi/freecurrencyapi-js
- Repository: https://github.com/everapihq/freecurrencyapi-js
- Homepage: https://github.com/everapihq/freecurrencyapi-js#readme
- Issues: https://github.com/everapihq/freecurrencyapi-js/issues
- npm.io page: https://npm.io/package/@everapi/freecurrencyapi-js

## Recent versions

- 1.0.1 (latest) — 2023-07-26
- 1.0.0 — 2023-05-31

## README

<p align="center">
<img src="https://app.freecurrencyapi.com/img/logo/freecurrencyapi.png" width="300"/>
</p>

# freecurrencyapi-js: JS Currency Converter
Freecurrencyapi.com is a free currency API that provides realtime & historic data.
This package is a JavaScript wrapper for [freecurrencyapi.com](https://freecurrencyapi.com) that aims to make the usage of the API as easy as possible in your project.

## Installation

### npm
```shell
npm install --save @everapi/freecurrencyapi-js
```
### yarn
```shell
yarn add @everapi/freecurrencyapi-js
```

## Import

```js
import Freecurrencyapi from '@everapi/freecurrencyapi-js';
```

or use it directly in a Browser:

```html
<script src="path/to/freecurrencyapi-js/index.js"></script>
```

## Usage

Initialize the API with your API Key (get one for free at [freecurrencyapi.com](https://freecurrencyapi.com)):

```js
const freecurrencyapi = new Freecurrencyapi('YOUR-API-KEY');
```

Afterwards you can make calls to the API like this:

```js
freecurrencyapi.latest({
        base_currency: 'USD',
        currencies: 'EUR'
    }).then(response => {
        console.log(response);
    });
```

Endpoints accessible with a free account:
- `status`
- `currencies`
- `latest`
- `historical`

Find out more about our endpoints, parameters and response data structure in the [docs](https://freecurrencyapi.com/docs)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

[docs]: https://freecurrencyapi.com/docs
[freecurrencyapi.com]: https://freecurrencyapi.com

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