Enriched Requests

Documentation for the Enriched ExchangeRate-API endpoint.

Overview

Our Enriched API endpoint offers the most comprehensive data on each currency you're interested in converting to. It's only available to users on our Business or Volume plans.

You'll need to choose your base currency code and the target currency you'd like to get enriched data for. The API's JSON response will include the country name, country code & flag image URL for the target currency, as well as the currency name and its display symbol.


Usage Guide

To use our Enriched endpoint make the three substitutions explained below and then send a GET request.

• Substitute `YOUR-API-KEY` with the API key displayed in your dashboard.

• Substitute `GBP` with the code you want to use as a base currency.

• Substitute `JPY` with the code you want to use as a target currency.

We use ISO 4217 Three Letter Currency Codes - e.g. USD for US Dollars, EUR for Euro etc. Here are the codes we support.

GET https://v6.exchangerate-api.com/v6/YOUR-API-KEY/enriched/GBP/JPY

This will return the exchange rate from your base code to the target code, as well as extra data for the target currency:

{
	"result": "success",
	"documentation": "https://www.exchangerate-api.com/docs",
	"terms_of_use": "https://www.exchangerate-api.com/terms",
	"time_last_update_unix": 1585267200,
	"time_last_update_utc": "Fri, 27 Mar 2020 00:00:00 +0000",
	"time_next_update_unix": 1585270800,
	"time_next_update_utc": "Sat, 28 Mar 2020 01:00:00 +0000",
	"base_code": "GBP",
	"target_code": "JPY",
	"conversion_rate": 142.0543,
	"target_data": {
		"locale": "Japan",
		"two_letter_code": "JP",
		"currency_name": "Japanese Yen",
		"currency_name_short": "Yen",
		"display_symbol": "a5",
		"flag_url": "https://www.exchangerate-api.com/img/docs/JP.gif"
	}
}

NOTE: How to Use Currency Display Symbols

We supply a comma delimited list of unicode hex references for use in your HTML. You will need to separate and then wrap these hex codes with &#x and ; as follows:

"43b,432"

would become

лв

yielding лв.

Note that sometimes just a single hex reference will be returned, i.e. without any commas. For instance just "24", which when wrapped as

$

will display the $ symbol.


Error Responses

{
	"result": "error",
	"error-type": "unknown-code"
}

Where "error-type" can be any of the following:

  • "unsupported-code" if we don't support the supplied currency code (see supported currencies...).
  • "malformed-request" when some part of your request doesn't follow the structure shown above.
  • "invalid-key" when your API key is not valid.
  • "quota-reached" when your account has reached the the number of requests allowed by your plan.
  • "not-available-on-plan" if your plan level doesn't support this type of request.

If you have any questions about this documentation please contact us!