メインコンテンツへスキップ
GET
通貨換算

はじめに

ベースURL

検証エンドポイント

convertエンドポイントには、APIキー、基準通貨、targetパラメータが必要です。
この成功したリクエストは、最新の為替レートを使用して1 EURをUSDに換算します。

リクエストパラメータ

api_key
String
必須
固有のAPIキーです。各ユーザーはCleariflowの各APIごとに固有のAPIキーを持っているため、為替レートAPIのキーはIPジオロケーションAPIなどでは動作しません。
base
String
必須
最新の為替レートを取得する基準通貨です。このAPIのすべての通貨パラメータと同様に、ISO 4217通貨標準(例:米ドルはUSD)を使用します。
target
String
必須
基準通貨に対する為替レートを取得する対象通貨です。baseパラメータと同様、ここで渡す通貨もISO 4217標準に従います。他のエンドポイントとは異なり、convert は一度に1つの対象通貨のみを受け付けます。
date
String
レートを取得したい過去の日付を YYYY-MM-DD 形式で指定します。空白のままにすると、利用可能な最新のレートが使用されます。
base_amount
Float
対象通貨に換算したい基準通貨の金額です。

レスポンスパラメータ

APIレスポンスは、汎用的で軽量な JSON形式 で返されます。
base
String
為替レートを取得するために使用した基準通貨です。
target
String
base_amountが換算された対象通貨です。
date
String
成功したリクエストに従い、通貨が取得された日付です。
base_amount
Float
リクエストからの基準通貨の金額です。
converted_amount
Float
base_amountが換算された対象通貨の金額です。
exchange_rate
Float
base_amountを基準通貨から対象通貨に換算するために使用された為替レートです。