---
title: Currency Supported API Reference
version: 1.0.0
description: Retrieve the complete list of all supported currencies with full metadata. Returns a map of currency codes to objects containing currency name, country code, country name, availability status, date range, and icon URL. Covers fiat currencies, cryptocurrencies, and precious metals.
openapi: 3.1.1
servers:
  - https://api.apifreaks.com/v1.0
paths: 1
operations: 1
schemas: 3
---

## Table of Contents

- [Currency Supported API Reference v1.0.0](#currency-supported-api-reference-v100)
  - [Authentication](#authentication)
  - [Currency APIs](#currency-apis)
    - [getSupportedCurrencies](#getsupportedcurrencies)
      - [Parameters](#parameters)
      - [Responses](#responses)
  - [Schemas](#schemas)
    - [SupportedCurrenciesResponse](#supportedcurrenciesresponse)
    - [CurrencySupportedItem](#currencysupporteditem)
    - [ErrorResponse](#errorresponse)



# Currency Supported API Reference v1.0.0

Retrieve the complete list of all supported currencies with full metadata. Returns a map of currency codes to objects containing currency name, country code, country name, availability status, date range, and icon URL. Covers fiat currencies, cryptocurrencies, and precious metals.

Base URLs:

* [https://api.apifreaks.com/v1.0](https://api.apifreaks.com/v1.0)

## Authentication

* API Key (ApiKeyAuthHeader)
    - Parameter Name: **X-apiKey**, in: header. Pass your API key via the X-apiKey request header.

* API Key (ApiKeyAuthQuery)
    - Parameter Name: **apiKey**, in: query. Pass your API key via the apiKey query parameter.

## Currency APIs

### getSupportedCurrencies

`GET /currency/supported`

*Get all supported currencies*

Returns a map of all supported currencies with metadata.

#### Parameters

|Name|In|Type|Required|Description|
|---|---|---|---|---|
|format|query|string|false|Response format: `json` (default) or `xml`.|

##### Enumerated Values

|Parameter|Value|
|---|---|
|format|json|
|format|xml|

> Example responses

> Successful operation

```json
{
  "supportedCurrenciesMap": {
    "USD": {
      "currencyCode": "USD",
      "currencyName": "US Dollar",
      "countryCode": "AS",
      "countryName": "American Samoa",
      "status": "AVAILABLE",
      "availableFrom": "2020-01-01",
      "availableUntil": "2026-06-18",
      "icon": "https://currencyfreaks.com/photos/flags/usd.png"
    },
    "BTC": {
      "currencyCode": "BTC",
      "currencyName": "Bitcoin",
      "countryCode": "Crypto",
      "countryName": "Global",
      "status": "AVAILABLE",
      "availableFrom": "2014-01-01",
      "availableUntil": "2026-06-18",
      "icon": "https://currencyfreaks.com/photos/flags/btc.png"
    },
    "XAU": {
      "currencyCode": "XAU",
      "currencyName": "Gold Ounce",
      "countryCode": "Metal",
      "countryName": "Precious Metal",
      "status": "AVAILABLE",
      "availableFrom": "2020-01-01",
      "availableUntil": "2026-06-18",
      "icon": "https://currencyfreaks.com/photos/flags/xau.png"
    }
  }
}
```

> Unsupported Media Type — format is not json or xml

```json
{
  "error": "Unsupported Media Type",
  "message": "The media type specified in the request is not supported. For more details, please refer to the API documentation.",
  "path": "/v1.0/currency/supported",
  "status": 406,
  "timestamp": "2026-07-27T12:12:35.587Z"
}
```

#### Responses

|Status|Meaning|Description|Schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Successful operation|[SupportedCurrenciesResponse](#supportedcurrenciesresponse)|
|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|Unsupported Media Type — format is not json or xml|[ErrorResponse](#errorresponse)|

#### Response Headers

|Status|Header|Type|Format|Description|
|---|---|---|---|---|
|200|X-AF-Credits-Cost|integer||Specifies the number of credits consumed by the current request.|
|406|X-AF-Credits-Cost|integer||Specifies the number of credits consumed by the current request.|

To perform this operation, you must be authenticated by means of one of the following methods:
ApiKeyAuthHeader, ApiKeyAuthQuery

## Schemas

### SupportedCurrenciesResponse

Currency supported response containing the map of all supported currencies.

#### Properties

|Name|Type|Required|Restrictions|Description|
|---|---|---|---|---|
|supportedCurrenciesMap|object|true|none|Map of all supported currencies keyed by currency code. Each key is a currency code and the value contains full currency metadata.|
|» **additionalProperties**|[CurrencySupportedItem](#currencysupporteditem)|false|none|Metadata for a single supported currency.|

### CurrencySupportedItem

Metadata for a single supported currency.

#### Properties

|Name|Type|Required|Restrictions|Description|
|---|---|---|---|---|
|currencyCode|string|true|none|Unique currency code (e.g., USD, BTC, XAU).|
|currencyName|string|true|none|Full name of the currency.|
|countryCode|string|true|none|ISO 3166-1 alpha-2 country code. For crypto: Crypto. For metals: Metal.|
|countryName|string|true|none|Country name. For crypto: Global. For metals: Precious Metal.|
|status|string|true|none|Availability status.|
|availableFrom|string|true|none|Date the currency became available (YYYY-MM-DD).|
|availableUntil|string|true|none|Date the currency is or was available (YYYY-MM-DD).|
|icon|string(uri)|true|none|URL of the currency icon/flag image.|

##### Enumerated Values

|Property|Value|
|---|---|
|status|AVAILABLE|
|status|DEPRECIATED|

### ErrorResponse

Standard error envelope returned by the API on failed requests.

#### Properties

|Name|Type|Required|Restrictions|Description|
|---|---|---|---|---|
|error|string|false|none|Short error category or exception type.|
|message|string|true|none|Human-readable error message describing the failure.|
|path|string|false|none|API endpoint path that produced the error.|
|status|integer|false|none|HTTP status code returned with the error.|
|timestamp|string(date-time)|false|none|Timestamp when the error occurred (ISO 8601).|