ExchangeRate-API

https://www.exchangerate-api.com/docs/
Admin
ExchangeRate-API provides a reliable currency conversion API with various endpoints for fetching...
Tokens:21,151
Snippets:65
Trust Score:9.6
Update:1 year ago
Show doc for...
Tokens:
Raw
### Pair Conversion API Request (With Amount)

Source: https://www.exchangerate-api.com/docs/pair-conversion-requests

This example shows how to make a GET request to the Pair Conversion endpoint, including an optional amount for conversion. It requires your API key, base currency code, target currency code, and the amount to convert. The response includes the exchange rate and the converted amount.

```http
GET https://v6.exchangerate-api.com/v6/**_YOUR-API-KEY_**/pair/**_EUR_**/**_GBP_**/**_AMOUNT_**
```

--------------------------------

### Objective C Currency Conversion Example

Source: https://www.exchangerate-api.com/docs/objective-c-currency-api

This Objective C code snippet demonstrates how to fetch the latest currency exchange rates from the ExchangeRate-API. It constructs a GET request URL with a placeholder for the API key, fetches the data, and parses the JSON response. Ensure you replace 'YOUR-API-KEY' with your actual API key.

```objectivec
// Setting URL
NSString *url = [NSString stringWithFormat: @"https://v6.exchangerate-api.com/v6/YOUR-API-KEY/latest/USD"];

// Fetching
NSData *data = [NSData dataWithContentsOfURL: [NSURL URLWithString:url]];
NSError *err;
NSMutableArray *json = [NSJSONSerialization JSONObjectWithData:data options:kNilOptions error:&err];

// Your JSON
NSLog(@"json: %@", json);
```

--------------------------------

### Enriched Data Request - Java

Source: https://www.exchangerate-api.com/docs/enriched-data-requests

Example of making an Enriched Data Request using Java with the Apache HttpClient library. This code demonstrates constructing the API URL, executing the GET request, and parsing the JSON response.

```Java
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
import org.json.JSONObject;

public class EnrichedDataRequest {

    public static void main(String[] args) {
        String apiKey = "YOUR-API-KEY";
        String baseCurrency = "GBP";
        String targetCurrency = "JPY";

        String url = String.format("https://v6.exchangerate-api.com/v6/%s/enriched/%s/%s", apiKey, baseCurrency, targetCurrency);

        try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
            HttpGet request = new HttpGet(url);
            try (CloseableHttpResponse response = httpClient.execute(request)) {
                String jsonResponse = EntityUtils.toString(response.getEntity());
                JSONObject data = new JSONObject(jsonResponse);

                if (data.getString("result").equals("success")) {
                    System.out.println("Conversion Rate: " + data.getDouble("conversion_rate"));
                    System.out.println("Target Currency Name: " + data.getJSONObject("target_data").getString("currency_name"));
                    System.out.println("Flag URL: " + data.getJSONObject("target_data").getString("flag_url"));
                } else {
                    System.out.println("Error: " + data.getString("error-type"));
                }
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}
```

--------------------------------

### In-URL Authentication Example

Source: https://www.exchangerate-api.com/docs/authentication

This example demonstrates how to include your API key directly in the URL for authentication. It's a straightforward method suitable for quick integration, but the API key may be exposed in logs.

```http
GET https://v6.exchangerate-api.com/v6/**_YOUR-API-KEY_**/latest/**_USD_**
```

--------------------------------

### PHP Currency Conversion Example

Source: https://www.exchangerate-api.com/docs/php-currency-api

This PHP code snippet demonstrates how to fetch the latest currency exchange rates from the Exchange Rate API. It makes a GET request, parses the JSON response, and extracts conversion rates for a given base currency.

```PHP
// Fetching JSON
$req_url = 'https://v6.exchangerate-api.com/v6/YOUR-API-KEY/latest/USD';
$response_json = file_get_contents($req_url);

// Continuing if we got a result
if(false !== $response_json) {

    // Try/catch for json_decode operation
    try {

		// Decoding
		$response = json_decode($response_json);

		// Check for success
		if('success' === $response->result) {

			// YOUR APPLICATION CODE HERE, e.g. 
			$base_price = 12; // Your price in USD
			$EUR_price = round(($base_price * $response->conversion_rates->EUR), 2);

		}

    } 
    catch(Exception $e) {
        // Handle JSON parse error...
    }

}
```

--------------------------------

### Pair Conversion Example in C#

Source: https://www.exchangerate-api.com/docs/c-sharp-currency-api

Demonstrates how to perform currency pair conversions using the Exchange Rate API in C#. Requires an API key for authentication.

