infinitypaul/laravel-naira-exchange-rates

Foreign exchange rates API Against The Naira

0.0.7 2020-03-16 11:49 UTC

This package is auto-updated.

Last update: 2022-05-16 16:54:28 UTC


README

Latest Version on Packagist Build Status Quality Score Total Downloads

Free Laravel Naira Exchange Rates API, which provides past or recent exchange rate lookups. It features a number of useful functions and can be installed easily using Composer..

Installation

You can install the package via composer:

composer require infinitypaul/laravel-naira-exchange-rates

Usage

The Laravel Naira Currency Exchange API does require API keys in order to access and interrogate its API, Register and get your token on http://nairaexchangerate.herokuapp.com/.

Add NAIRA_ACCESS_TOKEN='Your Token' in your .env file with your token

Basic usage:

Fetch the latest exchange rates

use Infinitypaul\LaravelNairaExchangeRates\NairaExchangeRates;

$rates  = NairaExchangeRates::setType('cbn')->fetch();

Historical Data:
Get historical rates for any day since 1999:

use Infinitypaul\LaravelNairaExchangeRates\NairaExchangeRates;
$rates  = NairaExchangeRates::setType('cbn')->addDateFrom('2019-11-26')->fetch();

Fetch Specific Rate:
If you do not want all current rates, it's possible to specify only the currencies you want

use Infinitypaul\LaravelNairaExchangeRates\NairaExchangeRates;
$rates  = NairaExchangeRates::setType('cbn')->setBaseCurrency('usd')->fetch();

4. API Reference:

The following API reference lists the publicly-available methods for the

NairaExchangeRatesAPI Reference:

addDateFrom( string $from ):
Set the date from which to retrieve historic rates. $from should be a string containing an ISO 8601 date.

setType( string $to ):
Set The Exchange Rate Type You Want To Retrieve, we have the following types

  1. cbn Central Bank Of Nigeria Rate
  2. bdc Burueu The Change Rate
  3. bank Bank Rate
  4. moneygram MoneyGram Rate
  5. westernunion Western Union Rate

addDateTo( string $type ):
Set the end date for the retrieval of historic rates. $to should be a string containing an ISO 8601 date.

setBaseCurrency( string $code ):
Set the base currency you want to retrieve. $code should be passed an ISO 4217 code (e.g. EUR).
$code must be one of the supported currencies.

fetch():
Send off the request to the API and return either a Json,

5. Supported Currencies:

The library supports the following currencies USD, GBP, EUR, JPY, XAF, CNY, QAR, ZAR, SEK:

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Bug & Features

If you have spotted any bugs, or would like to request additional features from the library, please file an issue via the Issue Tracker on the project's Github page: https://github.com/infinitypaul/naira-exchange-rates/issues.

How can I thank you?

Why not star the github repo? I'd love the attention! Why not share the link for this repository on Twitter or HackerNews? Spread the word!

Don't forget to follow me on twitter!

Thanks!
Edward Paul.

License

The MIT License (MIT). Please see License File for more information.