> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cleariflow.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Cleariflow Exchange Rates API delivers real-time currency conversion capabilities through a streamlined, contemporary RESTful JSON interface, supporting 80+ global currencies with live rates, historical data, and instant conversion tools.

## Getting started

<Card title="Live exchange rates" icon="activity" href="exchange-rates/live">
  The `live` endpoint provides instant access to current exchange rates across multiple currencies, enabling real-time financial calculations and market monitoring.
</Card>

<Card title="Convert exchange rates" icon="arrow-left-right" href="exchange-rates/convert">
  The `convert` endpoint transforms specific amounts between currencies using the most up-to-date exchange rates, perfect for financial applications and e-commerce platforms.
</Card>

<Card title="Available currency symbols" icon="circle-dollar-sign" href="exchange-rates/symbols">
  The `symbols` endpoint delivers a comprehensive catalog of supported currencies with detailed descriptions, facilitating dynamic currency selection and validation in applications.
</Card>

### REST Architecture

The Exchange Rates API follows REST principles, utilizing predictable resource-oriented URLs and standard HTTP status codes for seamless integration and error handling.

### HTTPS Security

All API communications are secured using TLS 1.2 or higher encryption protocols to ensure data integrity and privacy.

### API Versioning

The Exchange Rates API maintains backward compatibility through versioning, currently operating on Version 1 with planned future enhancements.

### Authentication

Your API key serves as the exclusive credential for accessing the Exchange Rates API. Each Cleariflow service requires a unique key, ensuring secure and isolated access across different APIs.

## Response and error codes

When requests fail, the API returns structured JSON error responses with specific codes and descriptions for effective troubleshooting.

| Code | Type                  | Details                                                                                                                                                     |
| ---- | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 200  | OK                    | Everything worked as expected.                                                                                                                              |
| 204  | OK                    | Their is no location data for the submitted IP.                                                                                                             |
| 400  | Bad request           | Bad request.                                                                                                                                                |
| 401  | Unauthorized          | The request was unacceptable. Typically due to the API key missing or incorrect.                                                                            |
| 422  | Quota reached         | The request was aborted due to insufficient API credits. (Free plans)                                                                                       |
| 429  | Too many requests     | The request was aborted due to the number of allowed requests per second being reached. This happens on free plans as requests are limited to 1 per second. |
| 500  | Internal server error | The request could not be completed due to an error on the server side.                                                                                      |
| 503  | Service unavailable   | The server was unavailable.                                                                                                                                 |