```csharp
using System;
using System.Net.Http;
using System.Threading.Tasks;

public class ExchangeRateClient
{
    private readonly HttpClient _httpClient;
    private readonly string _apiKey;

    public ExchangeRateClient(string apiKey)
    {
        _httpClient = new HttpClient();
        _apiKey = apiKey;
        _httpClient.BaseAddress = new Uri("https://v6.exchangerate-api.com/v6/");
    }

    public async Task<string> GetPairConversionAsync(string fromCurrency, string toCurrency, decimal amount)
    {
        var response = await _httpClient.GetAsync($"{_apiKey}/pair/{fromCurrency}/{toCurrency}/{amount}");
        response.EnsureSuccessStatusCode(); // Throw if status code is not 2xx
        return await response.Content.ReadAsStringAsync();
    }

    // Example Usage:
    public static async Task Main(string[] args)
    {
        string apiKey = "YOUR_API_KEY"; // Replace with your actual API key
        var client = new ExchangeRateClient(apiKey);
        try
        {
            string conversionResult = await client.GetPairConversionAsync("USD", "EUR", 100);
            Console.WriteLine(conversionResult);
        }
        catch (HttpRequestException e)
        {
            Console.WriteLine($"Error: {e.Message}");
        }
    }
}
```

--------------------------------

### Standard API Response Example (JSON)

Source: https://www.exchangerate-api.com/docs/standard-requests

Illustrates the JSON structure returned by the Standard API endpoint for successful requests, showing conversion rates from a base currency to all supported currencies.

```JSON
{
	"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": 1585353700,
	"time_next_update_utc": "Sat, 28 Mar 2020 00:00:00 +0000",
	"base_code": "USD",
	"conversion_rates": {
		"USD": 1,
		"AUD": 1.4817,
		"BGN": 1.7741,
		"CAD": 1.3168,
		"CHF": 0.9774,
		"CNY": 6.9454,
		"EGP": 15.7361,
		"EUR": 0.9013,
		"GBP": 0.7679,
		"...": 7.8536,
		"...": 1.3127,
		"...": 7.4722, etc. etc.
	}
}
```

--------------------------------

### Fetch Exchange Rates using C# API

Source: https://www.exchangerate-api.com/docs/c-sharp-currency-api

This C# code snippet demonstrates how to fetch exchange rates from the ExchangeRate-API. It uses `System.Net.WebClient` to make a GET request and `Newtonsoft.Json` to deserialize the JSON response into custom C# objects. Ensure you have the Newtonsoft.Json library installed and replace 'YOUR-API-KEY' with your actual API key.

```csharp
using System;
using Newtonsoft.Json;

namespace ExchangeRate_API
    {

    class Rates
        {
        public static bool Import()
            {
            try
                {
                String URLString = "https://v6.exchangerate-api.com/v6/YOUR-API-KEY/latest/USD";
                using (var webClient = new System.Net.WebClient())
                    {
                    var json = webClient.DownloadString(URLString);
                    API_Obj Test = JsonConvert.DeserializeObject<API_Obj>(json);
                    return true;
                    }
                }
            catch (Exception)
                {
                return false;
                }
            }
        }

    public class API_Obj
        {
        public string result { get; set; }
        public string documentation { get; set; }
        public string terms_of_use { get; set; }
        public string time_last_update_unix { get; set; }
        public string time_last_update_utc { get; set; }
        public string time_next_update_unix { get; set; }
        public string time_next_update_utc { get; set; }
        public string base_code { get; set; }
        public ConversionRate conversion_rates { get; set; }
        }

    public class ConversionRate
        {
        public double AED { get; set; }
        public double ARS { get; set; }
        public double AUD { get; set; }
        public double BGN { get; set; }
        public double BRL { get; set; }
        public double BSD { get; set; }
        public double CAD { get; set; }
        public double CHF { get; set; }
        public double CLP { get; set; }
        public double CNY { get; set; }
        public double COP { get; set; }
        public double CZK { get; set; }
        public double DKK { get; set; }
        public double DOP { get; set; }
        public double EGP { get; set; }
        public double EUR { get; set; }
        public double FJD { get; set; }
        public double GBP { get; set; }
        public double GTQ { get; set; }
        public double HKD { get; set; }
        public double HRK { get; set; }
        public double HUF { get; set; }
        public double IDR { get; set; }
        public double ILS { get; set; }
        public double INR { get; set; }
        public double ISK { get; set; }
        public double JPY { get; set; }
        public double KRW { get; set; }
        public double KZT { get; set; }
        public double MXN { get; set; }
        public double MYR { get; set; }
        public double NOK { get; set; }
        public double NZD { get; set; }
        public double PAB { get; set; }
        public double PEN { get; set; }
        public double PHP { get; set; }
        public double PKR { get; set; }
        public double PLN { get; set; }
        public double PYG { get; set; }
        public double RON { get; set; }
        public double RUB { get; set; }
        public double SAR { get; set; }
        public double SEK { get; set; }
        public double SGD { get; set; }
        public double THB { get; set; }
        public double TRY { get; set; }
        public double TWD { get; set; }
        public double UAH { get; set; }
        public double USD { get; set; }
        public double UYU { get; set; }
        public double ZAR { get; set; }
        }

    }
																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																							
```

--------------------------------

### Pair Conversion API Request (No Amount)

Source: https://www.exchangerate-api.com/docs/pair-conversion-requests

This example demonstrates how to make a GET request to the Pair Conversion endpoint without specifying an amount. It requires your API key, base currency code, and target currency code. The response includes exchange rate details.

