この記事を開いてくださったこと、心から感謝しています。プログラムから板情報を読みたいと考えている人も、きっと多いはずです。
結論から言うと、板情報を開いて更新の通知を受け取る準備をするのがMarketBookAdd、今の板の中身を配列に読み取るのがMarketBookGetです。役割が別で、どちらか一方だけを選ぶ関数ではありません。
また、失敗する理由や、テスターでの動きなど、確認した公式ページに書かれていない点もありました。その部分は、そのつど「記載なし」と書いています。
この記事では、MQL5公式リファレンスの説明をもとに、2つの関数の引数、戻り値、使う順番、注意点を整理します。なお、ここで扱うのはプログラムの仕組みの説明で、運用の助言ではありません。
MarketBookAddとMarketBookGetは、そもそも何が違うのか?
まずは、公式リファレンスに書かれている、2つの関数の基本の違いを整理します。名前は似ていますが、やることが違います。
MarketBookAddは、板情報を開いて購読を始める
MarketBookAddは、銘柄の名前を渡すと、その銘柄の板情報を開き、板が変わったときの通知を受け取る手続きをする関数です。戻り値は、成功ならtrue、失敗ならfalseです。
公式の説明では、ふつうはOnInitの中や、クラスのコンストラクタから呼びます。通知を受け取るには、EAの側にOnBookEventという関数を用意しておく必要があります。
- 板情報を開く
- 更新の通知の購読を始める
- OnInitなどから呼ぶのが基本
MarketBookGetは、板の中身を配列に読み取る
MarketBookGetは、銘柄の名前と、板情報の構造体の配列を渡すと、今の板の中身を配列に入れる関数です。戻り値は、成功ならtrue、失敗ならfalseです。
公式の説明では、板情報は、あらかじめMarketBookAddで開いておく必要があります。配列は、あらかじめ大きさを決めておいてもよく、動的配列なら端末が大きさを決めます。
- 今の板の中身を配列に入れる
- 事前に、MarketBookAddで開いておく
- 動的配列なら、端末が大きさを決める
2つを、表で比べる
公式の説明から読み取れる違いを、表にまとめます。選ぶときの目安として使ってください。
| 項目 | MarketBookAdd | MarketBookGet |
|---|---|---|
| 役割 | 板情報を開き、通知を購読する | 板の中身を配列に読み取る |
| 渡すもの | 銘柄の名前 | 銘柄の名前と配列 |
| 戻り値 | 成功はtrue、失敗はfalse | 成功はtrue、失敗はfalse |
| 呼ぶ場所の目安 | OnInitなど | OnBookEventなど |
| 失敗する理由 | 記載なし | 記載なし |
| テスターでの動き | 記載なし | 記載なし |
※公式の説明をもとにした、筆者の整理です。
MarketBookAddは、どんな場面で使うのか?
MarketBookAddは、板情報を使うプログラムの最初に、準備として呼ぶ関数です。公式の説明から、使い方と注意点を確認します。
通知を受け取るには、OnBookEventが必要になる
板が変わったことを知るには、OnBookEventという関数を、EAの側に書いておきます。引数には、通知が届いた銘柄の名前が入ります。
公式の説明では、この通知はチャート全体に届きます。同じチャートにある、OnBookEventを持つすべてのプログラムが受け取るので、銘柄の名前を確かめる処理が必要です。
- OnBookEventを、EAの側に書く
- 通知はチャート全体に届く
- 銘柄の名前を確かめる処理が必要
購読の回数は、銘柄ごと、チャートごとに数えられる
公式の説明では、購読の数は、銘柄ごと、チャートごとに数えられます。MarketBookAddを呼ぶと1増え、MarketBookReleaseを呼ぶと1減ります。
数が0より大きい間は、その銘柄の通知が届き続けます。MarketBookAddとMarketBookReleaseの回数は、プログラムの動いている間に、同じになるようにする、と説明されています。
| 操作 | 購読の数 |
|---|---|
| MarketBookAdd | 1増える |
| MarketBookRelease | 1減る |
| 数が0より大きい間 | 通知が届き続ける |
※公式の説明をもとにした、筆者の整理です。
失敗したときの原因は、記載がない
MarketBookAddがfalseを返す理由は、公式のページには書かれていません。銘柄が見つからない場合や、板情報がない場合なども、記載なしです。
公式サンプルは、失敗したときにエラーを表示していますが、エラーの番号を入れる場所が、表示の文にありません。サンプルを使うときは、自分で確かめて書き足しましょう。
- falseになる理由は、記載なし
- サンプルの表示には、エラー番号の場所がない
- 書き足して、自分で確かめる
MarketBookGetは、どんな場面で使うのか?
MarketBookGetは、板の中身を実際に読みたいときに呼ぶ関数です。公式の説明から、取れる情報を確認します。
配列の1件ごとに、種類、価格、数量が入る
配列の1件は、MqlBookInfoという構造体です。注文の種類、価格、数量、より細かい数量の4つの項目が入っています。構造体は、宣言なしで使えます。
| 項目 | 公式の説明 |
|---|---|
| type | 注文の種類 |
| price | 価格 |
| volume | 数量 |
| volume_real | より細かい数量 |
※公式の説明をもとにした、筆者の整理です。
注文の種類は、4つある
注文の種類は、4つです。売りの注文、買いの注文、成行の売り、成行の買いです。公式の説明では、それぞれ、売りは「提示」、買いは「買い気配」と書かれています。
- 売りの注文
- 買いの注文
- 成行の売りと、成行の買い
板情報は、一部の銘柄でしか使えない
公式には、板情報は、一部の銘柄でしか使えない、と書かれています。ただし、どの銘柄で使えるのかは、記載なしでした。
取れる段数の上限や、配列の並び順も、記載がありません。そのため、使う前に、自分の環境で、実際の配列を表示して確かめておくのが安心です。
- 使える銘柄は、一部だけ
- 段数の上限は、記載なし
- 並び順は、記載なし
2つの関数は、どんな順番で使うのか?
2つは、セットで使います。全体の流れを、順番に整理します。ティックを取り出す関数との違いは、CopyTicksとCopyTicksRangeの記事で整理しています。
OnInitで開き、OnBookEventで読み、OnDeinitで閉じる
最初に、OnInitで、MarketBookAddを呼びます。板が変わったら、OnBookEventで、MarketBookGetを呼んで、中身を読みます。終わるときは、OnDeinitで、MarketBookReleaseを呼んで閉じます。
公式サンプルは、この流れです。サンプルは、板の更新の回数を数えて、1秒あたりの回数を表示します。公式のページには、実際の回数は書かれていません。
- OnInitで、MarketBookAdd
- OnBookEventで、MarketBookGet
- OnDeinitで、MarketBookRelease
OnTickとは、別の通知である
OnBookEventは、価格のティックとは別の通知です。ティックの受け取りは、OnTickとOnTimerの記事で整理しています。板が変わっても、ティックが来るとは限りません。
公式の説明では、OnBookEventの通知は、取りこぼされず、前の処理が終わっていなくても、順番を待って届く、と書かれています。待ち行列の上限は、記載なしです。
- ティックとは別の通知
- 通知は、取りこぼされない
- 待ち行列の上限は、記載なし
MarketBookGetだけを、先に呼んだときは、記載がない
MarketBookAddを呼ばずに、MarketBookGetを呼んだときの戻り値は、公式のページには書かれていません。開いておく必要がある、という説明があるだけです。
- 戻り値は、記載なし
- 必ず、先にMarketBookAddを呼ぶ
- まず、小さく試して確かめる
どう使い分ければよいのか?
2つは、どちらかを選ぶ関数ではなく、順番に使う関数です。それぞれの役割を、整理します。
板情報を使い始めるなら、MarketBookAddを呼ぶ
板情報を使うプログラムを作るなら、まず、MarketBookAddを呼びます。ここで開いて購読しておかないと、板の中身も、更新の通知も、受け取れません。
FX口座・ツールの比較一覧もあわせて確認してみてください。
板の中身を読みたいなら、MarketBookGetを呼ぶ
板の中身を、価格と数量で見たいときは、MarketBookGetを呼びます。通知が届いたときに呼ぶと、変わったあとの板を読めます。
- 今の板の中身を読みたい
- 価格と数量を、配列で見たい
- 通知が届いたときに呼ぶ
どちらも、テスターでの動きは記載がない
公式のページには、ストラテジーテスターでの動きは、書かれていません。更新の頻度や、1回で取れる段数の上限も、記載なしです。
- テスターでの動きは、記載なし
- 更新の頻度は、記載なし
- 段数の上限は、記載なし
実際に使うとき、どんな順番で進めればよいのか?
最後に、確認の順番を整理します。まずは、スクリプトで、小さく試すのが安心です。
まずは、スクリプトで開いて閉じてみる
最初は、スクリプトで、MarketBookAddを呼び、少し待って、MarketBookReleaseで閉じます。公式サンプルも、この流れです。戻り値を、ログで確かめましょう。
- MarketBookAddで開く
- 少し待つ
- MarketBookReleaseで閉じる
次に、中身を表示してみる
次に、MarketBookGetで、配列を取って、1件ずつ、価格、数量、種類を表示します。並び順や、段数が、自分の環境でどうなるかを、目で確かめます。
- 配列の件数を、確かめる
- 価格と数量を、表示する
- 並び順を、目で確かめる
最後に、閉じ忘れがないかを確かめる
開いたら、必ず閉じることが大切です。公式の説明でも、各プログラムは、自分で開いたぶんを閉じる、と書かれています。









