外為API接続チュートリアル：リアルタイムの為替レートと過去のKラインデータを取得する方法

外国為替市場のダッシュボードやクオンツ取引システムを開発する際、通常は2つの課題を解決する必要があります。1つはEUR/USDやUSD/JPYなどの通貨ペアの最新レートを継続的に取得すること、もう1つはチャートの描画や取引戦略の検証に使用する過去の価格データを取得することです。

これらの要件は似ていますが、適切なAPIの利用方法は必ずしも同じではありません。外為APIの接続で重要なのは、単にデータを取得することだけではありません。適切なデータ配信方式を選び、タイムスタンプを正しく処理し、リアルタイムのレートと過去のデータを適切に連携させることも重要です。

リアルタイムの為替レートにはREST APIとWebSocketのどちらを使うべきか？

ユーザーがページを開いたときに一度だけレートを取得するアプリケーションであれば、REST APIのほうが一般的にシンプルです。プログラムがHTTPリクエストを送信し、現在のデータを取得してリクエストを終了します。この方式は、レートの照会、ページの初期表示、定期的な更新に適しています。

一方、取引端末でEUR/USDの最新の買値と売値を表示するなど、為替レートを継続的に更新する必要がある場合、REST APIを繰り返し呼び出すには、その都度リクエストを送信しなければなりません。また、リクエスト間に発生した市場データの更新をすべて取得できるとは限りません。

このような用途には、継続的な市場データの購読に適したWebSocketが有効です。クライアントが接続を確立し、必要な通貨ペアを購読すると、サーバーから更新データが継続的にプッシュされるため、HTTPリクエストを繰り返し送信する負荷を軽減できます。

外為市場データAPIを選ぶ際には、対応する通貨ペア、取得できるレートのフィールド、契約プランごとのリクエスト頻度や購読数の制限も確認する必要があります。異なるAPIが似たような価格を返していても、データの意味が同じとは限りません。

AllTickを使用して過去の為替Kラインデータを取得する

例えば、EUR/USDの過去の市場データを取得したい場合、AllTickの外為データAPIを利用して、HTTP GETリクエストでKラインデータを取得できます。

外国為替、貴金属、暗号資産、および一部の商品に対応する過去のKライン取得エンドポイントは、/quote-b-api/kline です。リクエストでは、token パラメータを通じてAPIトークンを渡し、URLエンコードされたJSONパラメータを query に指定します。

以下のPythonコードでは、EUR/USDの最新のKラインを100本取得します。各ローソク足の時間間隔は5分です。

import json
import os
import uuid
import requests

BASE_URL = "https://quote.alltick.co/quote-b-api"
TOKEN = os.environ["ALLTICK_API_TOKEN"]

query = {
    "trace": str(uuid.uuid4()),
    "data": {
        "code": "EURUSD",
        "kline_type": 2,
        "kline_timestamp_end": 0,
        "query_kline_num": 100,
        "adjust_type": 0
    }
}

response = requests.get(
    f"{BASE_URL}/kline",
    params={
        "token": TOKEN,
        "query": json.dumps(query)
    },
    timeout=15
)

response.raise_for_status()
result = response.json()

if result.get("ret") != 200:
    raise RuntimeError(f"API error: {result}")

candles = result.get("data", {}).get("kline_list", [])
print(f"Retrieved {len(candles)} candles")

実行前に requests をインストールし、有効なAPIトークンを環境変数 ALLTICK_API_TOKEN に設定してください。このコードは、リクエストの送信方法と基本的なエラー処理を示したものです。実際のレスポンス構造と呼び出し結果については、最新のドキュメントと利用中のアカウントで確認する必要があります。

特に注意すべきパラメータは次のとおりです。

• code：通貨ペアを指定します。製品でサポートされているコード形式を使用してください。
• kline_type：Kラインの時間間隔を指定します。この例では 2 が5分足に対応します。
• kline_timestamp_end：取得するデータの時間境界を指定します。0 は、最新の取得可能な市場データの範囲から照会することを意味します。
• query_kline_num：取得するKラインの本数を指定します。1回のリクエストで取得できるのは最大500本です。

さらに多くの過去データが必要な場合、1回のリクエストですべて取得できると想定してはいけません。サポートされている時間境界を利用してデータを分割取得し、タイムスタンプの重複、データの並び順、取得結果の完全性を確認してください。

リアルタイムの為替レートを接続した後にタイムスタンプを確認する理由

APIからデータを受信できたからといって、そのデータをそのまま計算や業務ロジックに使用できるとは限りません。

例えば、WebSocketを通じてEUR/USDの更新データを複数受信したとします。プログラムがメッセージの到着順に現在価格を上書きするだけでは、ネットワーク遅延によって古いレートが新しいレートより後に届く可能性があります。その結果、画面に古い価格が表示されることがあります。

より確実な方法は、各レートのイベント時刻を記録し、市場データが生成された時刻とローカル環境で受信した時刻を区別することです。キャッシュを更新する際には、メッセージの到着順だけに依存するのではなく、データの種類とAPIが提供するタイムスタンプフィールドに基づいて、新しいレコードで現在のデータを上書きすべきか判断します。

過去のKラインデータにも同様の確認が必要です。複数のバッチから取得したデータを統合するときは、通貨ペアやKラインの時間間隔などのフィールドで対象データを識別し、タイムスタンプに基づいて重複を除去して並べ替えます。時間軸に空白がある場合は、通常の市場休場時間やデータの提供範囲に該当するかどうかを先に確認してください。すべての空白を直前のローソク足の終値で自動的に埋めるべきではありません。

また、リアルタイムのレートと過去のKラインでは、更新のタイミングが異なる場合があります。過去のチャートの末尾を継続的に更新する必要がある場合は、最新のローソク足が確定済みなのか、まだ形成中なのかを明確にしてください。そうしなければ、未確定のローソク足を最終的な終値として誤って扱う可能性があります。

外為市場データAPIを選ぶ前に確認すべきこと

接続前に、次の3点を確認してください。必要な通貨ペアが対応範囲に含まれているか、過去データの取得期間とKラインの時間間隔が要件を満たしているか、そして契約プランが必要なリクエスト頻度とWebSocket接続数をサポートしているか、という点です。

AllTickの外為APIページでは、EUR/USD、GBP/USD、USD/JPYなどの代表的な通貨ペアが掲載されています。また、リアルタイムの買値・売値、Tickデータ、OHLC Kライン、過去の時系列データなどのデータ種別が紹介されています。実際の対応範囲と利用可能な権限については、最新の製品一覧、契約プランの説明、APIドキュメントで確認してください。

外為市場のダッシュボード、クオンツ取引戦略、市場データサービスを開発している場合は、まずAllTick外為市場データAPIを確認し、続いてAllTick APIドキュメントを参照して、接続前にパラメータ、認証方式、データの制限を確認してください。

信頼性の高い外為API接続には、リアルタイム価格を取得するだけでなく、過去データ、タイムスタンプ、更新ロジックがアプリケーションの実際の要件を満たしていることが必要です。 本番環境に導入する前に、対象の通貨ペアでリクエスト結果を検証し、WebSocketの再接続、データの重複排除、過去のKラインデータの補完処理をテストしてください。