```http
GET https://v6.exchangerate-api.com/v6/**_YOUR-API-KEY_**/pair/**_EUR_**/**_GBP_**
```

--------------------------------

### Enriched Data Request - C#

Source: https://www.exchangerate-api.com/docs/enriched-data-requests

Example of making an Enriched Data Request using C#. This code uses HttpClient to make the GET request and Newtonsoft.Json to parse the JSON response.

```C#
using System;
using System.Net.Http;
using System.Threading.Tasks;
using Newtonsoft.Json;

public class EnrichedDataRequest
{
    public static async Task MakeRequest(string apiKey, string baseCurrency, string targetCurrency)
    {
        using (HttpClient client = new HttpClient())
        {
            string url = $"https://v6.exchangerate-api.com/v6/{apiKey}/enriched/{baseCurrency}/{targetCurrency}";
            HttpResponseMessage response = await client.GetAsync(url);
            response.EnsureSuccessStatusCode(); // Throw if HTTP status is not 2xx

            string responseBody = await response.Content.ReadAsStringAsync();
            dynamic data = JsonConvert.DeserializeObject(responseBody);

            if (data.result == "success")
            {
                Console.WriteLine($"Conversion Rate: {data.conversion_rate}");
                Console.WriteLine($"Target Currency Name: {data.target_data.currency_name}");
                Console.WriteLine($"Flag URL: {data.target_data.flag_url}");
            }
            else
            {
                Console.WriteLine($"Error: {data["error-type"]}");
            }
        }
    }

    public static async Task Main(string[] args)
    {
        string apiKey = "YOUR-API-KEY";
        string baseCurrency = "GBP";
        string targetCurrency = "JPY";
        await MakeRequest(apiKey, baseCurrency, targetCurrency);
    }
}

```

--------------------------------

### Example JSON Response for Exchange Rates

Source: https://www.exchangerate-api.com/docs/free

Illustrates the structure of the JSON response received when querying the Open Access API for exchange rates. It includes timestamps, base currency, and rates for various currencies.

```json
{
	"result": "success",
	"provider": "https://www.exchangerate-api.com",
	"documentation": "https://www.exchangerate-api.com/docs/free",
	"terms_of_use": "https://www.exchangerate-api.com/terms",
	"time_last_update_unix": 1585872397,
	"time_last_update_utc": "Fri, 02 Apr 2020 00:06:37 +0000",
	"time_next_update_unix": 1585959987,
	"time_next_update_utc": "Sat, 03 Apr 2020 00:26:27 +0000",
	"time_eol_unix": 0,
	"base_code": "USD",
	"rates": {
		"USD": 1,
		"AED": 3.67,
		"ARS": 64.51,
		"AUD": 1.65,
		"CAD": 1.42,
		"CHF": 0.97,
		"CLP": 864.53,
		"CNY": 7.1,
		"EUR": 0.919,
		"GBP": 0.806,
		"HKD": 7.75,
		"...": 7.85,
		"...": 1.31,
		"...": 7.47, etc. etc.
	}
}
```

--------------------------------

### API Error Response Example (JSON)

Source: https://www.exchangerate-api.com/docs/standard-requests

Shows the JSON format for error responses from the API, including potential error types like 'unknown-code', 'malformed-request', 'invalid-key', 'inactive-account', and 'quota-reached'.

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

--------------------------------

### Fetch API Request Quota (HTTP GET)

Source: https://www.exchangerate-api.com/docs/request-quota-endpoint

Demonstrates how to make a GET request to the ExchangeRate-API endpoint to retrieve information about your current API request quota status. This requires substituting your API key into the URL. The response is a JSON object containing details about your plan's quota, remaining requests, and when your quota refreshes.

```http
GET https://v6.exchangerate-api.com/v6/**_YOUR-API-KEY_**/quota
```

--------------------------------

### API Request Quota Success Response

Source: https://www.exchangerate-api.com/docs/request-quota-endpoint

Provides an example of a successful JSON response from the API Request Quota endpoint. This structure includes the result status, links to documentation and terms of use, the total `plan_quota`, the `requests_remaining`, and the `refresh_day_of_month` for your account.

```json
{
	"result": "success",
	"documentation": "https://www.exchangerate-api.com/docs",
	"terms_of_use": "https://www.exchangerate-api.com/terms",
	"plan_quota": 30000,
	"requests_remaining": 25623,
	"refresh_day_of_month": 17
}
```

--------------------------------

### Token Bearer Authentication Example

Source: https://www.exchangerate-api.com/docs/authentication

This example shows how to use Token Bearer Authentication by passing your API key as a Bearer token in the Authorization HTTP header. This method offers improved security by not exposing the key in the URL.

```http
Authorization: Bearer **_YOUR-API-KEY_**
GET https://v6.exchangerate-api.com/v6/latest/**_USD_**
```

--------------------------------

### Fetch Historical Exchange Rates (GET Request)

Source: https://www.exchangerate-api.com/docs/historical-data-requests

