https://github.com/4513/currency-rates

https://github.com/4513/currency-rates

Last synced: 21 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/4513/currency-rates
• Owner: 4513
• License: mit
• Created: 2023-06-11T01:05:04.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-03T11:12:53.000Z (3 months ago)
• Last Synced: 2024-10-11T02:27:20.172Z (about 1 month ago)
• Language: PHP
• Size: 79.1 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Currency Rates

[![codecov](https://codecov.io/gh/4513/currency-rates/branch/main/graph/badge.svg?token=kskaQT5wHR)](https://codecov.io/gh/4513/currency-rates)

Online currency rate provider.  

The library comes with `\MiBo\Currency\Rates\ExchangerInterface` interface, which provides the following methods:

* `getDefaultCurrency()` - returns default currency code of the Exchanger (e.g. USD)

* `getRateFor()` - returns rate for the given currency code. Comparing the default currency of the Exchanger

  if no 'fromCurrency' parameter is provided.

* `getExchangeRates()` - list of all exchange rates of the Exchanger. The result is an array where a key is a currency

  code and a value of 'rate' sub key is a rate for the given currency code. Comparing the default currency of the Exchanger.

  If 'amount' sub key is present, the rate is calculated for the given amount.

* `getAvailableCurrencies()` - returns list of available currencies of the Exchanger. The result is an array of

  currency codes.

The library comes with a few implementations of the Exchangers:

* ECB - European Central Bank (since 1.0)

* CNB - Czech National Bank (since 1.0)

* BoE - Bank of England (since 1.1)

* CF - Currency Freaks (since 1.2)

* OXR - Open Exchange Rates (since 1.2) - Experimental

* *more to come...*

All implementations load the rates from publicly available resources. All resources are located on official

websites of the banks, thus the rates are trustworthy and up to date.

---

### Installation

```bash

composer require mibo/currency-rates

```

### Usage

```php

$price = 100; // EUR

$exchanger = new \MiBo\Currency\Rates\Exchangers\ECB();

$newPrice = $exchanger->getRateFor('USD') * $price; // USD

```

---

### Future of the library

The library will contain more implementations of the Exchangers. The goal is to provide a simple way to get

currency rates from various sources. The main focus is on the banks that are globally recognized.