ashallendesign / exchange-rates
A package for interacting with the exchangerate.host API
Fund package maintenance!
ash-jc-allen
Requires
- php: ^8.0
- ext-bcmath: *
- ext-json: *
- guzzlehttp/guzzle: ^7.0
- nesbot/carbon: ^2.0
Requires (Dev)
- mockery/mockery: ^1.0
- phpunit/phpunit: ^9.0
- symfony/var-dumper: ^5.3
This package is auto-updated.
Last update: 2024-03-18 21:10:48 UTC
README
Table of Contents
- Overview
- Installation
- Usage
- Testing
- Security
- Contribution
- Credits
- Changelog
- Upgrading
- License
Overview
Exchange Rates is a simple PHP package used for interacting with the exchangerate.host API. You can use it to get the latest or historical exchange rates and convert monetary values between different currencies and cryptocurrencies.
Installation
You can install the package via Composer:
composer require ashallendesign/exchange-rates
The package has been developed and tested to work with the following minimum requirements:
- PHP 8.0
Usage
Methods
Available Currencies
To get the available currencies that are supported by the package, you can use the ->currencies()
method like so:
$exchangeRates = new \AshAllenDesign\ExchangeRates\Classes\ExchangeRate(); $exchangeRates->currencies();
Exchange Rate
Getting the Rate Between Two Currencies
To get the exchange for one currency to another, you can use the ->exchangeRate()
method.
The example below shows how to get the exchange rate from 'GBP' to 'EUR' for today:
$exchangeRates = new \AshAllenDesign\ExchangeRates\Classes\ExchangeRate(); $result = $exchangeRates->exchangeRate('GBP', 'EUR'); // $result: '1.10086'
Note: If a Carbon date is passed as the third parameter, the exchange rate for that day will be returned (if valid). If no date is passed, today's exchange rate will be used.
Getting the Rate Between More Than Two Currencies
It is possible to get the exchange rates for multiple currencies in one call. This can be particularly useful if you are needing to get many exchange rates at once and do not want to make multiple API calls.
To do this, you can use ->exchangeRate()
method and pass an array of currency code strings as the second parameter. This will return an array containing the exchange rates as strings.
The example below shows how to get the exchange rates from 'GBP' to 'EUR' and 'USD' for today.
$exchangeRates = new \AshAllenDesign\ExchangeRates\Classes\ExchangeRate(); $result = $exchangeRates->exchangeRate('GBP', ['EUR', 'USD']); // $result: [ // 'EUR' => '1.10086', // 'USD' => '1.25622' // ];
Exchange Rates Between Date Range
Getting the Rates Between Two Currencies
To get the exchange rates between two currencies between a given date range, you can use the ->exchangeRateBetweenDateRange()
method.
The example below shows how to get the exchange rates from 'GBP' to 'EUR' for the past 3 days:
$exchangeRates = new \AshAllenDesign\ExchangeRates\Classes\ExchangeRate(); $result = $exchangeRates->exchangeRateBetweenDateRange( 'GBP', 'EUR', Carbon::now()->subWeek(), Carbon::now() ); // $result: [ // '2020-07-07' => [ // 'EUR' => '1.1092623405', // ], // '2020-07-08' => [ // 'EUR' => '1.1120625424', // ], // '2020-07-09' => [ // 'EUR' => '1.1153867604', // ], // ];
Getting the Rates Between More Than Two Currencies
To get the exchange rates for multiple currencies in one call, you can pass an array of currency codes strings as the second parameter to the ->exchangeRateBetweenDateRange()
method.
The example below shows how to get the exchange rates from 'GBP' to 'EUR' and 'USD' for the past 3 days:
$exchangeRates = new \AshAllenDesign\ExchangeRates\Classes\ExchangeRate(); $result = $exchangeRates->exchangeRateBetweenDateRange( 'GBP', ['EUR', 'USD'], Carbon::now()->subDays(3), Carbon::now(), ); // $result: [ // '2020-07-07' => [ // 'EUR' => '1.1092623405', // 'USD' => '1.2523571825', // ], // '2020-07-08' => [ // 'EUR' => '1.1120625424', // 'USD' => '1.2550737853', // ], // '2020-07-09' => [ // 'EUR' => '1.1153867604', // 'USD' => '1.2650716636', // ], // ];
Convert Currencies
When passing in the monetary value (first parameter) that is to be converted, it's important that you pass it in the lowest denomination of that currency. For example, £1 GBP would be passed in as 100 (as £1 = 100 pence).
Converting Between Two Currencies
Similar to how you can get the exchange rate from one currency to another, you can also convert a monetary value from one currency to another. To do this you can use the ->convert()
method.
The example below shows how to convert £1 'GBP' to 'EUR' at today's exchange rate:
$exchangeRates = new \AshAllenDesign\ExchangeRates\Classes\ExchangeRate(); $result = $exchangeRates->convert(100, 'GBP', 'EUR'); // $result: '110.15884906'
Note: If a Carbon date object is passed as the third parameter, the exchange rate for that day will be used (if valid). If no date is passed, today's exchange rate will be used.
Converting Between More Than Two Currencies
You can also use the ->convert()
method to convert a monetary value from one currency to multiple currencies. To do this, you can pass an array of currency codes strings as the third parameter.
The example below show how to convert £1 'GBP' to 'EUR' and 'USD' at today's exchange rate:
$exchangeRates = new \AshAllenDesign\ExchangeRates\Classes\ExchangeRate(); $result = $exchangeRates->convert( 100, 'GBP', ['EUR', 'USD'], Carbon::now(), ); // $result: [ // 'EUR' => '110.15884906', // 'USD' => '125.30569081' // ];
Convert Currencies Between Date Range
When passing in the monetary value (first parameter) that is to be converted, it's important that you pass it in the lowest denomination of that currency. For example, £1 GBP would be passed in as 100 (as £1 = 100 pence).
Converting Between Two Currencies in a Date Range
Similar to getting the exchange rates between a date range, you can also get convert monetary values from one currency to another using the exchange rates. To do this you can use the ->convertBetweenDateRange()
method.
The example below shows how to convert £1 'GBP' to 'EUR' using the exchange rates for the past 3 days:
$exchangeRates = new \AshAllenDesign\ExchangeRates\Classes\ExchangeRate(); $exchangeRates->convertBetweenDateRange( 100, 'GBP', 'EUR', Carbon::now()->subDays(3), Carbon::now() ); // $result: [ // '2020-07-07' => [ // 'EUR' => '110.92623405', // ], // '2020-07-08' => [ // 'EUR' => '111.20625424', // ], // '2020-07-09' => [ // 'EUR' => '111.53867604', // ], // ];
Converting Between More Than Two Currencies in a Date Range
You can also use the ->convertBetweenDateRange()
method to convert a monetary value from one currency to multiple currencies using the exchange rates between a date range. To do this, you can pass an array of currency codes strings as the third parameter.
The example below show how to convert £1 'GBP' to 'EUR' and 'USD' at the past three days' exchange rates:
$exchangeRates = new ExchangeRate(); $result = $exchangeRates->exchangeRateBetweenDateRange('GBP', ['EUR', 'USD'], Carbon::now()->subDays(3), Carbon::now()); // $result: [ // '2020-07-07' => [ // 'EUR' => '110.92623405', // 'USD' => '125.23571825', // ], // '2020-07-08' => [ // 'EUR' => '111.20625424', // 'USD' => '125.50737853', // ], // '2020-07-09' => [ // 'EUR' => '111.53867604', // 'USD' => '126.50716636', // ], // ];
Testing
To run the tests for the package, you can use the following command:
composer test
Security
If you find any security related issues, please contact me directly at mail@ashallendesign.co.uk to report it.
Contribution
If you wish to make any changes or improvements to the package, feel free to make a pull request.
To contribute to this library, please use the following guidelines before submitting your pull request:
- Write tests for any new functions that are added. If you are updating existing code, make sure that the existing tests pass and write more if needed.
- Follow PSR-12 coding standards.
- Make all pull requests to the
master
branch.
Credits
- Ash Allen
- Jess Pickup (Logo)
- All Contributors
Changelog
Check the CHANGELOG to get more information about the latest changes.
Upgrading
Check the UPGRADE guide to get more information on how to update this library to newer versions.
License
The MIT License (MIT). Please see License File for more information.