This example demonstrates how to make a GET request to the Historical Exchange Rates API endpoint to retrieve all available exchange rates for a specific date. You need to replace placeholders with your API key, base currency code, year, month, and day. The response includes conversion rates for various currencies.

```http
GET https://v6.exchangerate-api.com/v6/**_YOUR-API-KEY_**/history/**_USD_**/**_YEAR_**/**_MONTH_**/**_DAY_**
```

```json
{
	"result":"success",
	"documentation":"https://www.exchangerate-api.com/docs",
	"terms_of_use":"https://www.exchangerate-api.com/terms",
	"year":2015,
	"month":2,
	"day":22,
	"base_code":"USD",
	"conversion_rates":{
		"AUD":1.4196,
		"BRL":4.0003,
		"CAD":1.324,
		"CHF":0.9744,
		"CNY":6.3559,
		"DKK":6.6601,
		"EUR":0.8929,
		"GBP":0.6595,
		"HKD":7.75,
		"INR":65.57,
		"JPY":119.58,
		"KRW":118,
		....
	}
}
```

--------------------------------

### Enriched Data Request - Python

Source: https://www.exchangerate-api.com/docs/enriched-data-requests

Example of making an Enriched Data Request using Python. This snippet shows how to use the 'requests' library to call the API, specifying the API key and currency codes, and handling the JSON response.

```Python
import requests

api_key = 'YOUR-API-KEY'
base_currency = 'GBP'
target_currency = 'JPY'

url = f"https://v6.exchangerate-api.com/v6/{api_key}/enriched/{base_currency}/{target_currency}"

response = requests.get(url)
data = response.json()

if data['result'] == 'success':
    print(f"Conversion Rate: {data['conversion_rate']}")
    print(f"Target Currency Name: {data['target_data']['currency_name']}")
    print(f"Flag URL: {data['target_data']['flag_url']}")
else:
    print(f"Error: {data['error-type']}")

```

--------------------------------

### Enriched Data Request - Ruby

Source: https://www.exchangerate-api.com/docs/enriched-data-requests

Example of making an Enriched Data Request using Ruby. This snippet utilizes the 'net/http' and 'json' libraries to call the API and parse the response.

```Ruby
require 'net/http'
require 'uri'
require 'json'

api_key = 'YOUR-API-KEY'
base_currency = 'GBP'
target_currency = 'JPY'

uri = URI.parse("https://v6.exchangerate-api.com/v6/#{api_key}/enriched/#{base_currency}/#{target_currency}")

response = Net::HTTP.get(uri)
data = JSON.parse(response)

if data['result'] == 'success'
  puts "Conversion Rate: #{data['conversion_rate']}"
  puts "Target Currency Name: #{data['target_data']['currency_name']}"
  puts "Flag URL: #{data['target_data']['flag_url']}"
else
  puts "Error: #{data['error-type']}"
end

```

--------------------------------

### Fetch Specific Pair Historical Exchange Rates (GET Request)

Source: https://www.exchangerate-api.com/docs/historical-data-requests

This example shows how to fetch historical exchange rates for a specific amount on a given date. Replace placeholders with your API key, base currency, year, month, day, and the amount to convert. The response provides the converted amounts for all available currencies.

```http
GET https://v6.exchangerate-api.com/v6/**_YOUR-API-KEY_**/history/**_USD_**/**_YEAR_**/**_MONTH_**/**_DAY_**/**_AMOUNT_**
```

```json
{
	"result":"success",
	"documentation":"https://www.exchangerate-api.com/docs",
	"terms_of_use":"https://www.exchangerate-api.com/terms",
	"year":2015,
	"month":2,
	"day":22,
	"base_code":"USD",
	"requested_amount":4.00,
	"conversion_amounts":{
		"AUD":5.664,
		"BRL":16.0012,
		"CAD":5.296,
		"CHF":3.8976,
		"CNY":25.4236,
		"DKK":26.6404,
		"EUR":3.5716,
		"GBP":2.638,
		"HKD":31,
		"INR":262.28,
		"JPY":478.32,
		"KRW":472,
		....
	}
}
```

--------------------------------

### Enriched Data Request - PHP

Source: https://www.exchangerate-api.com/docs/enriched-data-requests

Example of making an Enriched Data Request using PHP. This snippet demonstrates how to construct the API URL with your API key and currency codes, and then fetch and process the JSON response.

```PHP
<?php

$apiKey = 'YOUR-API-KEY';
$baseCurrency = 'GBP';
$targetCurrency = 'JPY';

$url = "https://v6.exchangerate-api.com/v6/{$apiKey}/enriched/{$baseCurrency}/{$targetCurrency}";

$response = file_get_contents($url);
$data = json_decode($response, true);

if ($data && $data['result'] === 'success') {
    echo "Conversion Rate: " . $data['conversion_rate'] . "\n";
    echo "Target Currency Name: " . $data['target_data']['currency_name'] . "\n";
    echo "Flag URL: " . $data['target_data']['flag_url'] . "\n";
} else {
    echo "Error: " . $data['error-type'] . "\n";
}

?>
```

