> ## 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.

# 通貨換算

> `convert`エンドポイントは、リアルタイムの為替レートを使用して特定の金額を通貨間で換算します。金融計算や決済処理に最適です。

## はじめに

### ベースURL

```
https://exchange-rates.cleariflow.com/v1/convert
```

### 検証エンドポイント

`convert`エンドポイントには、APIキー、基準通貨、targetパラメータが必要です。

```
https://exchange-rates.cleariflow.com/v1/convert
? api_key = YOUR_UNIQUE_API_KEY
& base = EUR
& target = USD
```

この成功したリクエストは、最新の為替レートを使用して1 EURをUSDに換算します。

<ResponseExample>
  ```json theme={"system"}
  {
      "base": "EUR",
      "target": "USD",
      "base_amount": 1,
      "converted_amount": 1.160968,
      "exchange_rate": 1.160968,
      "last_updated": 1755806612
  }
  ```
</ResponseExample>

### リクエストパラメータ

<ParamField query="api_key" type="String" required>
  固有のAPIキーです。各ユーザーはCleariflowの各APIごとに固有のAPIキーを持っているため、為替レートAPIのキーはIPジオロケーションAPIなどでは動作しません。
</ParamField>

<ParamField query="base" type="String" required>
  最新の為替レートを取得する基準通貨です。このAPIのすべての通貨パラメータと同様に、ISO 4217通貨標準（例：米ドルはUSD）を使用します。
</ParamField>

<ParamField query="target" type="String" required>
  基準通貨に対する為替レートを取得する対象通貨です。baseパラメータと同様、ここで渡す通貨もISO 4217標準に従います。他のエンドポイントとは異なり、`convert` は一度に1つの対象通貨のみを受け付けます。
</ParamField>

<ParamField query="date" type="String">
  レートを取得したい過去の日付を YYYY-MM-DD 形式で指定します。空白のままにすると、利用可能な最新のレートが使用されます。
</ParamField>

<ParamField query="base_amount" type="Float">
  対象通貨に換算したい基準通貨の金額です。
</ParamField>

### レスポンスパラメータ

APIレスポンスは、汎用的で軽量な [JSON形式](https://www.json.org/json-en.html) で返されます。

<ResponseField name="base" type="String">
  為替レートを取得するために使用した基準通貨です。
</ResponseField>

<ResponseField name="target" type="String">
  base\_amountが換算された対象通貨です。
</ResponseField>

<ResponseField name="date" type="String">
  成功したリクエストに従い、通貨が取得された日付です。
</ResponseField>

<ResponseField name="base_amount" type="Float">
  リクエストからの基準通貨の金額です。
</ResponseField>

<ResponseField name="converted_amount" type="Float">
  base\_amountが換算された対象通貨の金額です。
</ResponseField>

<ResponseField name="exchange_rate" type="Float">
  base\_amountを基準通貨から対象通貨に換算するために使用された為替レートです。
</ResponseField>