Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/exchangeratesapi/exchangeratesapi
Exchange Rates API
https://github.com/exchangeratesapi/exchangeratesapi
Last synced: 7 days ago
JSON representation
Exchange Rates API
- Host: GitHub
- URL: https://github.com/exchangeratesapi/exchangeratesapi
- Owner: exchangeratesapi
- License: mit
- Created: 2018-03-26T21:52:31.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T02:53:47.000Z (about 2 years ago)
- Last Synced: 2024-11-30T10:04:39.396Z (14 days ago)
- Language: Python
- Homepage: https://exchangeratesapi.io
- Size: 126 KB
- Stars: 1,929
- Watchers: 40
- Forks: 315
- Open Issues: 65
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-sanic - exchangeratesapi.io - Exchange rates with currency conversion (Resources / Built with Sanic)
README
# Exchange Rates API
Exchange rates API is a free service for current and historical foreign exchange rates [published by the European Central Bank](https://www.ecb.europa.eu/stats/policy_and_exchange_rates/euro_reference_exchange_rates/html/index.en.html).
[](https://heroku.com/deploy?template=https://github.com/madisvain/exchangeratesapi)
## Usage
#### Lates & specific date rates
Get the latest foreign exchange rates.
```http
GET /latest
```
Get historical rates for any day since 1999.
```http
GET /2018-03-26
```
Rates are quoted against the Euro by default. Quote against a different currency by setting the base parameter in your request.
```http
GET /latest?base=USD
```
Request specific exchange rates by setting the symbols parameter.
```http
GET /latest?symbols=USD,GBP
```
#### Rates history
Get historical rates for a time period.
```http
GET /history?start_at=2018-01-01&end_at=2018-09-01
```
Limit results to specific exchange rates to save bandwidth with the symbols parameter.
```http
GET /history?start_at=2018-01-01&end_at=2018-09-01&symbols=ILS,JPY
```
Quote the historical rates against a different currency.
```http
GET /history?start_at=2018-01-01&end_at=2018-09-01&base=USD
```
#### Client side usage
The primary use case is client side. For instance, with [money.js](https://openexchangerates.github.io/money.js/) in the browser
```js
let demo = () => {
let rate = fx(1).from("GBP").to("USD")
alert("£1 = $" + rate.toFixed(4))
}
fetch('https://api.exchangeratesapi.io/latest')
.then((resp) => resp.json())
.then((data) => fx.rates = data.rates)
.then(demo)
```
## API wrappers
* PHP - [https://github.com/benmajor/ExchangeRatesAPI](https://github.com/benmajor/ExchangeRatesAPI)
* Laravel (PHP) - [https://github.com/ash-jc-allen/laravel-exchange-rates](https://github.com/ash-jc-allen/laravel-exchange-rates)
## Stack
Exchange rates API is built upon Sanic to achieve high throughput. The current setup can asyncronously handle thousands of requests per second.
#### Libraries used
* [Sanic](https://github.com/channelcat/sanic)
* [GINO](https://github.com/fantix/gino)
* [asyncpg](https://github.com/MagicStack/asyncpg)
* [requests](https://github.com/requests/requests)
* [APScheduler](https://github.com/agronholm/apscheduler)
* [uvloop](https://github.com/MagicStack/uvloop)
* [ultraJSON](https://github.com/esnme/ultrajson)
## Deployment
#### Virtualenv
```shell
pipenv shell
```
#### Install packages
```shell
pipenv install
```
#### Load in initial data & Scheduler
The scheduler will keep your database up to date hourly with information from European Central bank. It will download the last 90 days worth of data every hour.
_The reference rates are usually updated around 16:00 CET on every working day, except on TARGET closing days. They are based on a regular daily concertation procedure between central banks across Europe, which normally takes place at 14:15 CET._
On initialization it will check the database. If it's empty all the historic rates will be downloaded and records created in the database.
## Development
```shell
gunicorn exchangerates.app:app --worker-class sanic.worker.GunicornWorker --reload
```
## Contributing
Thanks for your interest in the project! All pull requests are welcome from developers of all skill levels. To get started, simply fork the master branch on GitHub to your personal account and then clone the fork into your development environment.
Madis Väin (madisvain on Github, Twitter) is the original creator of the Exchange Rates API framework.
## License
MIT