【保存版】Pythonを使ったOANDA API v1で知っておきたい10の基本操作

使っているFX会社はどこ?
自動売買用(1万円キャッシュバック中) → インヴァスト証券
Python API用(FX APIはここしかない) → OANDA ジャパン

日本国内でPythonでFX API取引を行う決定版「OANDA API v1」。Pythonを使ってAPI経由でレート取得や注文、ポジション管理など基本操作をまとめました。

こんばんは、新米データサイエンティスト(@algon_fx)です。先日はLSTMを使ったFX予測のチュートリアルを公開したのですが、思った以上に反響を頂いて嬉しい限りです。

さて、LSTM関連でお問い合わせを頂くことが多いのですが、次に多いのがOANDAのAPIの使い方や質問です。(参考:私の機械学習&FXトレード環境

本記事ではこれからPythonを使ってFX取引に挑もうと考えている方に向けて、OANDA API v1の使うまでの手順やレートの取得、基本的な発注方法などをまとめます。

そもそもなぜOANDAなのか?

まず前提としてですが、現時点で日本国内でFX APIを公開している会社は、私が知っている限りで3社しかありません(OANDA証券、日産証券、YJFXのみ)。過去にクリック証券もFX APIを提供していたのですが、こちらはとうの昔に終了しています。

APIが使える3社を比べるとOANDAは…

APIの利用条件が有利
日産証券は最低300万円の入金など敷居が高いですが、OANDAのプロコースであれば25万円入金でAPIの利用が可能です
APIがすぐ使える
他社ではAPI利用の審査や契約書など手続きが面倒ですがOANDAは口座開設後すぐにAPIキーが発行されます
公式ドキュメントが豊富
これも大きなメリットですがOANDA APIは公式のドキュメントが非常に豊富です

すぐOANDA API v1の利用可能?

はい、デモ口座であれば即時利用が可能です。申し込み後にWEB管理画面からAPIキーの取得が可能で、すぐに利用はできます。

ただ…これから真剣にAPIでトレードを行うのであれば同時にプロコース口座開設することを強くお勧めします。デモ口座とライブ口座の2つを使いこなすのが一番賢いです。

理由は明確で…現金を使わないデモでは真剣にトレードしないからです。デモ口座は大きなメリットがあり、新しいロジックを書いた時や、少し不安がある動作のコードを試すときなどは必ずデモで確認を行います。

ただ、やはり現金での取引ではないので、トレードに勝ちたいと言うマインドがどうしても薄れます。Pythonでコード書いて注文を出したりする部分に自己満してしまい、そもそもトレードに勝つ為のコードの改善などが疎かになります(実体験ですw)

とりあえずデモ口座ですぐにAPIは使えるようになります。同時並行でプロコースのお申し込みをしておけば、少なくとも数日間も掛からずに本番口座でのAPI取引も可能です。私みたいに数週間もデモで取引して時間を無駄にする前に・・・デモとライブを両方最初から揃えた方が絶対に良いです!

またOANDAのプロコースのAPIは本番でも1通貨単位で取引が可能です。そうです。1通貨です(笑)慣れるまでの初期段階でも通貨単位を最低限に抑えることができるのもOANDA APIの大きなメリットです。

デモ口座開設即時APIキー発行可能
プロコース開設APIキー取得まで数日必要

OANDA API v1とv20について

OANDAのAPIですがv1(バージョン1)とv20(バージョン2)の2種類があります。日本で使えるのはOANDA API v1のみです。

ただ日本以外の国ではAPI v1ですが2018年5月に終わっており、現在はOANDA API v20のみの利用が可能な状態です。

機能的にはAPI v1もv20も大きな違いは無いのですが、海外では当然ながらv20が主流で使われています。それに伴い私が参加しているフォーラムやコミニティでは全員がv20を使っており…それらを私が実装するのにいちいちv1へ書き直す必要があるのです。非常に面倒です。

日本でもv20への切り替えが早々に行われるだろうと期待を胸に…OANDAへ聞いたのですが…現状日本ではv20への切り替えは予定されていないとのことでした。。ってことで、当面は日本国内でAPI経由でトレードするにはOANDA API v1に依存することになりそうです。

前置きが長くなりましたが、次のセクションから実際にOANDA APIの基本操作を一緒にPythonを使ってやってみましょう。

概要と必要環境

このチュートリアルの概要と実行環境をまとめました。一緒にAPIを動かしてみたい方は、まずはこちらの環境を揃えましょう。自分のPCに環境作るのが面倒な方は、Google Colabで代替も可能です。

動作環境&ライブラリ

・Python 3.6(Python2だと動きません)
・Jupyter(PythonのIDE的な)
・oandapy(OANDA APIのPythonラッパー)
・pandas(データフレームを扱うライブラリ)
・pytz(日付を処理するライブラリ)

必要なもの

・OANDA 口座番号(2〜3日で取得可能)
・OANDA APIキー(口座開設後は即時取得可能)
こちらから取得可能

チュートリアルでやる事&やらない事

・安全なAPI接続のための設定(configparser)
・現在レートの取得と確認
・APIの日付の変換
・過去レートを取得
・オーダー発注(成行・指値・逆指値・IFD)
・ポジション確認
・レートのストリーミング

下記の内容は含まれません。

・自動売買のストラクチャ構築
・自動売買のロジック&オーダー

あくまでOANDA APIの基本的な操作方法のみです。FXの自動売買のロジックを勉強する記事ではありませんのでご注意ください。

基本操作その1 APIキーと口座番号を別管理

まず一番に覚えるべき操作がこれかと思います。FXは実際のお金が動く世界なわけで、それを全て動かせるAPIキーと口座番号は安全に管理する必要があります。

コードに直接APIキーなどの重要な情報を記載するのは少し怖いです。そこで、最低限の対策としてPythonの configparser を利用します。

configparserでは必要な設定を別ファイルで管理して、設定した事項を読み取る便利な機能です。まずは設定ファイルを作成してあげましょう。各自のパソコンに「 config_v1.txt 」を新規作成しましょう。

下記はダミーですが、各自のAPIキー(api_key)と口座番号(acount_id)を記入しましょう。

では実際にPythonで読み込みましょう。

config.readの箇所ですが、私はconfig_v1.txtをconfigというフォルダー内で管理しています。こちらは設定ファイルを保存した先のディレクトリ指定が必要なのでご注意ください。

基本操作その2 現在のレート取得

実際にAPIに接続をしてレートを取得して見ましょう。まずは必要なライブラリを読み込みます。

APIへ接続して見ましょう。デモ口座で動かしている方はenvironmentを”practice”と変更する必要があります。

特にエラーがでなければAPIへの接続完了です。現在のドル円のレートを取得してみます。

こちらですがdict型です。

中身も覗いて見ましょう。

ドル円のask(売値)とbid(買値)が入っています。time(時間)ですが、現在の時刻となります。ただ注意が必要なのが、こちらの時間はISO8601形式となっています。日本時間に変換させてあげる必要があります。(時間については後ほど処理を行います)

次は複数通貨ペアの現在のレートを取得してみましょう。

ドル円、ユーロ円、ボンド円のレートを取得しました。中身を確認してみましょう。

辞書型ですので、個別の情報にアクセスするには下記のように書きます。

基本操作その3 APIの日付の変換

先ほどAPI経由で取得したレートを確認しましたが、日付がISO8601形式となっていました。他のAPIをいじったことがある方であれば馴染みがあるかも知れませんが、多くのAPIが採用している時間の形式です。

LSTMでFX予測の記事でも行いましたが、APIから取得したデータは全てISO形式となっていますので、日本の時間&フォーマットの変更が必要です。

まずは日本時間へ変換をしてあげましょう。

先ほど取得したレートで確認してみます。APIから取得した生データの時間は下記のような値でした。

こちらを日本時間へ変更してあげましょう。

これではdatetime形式で少し見辛いですので、さらに表示用の文字列として変換してあげましょう。

これで見やすくなりましたね。余談ですが、pandasにはISO形式をdatatime形式へ一発で変換してくれる to_datetime() という関数があります。

ただ注意が必要なのが、APIから取得したデータを日本時間へ直してあげる必要があります。ISOからdatetime形式へ変換はされますが、日本時間ではないので注意しましょう。(最初のころ、私はまさにこれでハマりました・・・)

基本操作その4 過去レートを取得

現時点のレートの取得、APIのデータの構造がある程度解ってきたと思います。次は過去のレートをAPI経由で取得してみましょう。

辞書型では扱いづらいので、Pandasのデータフレーム形式へ変換してあげましょう。

get_history()ですがデフォルトは5秒足(S5)となっています。パラメータとしてgranularityを指定することで、異なる期間のレートを取得できます。試しに1分足(M1)で取得してみましょう。

timeを見て頂くと判りますが1分足になっているのが確認できます。(ちゃんと日本時間へ変換しています)

過去レートの取得でもう一つ覚えておくべきなのが取得件数です。デフォルトでは500件取得可能です。こちらはcountを指定することで、最大5000件まで一度のリクエストで取得が可能です。

先ほど取得した1分足のレートですが500行となっています。ではcountを指定して最大件数の5000件を一度に取得してみましょう。

ご覧の通り5000件取れています。

基本操作その5 口座情報へアクセス

API経由でFX取引を行う際に、定期的に口座情報へのアクセスが必要となります。例えばプログラム上で口座残高が必要になったりする際にです。(口座残高が一定を下回ったら〇〇は注文しないなどのロジック)

ではOANDA API v1で口座情報を引き出してみましょう。まずは基本的な口座情報から。dict型で口座番号や口座の主要通貨が取れます。

口座の基本情報はあまり役に立ちませんが、詳細情報はもう少し実践的な口座情報が含まれます。ではAPIから取得してみましょう。

特に重要なのがbalance(口座残高)とrealizedPl(実現損益)です。また上の状態は全てポジションを決済したあとですので0とありますが、unrealizedPl(評価損益)も重要です。

基本操作その6 API経由で注文してみよう

次はAPIを使って実際に注文を出してみましょう。前述しましたがOANDA API v1は1通貨単位で注文が可能です。実はこれは非常にメリットが高く、とりあえず不安な時は通貨単位を最小限に落として現金でテスト出来ます。

まずは成行注文を出してみましょう。下記は「ドル円」の「売り」で「1万通貨単位」の成行注文(type = market)です。

簡単に注文が可能ですね。念のためOANDAのWEB管理画面で注文が通っているか確認してみましょう。

ご覧の通り112.520でドル円の売り注文が1万通貨通っているのが確認できます。少し混乱しやすいですが、API上ではIDとありますが、これは管理画面上では「チケット番号」と表記されます。

次は指値注文(type = limit)をしてみましょう。指値にはトレードの有効期限のパラメータが必須となります。まずは適当に現在の時刻から+1日を有効期限として作ってあげます。

では指値注文を出してみましょう。create_orderのパラメータ「type」に「limit」と指定することで指値注文が可能です。

では同様に逆指値(type = stop)も出してみましょう。

またOANDA APIには少し変わった注文タイプがあります。それが「type = marketIfTouched」です。これは指定したレートに相場が達した時に「成行注文」が出されます。

加えてAPIで注文する際に覚えておくべき重要な3つのパラメータが下記です。

・takeProfit = 利益確定レート
・stopLoss = 損切りレート
・trailingStop = トレールストップのpip

では試しに成行注文で「takeProfit」と「stopLoss」を指定して発注してみましょう。

ご覧の通り管理画面で確認しても損切りと利確のレートが注文として通っています。実際にPythonを使ってAPI経由でトレードをするときは、私は必ず損切り&利確を指定します。

基本操作その7 トレードの管理

次は発注した注文(トレード)の管理をAPI経由で行いましょう。まずは、オープンオーダー(注文中)を取得してみましょう。

オープンオーダーとは「取引中」、つまり取引が執行されていない注文です。現在、私の口座には1件しか入っていませんが、get_orders()ではオープンオーダー全てを取得できます。

上記の出力を見ればわかりますが、こちらはドル円の買いの逆指値注文@112.800円@100通貨です。まだ執行されていませんので、API経由で注文を変更することも可能です。

modify_order()により逆指値のレートを112.700円へ、さらに通貨単位を1万通貨へ変更しました。実際のトレードでは、状況に応じてプログラムでオープンオーダーを細かく調整していくことなどが有り得ますので覚えておくと便利です。

続いて取引中のオーダーを取得しましょう。私の口座には現在3件の「取引中」があります。こちらをAPIから取得して、Pandasのデータフレームに入れて出力してみましょう。

複雑なロジックや複数通貨に渡って取引をしていると「取引中」のオーダーが増えてきます。このようにシステム内でトレードの詳細を常に管理しておく必要が出てくるわけです。

基本操作その8 ポジションを管理しよう

先ほど確認したのは「トレード(注文)」の管理でしたが、次はポジションです。違いはトレードはあくまで注文ですので、幾らで何をどのような条件で注文したかの情報です。

対してポジションは今の相場に対して、どのトレードがどのくらい利益/損益を出しているの?を主に確認するものです。では、早速やってみましょう。

まずは口座全体のポジションを取得しましょう。

私の現在の口座はドル円しか注文していませんが、複数通貨の場合、全てのポジションが表示されます。avgPriceは保有しているポジションの平均レートです。

では全てのドル円のポジションを一括で決済してみましょう。

全て保持していたドル円のポジションが一括で決済されます。大雑把な処理ですので、あまり使う場面が少ないのでは?と最初は思っていたのですが、実はこれ意外と便利です。

基本操作その9 取引履歴を管理しよう

これは非常に重要なAPI操作です。口座の取引履歴をAPIから取得する方法ですが、プログラムでトレードをする際は特に重要になります。

では実際に取引履歴を取得してみましょう。

このようにトレードの詳細履歴の取得が可能です。get_transaction_history()ですがデフォルトで最新の50件のレコードを取得可能です。パラメータにcountを指定することで、最大500件まで取得が可能です。

当然ですが個別にIDを指定することで、トレードの詳細情報を取得するのも簡単です。やってみましょう。

次はいよいよAPI基本操作の最後です!

基本操作その10 レートのストリーミング

最後になりましたが、これまた基本かつとても重要なAPI操作です。機械学習では過去レートを大量に取得して、こねくりまわしてモデルに訓練して・・と言った流れが基本です。

モデルを訓練しては、テストをして評価をしながら精度を上げていき・・・さぁいよいよ本番で運用してみよう!という段階で必要なのがレートのストリーミングです。

ストリーミングですが、実際に使うときはもっと色々なことを考えながら操作しなくてはいけませんが、とりあえず基本操作ですので、まずはレートをシンプルにストリーミングしてみましょう。

まずはクラスを作ります。count=10とあるように、ストリーミングで10件単位で情報を取得します。

では実際にストリーミングを動かしてみましょう。

ご覧の通りレスポンスとしてレートのストリーミングがJSONフォーマットで戻ってきます。常に新しいレートが出た時点で出力されます。heatbeatとありますが、これはコネクションが繋がっていることを確認するために定期的に吐き出されます。(レートの変更が一定期間内とheatbeatが戻ってくる=コネクションが切れている訳ではないことが判る)

まとめと次の課題

今回の記事はOANDA API v1の知っておくべき10の基本操作をまとめました。いきなり自動売買のシステムをスクラッチで作るのは非常に手間がかかります。

まずは基本操作をしっかりと使いこなして、少しづつAPIでの操作に慣れていくことで、必要なロジックを追加しながらシステム全体を改善していくと進めやすいと思います。

今回はあくまで基本操作編でしたが、イベントの管理やポートフォリオの管理など、実際にPythonでトレードをするには、様々な実装が必要です。また機会があれば、応用編もまとめたいと思います。

以上となります!ブログ読んでいただきありがとうございます!Twitterでも色々と発信しているので、是非フォローお願いします!

【人気記事】

私の機械学習の開発環境&トレード環境

使っているFX会社はどこ?
自動売買用(1万円キャッシュバック中) → インヴァスト証券
Python API用(FX APIはここしかない) → OANDA ジャパン

FX API

Posted by algon