為替レートの取得

GEThttps://api.omise.co/forex/:currency

指定された通貨ペアの現在の外国為替レートを取得します。マルチ通貨取引に使用されるリアルタイムの為替レートを返します。このエンドポイントは、アカウントでマルチ通貨取引が有効になっている場合にのみアクセス可能です。

---

🔑API認証情報

▼

---

リクエストパラメータ

必須 - 1項目必須パラメータ

▼

`currency`STRING(required)

小文字の3文字のISO 4217コードとしての基準通貨。レートは、この通貨からアカウントの資金調達通貨への換算を示します。

Example:"usd"

Values:thb, jpy, sgd, myr, usd, eur, gbp

---

レスポンス

200

リクエスト成功

現在の為替レート情報を含むforexオブジェクトを返します。

Forexオブジェクトの内容:

• object - 文字列値「forex」
• location - APIエンドポイントのパス（例：「/forex/usd」）
• livemode - テストモードまたは本番モードを示すブール値
• base - ソース通貨コード（ISO 4217）
• quote - ターゲット通貨コード（通常はアカウントの資金調達通貨）
• rate - 数値の為替レート（ミッドマーケットの日次レートより約2〜4%高い）

レート計算:

• レートは、基準通貨の1単位に対する見積通貨の量を表します
• 例：base=USD、quote=THB、rate=30.4847の場合、1 USD = 30.4847 THB
• レートにはOmiseのマージン（ミッドマーケットレートより2〜4%高い）が含まれます

401

認証されていません

認証に失敗しました。APIキーが無効または欠落しています。

一般的な原因:

• Authorizationヘッダーが欠落している
• 無効なシークレットキー
• HTTP Basic Auth形式が正しくない

404

見つかりません

通貨が見つからないか、マルチカレンシーが有効になっていません。

一般的な原因:

• 無効な通貨コード
• アカウントでマルチカレンシー取引が有効になっていない
• アカウントでサポートされていない通貨

---

コードサンプル

cURL

curl https://api.omise.co/forex/usd \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

forex = Omise::Forex.retrieve('usd')

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

forex = omise.Forex.retrieve('usd')

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const forex = await omise.forex.retrieve('usd');

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$forex = OmiseForex::retrieve('usd');

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

ForexRate forex = client.forex("usd").get();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var forex = await client.Forex.Retrieve("usd");

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

forex, _ := client.Forex().Get("usd")

---

試してみる

必須 - 1項目

▼

currency(必須)