--------------------------------

### Get Latest Exchange Rates (USD Base)

Source: https://www.exchangerate-api.com/docs/free

Demonstrates how to fetch the latest exchange rates with USD as the base currency using the Open Access API. The response includes rates against all supported currencies.

```http
GET https://open.er-api.com/v6/latest/USD
```

--------------------------------

### Pair Conversion Endpoint

Source: https://www.exchangerate-api.com/docs/overview

Submit a pair of currency codes and an optional amount to get the exchange rate between them and the conversion of the amount.

```APIDOC
## GET /api/v1/pair-conversion/{base_currency}/{target_currency}

### Description
Converts an amount from a base currency to a target currency using the latest exchange rates.

### Method
GET

### Endpoint
/api/v1/pair-conversion/{base_currency}/{target_currency}

### Parameters
#### Path Parameters
- **base_currency** (string) - Required - The currency code to convert from.
- **target_currency** (string) - Required - The currency code to convert to.

#### Query Parameters
- **amount** (number) - Optional - The amount to convert.

### Request Example
```json
{
  "example": "GET /api/v1/pair-conversion/USD/EUR?amount=100"
}
```

### Response
#### Success Response (200)
- **result** (string) - The status of the request (e.g., "success").
- **base_code** (string) - The base currency code.
- **target_code** (string) - The target currency code.
- **conversion_rate** (number) - The exchange rate between the base and target currency.
- **converted_amount** (number) - The converted amount.

#### Response Example
```json
{
  "example": {
    "result": "success",
    "base_code": "USD",
    "target_code": "EUR",
    "conversion_rate": 0.92,
    "converted_amount": 92.00
  }
}
```
```

--------------------------------

### Fetch Supported Currency Codes (Java)

Source: https://www.exchangerate-api.com/docs/supported-codes-endpoint

Retrieves currency codes supported by the ExchangeRate-API via a GET request, requiring an API key. The result is parsed from JSON, extracting the 'supported_codes' array.

```java
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import org.json.JSONArray;
import org.json.JSONObject;

public class SupportedCodesFetcher {

    public static void main(String[] args) {
        String apiKey = "YOUR-API-KEY"; // Replace with your actual API key
        String url = String.format("https://v6.exchangerate-api.com/v6/%s/codes", apiKey);

        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create(url))
                .GET()
                .build();

        try {
            HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
            JSONObject data = new JSONObject(response.body());

            if (data.getString("result").equals("success")) {
                System.out.println("Supported Currencies:");
                JSONArray supportedCodes = data.getJSONArray("supported_codes");
                for (int i = 0; i < supportedCodes.length(); i++) {
                    JSONArray codePair = supportedCodes.getJSONArray(i);
                    System.out.println("- " + codePair.getString(0) + ": " + codePair.getString(1));
                }
            } else {
                System.out.println("Error fetching supported codes: " + data.getString("error-type"));
            }

        } catch (IOException | InterruptedException e) {
            e.printStackTrace();
        }
    }
}
```

--------------------------------

### Supported Codes

Source: https://www.exchangerate-api.com/docs/overview

Retrieve a list of all currency codes supported by the API.

```APIDOC
## GET /api/v1/codes

### Description
Returns a list of all currency codes supported by the ExchangeRate-API.

### Method
GET

### Endpoint
/api/v1/codes

### Parameters
None

### Request Example
```json
{
  "example": "GET /api/v1/codes"
}
```

### Response
#### Success Response (200)
- **result** (string) - The status of the request.
- **supported_codes** (object) - An object where keys are currency codes and values are their corresponding currency names.

#### Response Example
```json
{
  "example": {
    "result": "success",
    "supported_codes": {
      "USD": "United States Dollar",
      "EUR": "Euro",
      "GBP": "British Pound Sterling",
      "JPY": "Japanese Yen"
    }
  }
}
```
```

--------------------------------

### Supported Codes API

Source: https://www.exchangerate-api.com/docs/c-sharp-currency-api

Retrieve a list of all currency codes supported by the API.

```APIDOC
## GET /codes

### Description
Retrieves a list of all currency codes that are supported by the Exchange Rate API.

### Method
GET

### Endpoint
`/codes`

### Parameters
This endpoint does not require any parameters.

### Request Example
`GET /codes`

### Response
#### Success Response (200)
- **supported_codes** (object) - An object where keys are currency codes and values are their names.

#### Response Example
```json
{
  "supported_codes": {
    "USD": "United States Dollar",
    "EUR": "Euro",
    "GBP": "British Pound Sterling"
  }
}
```
```

--------------------------------

### Fetch Supported Currency Codes (Objective C)

Source: https://www.exchangerate-api.com/docs/supported-codes-endpoint

Demonstrates fetching supported currency codes from ExchangeRate-API using Objective-C's Foundation framework. It requires an API key and handles the JSON response asynchronously.

