Skip to content

houseofapis/currencyapi-php

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
src
 
 
 
 
 
 
 
 
 
 
 
 

CurrencyApi PHP wrapper

Latest Stable Version License Build Status Coverage Status

CurrencyApi.net provides live currency rates via a REST API. A live currency feed for over 152 currencies, including physical (USD, GBP, EUR + more) and cryptos (Bitcoin, Litecoin, Ethereum + more). A JSON and XML currency api updated every 60 seconds.

Features:

  • Live exchange rates (updated every 60 seconds).
  • 152 currencies world currencies.
  • Popular cryptocurrencies included; Bitcoin, Litecoin etc.
  • Convert currencies on the fly with the convert endpoint.
  • Historical currency rates back to year 2000.
  • Easy to follow documentation

Signup for a free or paid account here.

This package

PHP wrapper for CurrencyApi.net endpoints.

Prerequisites

  • Minimum PHP 7.1+ (tested and working on PHP 7.4)
  • Free or Paid account with CurrencyApi.net
  • Composer or clone this repo

Test Coverage

  • 100% coverage

Installation

Using composer:

composer require houseofapis/currencyapi

then include the package with:

use HouseOfApis\CurrencyApi\CurrencyApi;

Without composer:

require_once('/path/to/currencyapi/src/CurrencyApi.php');
$currencyApi = new \CurrencyApi\CurrencyApi('API_KEY');

Usage

Live rates:

$result = $currencyApi->rates();

Example with all available methods:

$result = $currencyApi
    ->setBase('USD')
    ->setOutput('JSON')
    ->setLimit('BTC,EUR,GBP')
    ->rates();

Available methods for rates endpoint

Methods Description
setBase() The base currency you wish you receive the currency conversions for. This will output all currency conversions for that currency. Default: USD.
setOutput() Response output in either JSON or XML. Default: JSON.
setLimit() Limit which currency conversions are returned using the limit param. Comma separated (no space) values. Optional

List of available currencies:

$result = $currencyApi->currencies();

Example with all available methods:

$result = $currencyApi
    ->setOutput('XML')
    ->currencies();

Available methods for currencies endpoint

Methods Description
setOutput() Response output in either JSON or XML. Default: JSON.

Convert:

$result = $currencyApi
    ->setAmount(100)
    ->setFrom('BTC')
    ->setTo('GBP')
    ->convert();

Available methods for convert endpoint

Methods Description
setAmount() The value of the currency you want to convert from. This should be a number and can contain a decimal place. Required.
setFrom() The currency you want to convert. This will be a three letter ISO 4217 currency code from one of the currencies we have rates for. Required.
setTo() The currency you want to convert the amount 'to'. Again this will be a three letter currency code from the ones we offer. Required.
setOutput() Response output in either JSON or XML. Default: JSON.

Historical:

$result = $currencyApi->setDate('2019-01-01')->historical();

Example with all available methods:

$result = $currencyApi
    ->setDate('2019-01-01')
    ->setBase('GBP')
    ->setLimit('USD')
    ->setOutput('JSON')
    ->historical();

Available methods for historical endpoint

Methods Description
setDate() The historical date you wish to receive the currency conversions for. This should be formatted as YYYY-MM-DD. Required.
setBase() The base currency you wish you receive the currency conversions for. This will output all currency conversions for that currency. Default: USD.
setOutput() Response output in either JSON or XML. Default: JSON.
setLimit() Limit which currency conversions are returned using the limit param. Comma separated (no space) values. Optional

Timeframe:

$result = $currencyApi->setStartDate('2019-01-01')->setEndDate('2019-01-05')->historical();

Example with all available methods:

$result = $currencyApi
    ->setStartDate('2019-01-01')
    ->setEndDate('2019-01-05')
    ->setBase('GBP')
    ->setLimit('USD,BTC')
    ->setOutput('XML')
    ->timeframe();

Available methods for timeframe endpoint

Methods Description
setStartDate() The historical date you wish to receive the currency conversions from. This should be formatted as YYYY-MM-DD. Required.
setEndDate() The historical date you wish to receive the currency conversions until. This should be formatted as YYYY-MM-DD. Required.
setBase() The base currency you wish you receive the currency conversions for. This will output all currency conversions for that currency. Default: USD.
setOutput() Response output in either JSON or XML. Default: JSON.
setLimit() Limit which currency conversions are returned using the limit param. Comma separated (no space) values. Optional

About

Composer package for CurrencyApi.net

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages