README

CurrencyApi.net provides live currency rates via a REST API. A live currency feed for over 166 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).
• 166+ world currencies.
• Popular cryptocurrencies included; Bitcoin, Litecoin etc.
• Convert currencies on the fly with the convert endpoint.
• Historical currency rates back to year 2000.
• OHLC (candlestick) data for technical analysis.
• Easy to follow documentation

Signup for a free or paid account here.

Note: API v1 is deprecated and will be retired on 31st July 2026, at which point all v1 traffic will be redirected to v2. This SDK (v3.0.0+) targets API v2. If you are on an older version of this SDK, please upgrade.

This package is a:

PHP wrapper for CurrencyApi.net endpoints.

Developer Guide

For an easy to following developer guide, check out our PHP Developer Guide.

Alternatively keep reading below.

Prerequisites

• Minimum PHP 8.1+
• Working on PHP 8.5
• 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:

Returns the latest exchange rates for all supported currencies.

$result = $currencyApi->rates();

Example with all available methods:

$result = $currencyApi
    ->setBase('USD')
    ->setOutput('JSON')
    ->rates();

Available methods for rates endpoint

List of available currencies:

Returns a list of all currencies supported by the API.

$result = $currencyApi->currencies();

Example with all available methods:

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

Available methods for currencies endpoint

Convert:

Converts an amount from one currency to another using the latest rates.

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

Available methods for convert endpoint

Historical:

Returns exchange rates for all currencies on a specific date.

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

Example with all available methods:

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

Available methods for historical endpoint

Timeframe:

Returns exchange rates for all currencies across a date range, with one entry per day.

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

Example with all available methods:

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

Available methods for timeframe endpoint

OHLC (Open, High, Low, Close):

Returns candlestick data for a currency pair on a given date, useful for charting and technical analysis.

$result = $currencyApi
    ->setQuote('EUR')
    ->setDate('2023-12-25')
    ->ohlc();

Example with all available methods:

$result = $currencyApi
    ->setQuote('EUR')
    ->setDate('2023-12-25')
    ->setBase('GBP')
    ->setInterval('1h')
    ->ohlc();

Available methods for OHLC endpoint

Example response:

{
    "valid": true,
    "base": "USD",
    "quote": "EUR",
    "date": "2023-12-25",
    "interval": "1d",
    "ohlc": [
        {
            "start": "2023-12-25T00:00:00Z",
            "open": 0.9123,
            "high": 0.9187,
            "low": 0.9098,
            "close": 0.9154
        }
    ]
}