```objectivec
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[]) {
    @autoreleasepool {
        NSString *apiKey = @"YOUR-API-KEY"; // Replace with your actual API key
        NSString *urlString = [NSString stringWithFormat:@"https://v6.exchangerate-api.com/v6/%@/codes", apiKey];
        NSURL *url = [NSURL URLWithString:urlString];
        NSURLRequest *request = [NSURLRequest requestWithURL:url];
        
        NSURLSession *session = [NSURLSession sharedSession];
        NSURLSessionDataTask *task = [session dataTaskWithRequest:request completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
            if (error) {
                NSLog(@"Error fetching supported codes: %@\n", error.localizedDescription);
                return;
            }
            
            NSError *jsonError = nil;
            NSDictionary *jsonResponse = [NSJSONSerialization JSONObjectWithData:data options:0 error:&jsonError];
            
            if (jsonError) {
                NSLog(@"JSON Parsing Error: %@\n", jsonError.localizedDescription);
                return;
            }
            
            if ([jsonResponse[@"result"] isEqualToString:@"success"]) {
                NSLog(@"Supported Currencies:\n");
                NSArray *supportedCodes = jsonResponse[@"supported_codes"];
                for (NSArray *codePair in supportedCodes) {
                    NSLog(@"- %@: %@\n", codePair[0], codePair[1]);
                }
            } else {
                NSLog(@"Error: %@\n", jsonResponse[@"error-type"]);
            }
        }];
        
        [task resume];
        
        // Keep the main thread alive to allow the network task to complete
        CFRunLoopRun(); 
    }
    return 0;
}
```

--------------------------------

### Standard Endpoint

Source: https://www.exchangerate-api.com/docs/overview

This is the main API response format. Given a supplied base currency, it returns a list of other supported currencies and their corresponding exchange rates.

```APIDOC
## GET /api/v1/exchangerate/{base_currency}

### Description
Retrieves exchange rates from a specified base currency to all supported currencies.

### Method
GET

### Endpoint
/api/v1/exchangerate/{base_currency}

### Parameters
#### Path Parameters
- **base_currency** (string) - Required - The currency code from which to convert (e.g., USD, EUR).

### Request Example
```json
{
  "example": "GET /api/v1/exchangerate/USD"
}
```

### Response
#### Success Response (200)
- **result** (string) - The status of the request (e.g., "success").
- **base_code** (string) - The base currency code.
- **rates** (object) - An object containing currency codes as keys and their exchange rates as values.

#### Response Example
```json
{
  "example": {
    "result": "success",
    "base_code": "USD",
    "rates": {
      "EUR": 0.92,
      "GBP": 0.79,
      "JPY": 150.50
    }
  }
}
```
```

--------------------------------

### Fetch Supported Currency Codes (Ruby)

Source: https://www.exchangerate-api.com/docs/supported-codes-endpoint

Uses Ruby's Net::HTTP library to fetch supported currency codes from the ExchangeRate-API. An API key is required, and the JSON response is parsed to display currency information.

```ruby
require 'net/http'
require 'uri'
require 'json'

api_key = 'YOUR-API-KEY' # Replace with your actual API key
url_str = "https://v6.exchangerate-api.com/v6/#{api_key}/codes"
uri = URI.parse(url_str)

response = Net::HTTP.get_response(uri)
data = JSON.parse(response.body)

if data['result'] == 'success'
  puts "Supported Currencies:"
  data['supported_codes'].each do |code_pair|
    puts "- #{code_pair[0]}: #{code_pair[1]}"
  end
else
  puts "Error fetching supported codes: #{data['error-type']}"
end
```

--------------------------------

### Pair Conversion API

Source: https://www.exchangerate-api.com/docs/c-sharp-currency-api

Convert currency from one pair to another using the latest exchange rates.

```APIDOC
## GET /pair/{base_currency}/{target_currency}

### Description
Converts a specified amount from a base currency to a target currency using the latest exchange rates.

### Method
GET

### Endpoint
`/pair/{base_currency}/{target_currency}`

### Parameters
#### Path Parameters
- **base_currency** (string) - Required - The currency code of the base currency (e.g., USD).
- **target_currency** (string) - Required - The currency code of the target currency (e.g., EUR).

#### Query Parameters
- **amount** (number) - Optional - The amount of the base currency to convert. Defaults to 1 if not specified.

### Request Example
`GET /pair/USD/EUR?amount=100`

### Response
#### Success Response (200)
- **result** (string) - The conversion rate or result of the conversion.
- **base_code** (string) - The code of the base currency.
- **target_code** (string) - The code of the target currency.
- **amount** (number) - The original amount.

#### Response Example
```json
{
  "result": 92.50,
  "base_code": "USD",
  "target_code": "EUR",
  "amount": 100
}
```
```

--------------------------------

### Historical Data Retrieval in C#

Source: https://www.exchangerate-api.com/docs/c-sharp-currency-api

Shows how to fetch historical exchange rate data for a specific currency pair and date using the Exchange Rate API in C#. An API key is necessary.

```csharp
using System;
using System.Net.Http;
using System.Threading.Tasks;

public class ExchangeRateClient
{
    private readonly HttpClient _httpClient;
    private readonly string _apiKey;

    public ExchangeRateClient(string apiKey)
    {
        _httpClient = new HttpClient();
        _apiKey = apiKey;
        _httpClient.BaseAddress = new Uri("https://v6.exchangerate-api.com/v6/");
    }

    public async Task<string> GetHistoricalDataAsync(string fromCurrency, string toCurrency, string date)
    {
        var response = await _httpClient.GetAsync($"{_apiKey}/history/{fromCurrency}/{toCurrency}/{date}");
        response.EnsureSuccessStatusCode(); // Throw if status code is not 2xx
        return await response.Content.ReadAsStringAsync();
    }

    // Example Usage:
    public static async Task Main(string[] args)
    {
        string apiKey = "YOUR_API_KEY"; // Replace with your actual API key
        var client = new ExchangeRateClient(apiKey);
        try
        {
            string historicalData = await client.GetHistoricalDataAsync("USD", "EUR", "2023-10-26");
            Console.WriteLine(historicalData);
        }
        catch (HttpRequestException e)
        {
            Console.WriteLine($"Error: {e.Message}");
        }
    }
}
```

--------------------------------

### Exchange Rate API - Error Handling

Source: https://www.exchangerate-api.com/docs/free

Details on how the Exchange Rate API communicates success and error conditions.

```APIDOC
## Exchange Rate API - Response Structure

### Description
This section details the structure of responses from the Exchange Rate API, focusing on how success and error states are indicated.

### Method
N/A (Applies to all endpoints)

### Endpoint
N/A (Applies to all endpoints)

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response
- **result** (string) - Indicates 'success' when the API request is processed without issues.

#### Error Response
- **result** (string) - Indicates 'error' when there is a problem serving the response.
- **error-type** (string) - Provides further information about the type of error encountered.
```

--------------------------------

### Fetch Latest Exchange Rates in Python

Source: https://www.exchangerate-api.com/docs/python-currency-api

This Python code snippet demonstrates how to fetch the latest exchange rates from the Exchange Rate API. It uses the `requests` library to make a GET request to the API endpoint with a specified base currency. The function returns a JSON object containing conversion rates.

```Python
import requests

# Where USD is the base currency you want to use
url = 'https://v6.exchangerate-api.com/v6/YOUR-API-KEY/latest/USD'

# Making our request
response = requests.get(url)
data = response.json()

# Your JSON object
print data
```

--------------------------------

### Perl: Fetch Latest Exchange Rates

Source: https://www.exchangerate-api.com/docs/perl-currency-api

This snippet demonstrates how to fetch the latest exchange rates for a given base currency using the Exchange Rate API in Perl. It utilizes the LWP::UserAgent and JSON modules to make the GET request and parse the response. Ensure you replace 'YOUR-API-KEY' with your actual API key.

```perl
use LWP::UserAgent;
use HTTP::Request;
use JSON;

# Making request
my $base_code = "USD";
my $URL = "https://v6.exchangerate-api.com/v6/YOUR-API-KEY/latest/" . $base_code;
my $ua = LWP::UserAgent->new(ssl_opts => { verify_hostname => 1 });
my $header = HTTP::Request->new(GET => $URL);
my $request = HTTP::Request->new('GET', $URL, $header);
my $response = $ua->request($request);
my $content = $response->content;

# Parsing JSON
$json = JSON->new->allow_nonref;
$decoded = $json->decode( $content );
foreach $to_code (keys %{$decoded->{conversion_rates}}) {
   print "Exchange Rate $base_code/$to_code = $decoded->{conversion_rates}->{$to_code}\n";
}
```

--------------------------------

### Open Access Endpoint

Source: https://www.exchangerate-api.com/docs/free

The Open Access endpoint provides free exchange rates without an API key, but requires attribution. Data updates once per day and is rate-limited.

```APIDOC
## GET /v6/latest/{baseCode}

### Description
Retrieves the latest exchange rates from a specified base currency to all other supported currencies.

### Method
GET

### Endpoint
`https://open.er-api.com/v6/latest/{baseCode}`

### Parameters
#### Path Parameters
- **baseCode** (string) - Required - The three-letter currency code (ISO 4217) for which to retrieve exchange rates (e.g., USD, EUR).

### Request Example
```
GET https://open.er-api.com/v6/latest/USD
```

### Response
#### Success Response (200)
- **result** (string) - Indicates the success of the request ('success').
- **provider** (string) - The URL of the data provider.
- **documentation** (string) - The URL to the API documentation.
- **terms_of_use** (string) - The URL to the API terms of use.
- **time_last_update_unix** (integer) - The time of the last data update in Unix timestamp format.
- **time_last_update_utc** (string) - The time of the last data update in UTC format.
- **time_next_update_unix** (integer) - The Unix timestamp for the next scheduled data update.
- **time_next_update_utc** (string) - The UTC time for the next scheduled data update.
- **time_eol_unix** (integer) - The Unix timestamp indicating when the endpoint will be end-of-life (0 if not applicable).
- **base_code** (string) - The base currency code used in the request.
- **rates** (object) - An object containing currency codes as keys and their corresponding exchange rates as values.

#### Response Example
```json
{
	"result": "success",
	"provider": "https://www.exchangerate-api.com",
	"documentation": "https://www.exchangerate-api.com/docs/free",
	"terms_of_use": "https://www.exchangerate-api.com/terms",
	"time_last_update_unix": 1585872397,
	"time_last_update_utc": "Fri, 02 Apr 2020 00:06:37 +0000",
	"time_next_update_unix": 1585959987,
	"time_next_update_utc": "Sat, 03 Apr 2020 00:26:27 +0000",
	"time_eol_unix": 0,
	"base_code": "USD",
	"rates": {
		"USD": 1,
		"AED": 3.67,
		"ARS": 64.51,
		"AUD": 1.65,
		"CAD": 1.42,
		"CHF": 0.97,
		"CLP": 864.53,
		"CNY": 7.1,
		"EUR": 0.919,
		"GBP": 0.806,
		"HKD": 7.75
	}
}
```

### Error Handling
- **429 Too Many Requests**: Returned if the rate limit is exceeded. The rate limit typically resets after 20 minutes.
```

--------------------------------

### Supported Currencies

Source: https://www.exchangerate-api.com/docs/supported-currencies

Lists all world currencies supported by the exchange rate API, including their ISO 4217 codes, names, and countries. It also notes unsupported currencies and currencies with heightened volatility.

```APIDOC
## Supported Currencies

### Description
Lists all world currencies supported by the exchange rate API, including their ISO 4217 codes, names, and countries. It also notes unsupported currencies and currencies with heightened volatility.

### Unsupported Currencies

| Currency Code | Currency Name | Country |
|---|---|---|
| KPW | North Korean Won | North Korea |

### Notes For Some Supported Currencies

| Currency Code | Currency Name | Country |
|---|---|---|
| ARS | Argentine Peso | Argentina |
| LYD | Libyan Dinar | Libya |
| SSP | South Sudanese Pound | South Sudan |
| SYP | Syrian Pound | Syria |
| VES | Venezuelan Bolívar Soberano | Venezuela |
| YER | Yemeni Rial | Yemen |
| ZWL | Zimbabwean Dollar | Zimbabwe |

### All Supported Currencies

We support all 161 commonly circulating world currencies listed below. These cover 99% of all UN recognized states and territories.

| Currency Code | Currency Name | Country |
```

--------------------------------

### Fetch Supported Currency Codes (Python)

Source: https://www.exchangerate-api.com/docs/supported-codes-endpoint

Fetches a list of supported currencies from the ExchangeRate-API using an API key. The output is a JSON structure with a 'supported_codes' field.

```python
import requests

api_key = 'YOUR-API-KEY' # Replace with your actual API key
url = f"https://v6.exchangerate-api.com/v6/{api_key}/codes"

response = requests.get(url)
data = response.json()

if data.get('result') == 'success':
    print("Supported Currencies:")
    for code in data['supported_codes']:
        print(f"- {code[0]}: {code[1]}")
else:
    print(f"Error fetching supported codes: {data.get('error-type', 'Unknown error')}")
```

--------------------------------

### Fetch Supported Currency Codes (C#)

Source: https://www.exchangerate-api.com/docs/supported-codes-endpoint

C# code snippet using HttpClient to fetch supported currency codes from ExchangeRate-API. It requires an API key and deserializes the JSON response into a C# object.

```csharp
using System;
using System.Net.Http;
using System.Threading.Tasks;
using Newtonsoft.Json;

public class SupportedCodesFetcher
{
    public class ApiResponse
    {
        public string Result { get; set; }
        public string ErrorType { get; set; } // Maps to "error-type"
        public System.Collections.Generic.List<System.Collections.Generic.List<string>> SupportedCodes { get; set; } // Maps to "supported_codes"
    }

    public static async Task Main(string[] args)
    {
        string apiKey = "YOUR-API-KEY"; // Replace with your actual API key
        string url = $"https://v6.exchangerate-api.com/v6/{apiKey}/codes";

        using (HttpClient client = new HttpClient())
        {
            try
            {
                HttpResponseMessage response = await client.GetAsync(url);
                response.EnsureSuccessStatusCode(); // Throw an exception if the status code is not success

                string responseBody = await response.Content.ReadAsStringAsync();
                ApiResponse data = JsonConvert.DeserializeObject<ApiResponse>(responseBody);

                if (data.Result == "success")
                {
                    Console.WriteLine("Supported Currencies:");
                    foreach (var codePair in data.SupportedCodes)
                    {
                        Console.WriteLine($"- {codePair[0]}: {codePair[1]}");
                    }
                }
                else
                {
                    Console.WriteLine($"Error fetching supported codes: {data.ErrorType}");
                }
            }
            catch (HttpRequestException e)
            {
                Console.WriteLine($"Request Error: {e.Message}");
            }
            catch (JsonException e)
            {
                Console.WriteLine($"JSON Parsing Error: {e.Message}");
            }
        }
    }
}
```
Tokens:
Raw