- 開いたら、必ず閉じる
- 通知では、銘柄の名前を確かめる
- 記載なしの点は、小さく試す
よくある質問にはどんなものがあるのか?
始める前に、多くの人が気になる疑問を短くまとめます。
MarketBookReleaseは、必要なのか?
公式の説明では、開いた板情報は、MarketBookReleaseで閉じます。ふつうは、OnDeinitで呼びます。呼ばなかった場合の動きは、記載なしです。
- 開いたら、閉じるのが基本
- 呼ばなかったときの動きは、記載なし
どの銘柄でも、使えるのか?
いいえ、公式には、一部の銘柄でしか使えない、と書かれています。使える銘柄の一覧は、記載なしでした。
- 一部の銘柄だけで使える
- 一覧は、記載なし
この記事の例は、実際の結果なのか?
いいえ、公式サンプルの内容と、筆者が整理した説明です。実際の動きや、将来の結果を示すものではありません。
- 公式サンプルの内容をもとにした説明
- 実際の動きとは異なる場合がある
まとめ:「MQL5のMarketBookAddとMarketBookGet、板情報の購読を始めて更新の知らせを受け取れる準備の確かさと今の板の中身をそのまま配列で読める手軽さどっちを選ぶ?」
開いて購読を始めるのがMarketBookAdd、中身を読むのがMarketBookGetです。どちらも、記載のない点は自分の環境で確かめてから使いましょう。
仕組みが分かると、コードを書くのが少しずつ楽しくなっていきます。この記事が、あなたの毎日に少しでも余裕と安心を運ぶきっかけになれば、心から嬉しく思います。
出典・参照元
※本ページに掲載している口コミ・体験談は、特定の個人を特定できないよう配慮しており、ウェブサイトおよびSNS上の公開情報をもとに編集しています。個人の体験に基づく情報であり、すべての方に同じ効果や変化が生じることを保証するものではありません。料金・サービス内容は変更される場合があるため、最新情報は必ず公式サイトでご確認ください。










