１．はじめに

２．リリース＆改定情報

３．ご利用方法

４．ご利用にあたって

５．マニュアル

６．サンプルプログラム

７．その他

はじめに

１．目的
　このページは立花証券・ｅ支店システム（以下ｅ支店と呼ぶ）のアプリケーションプログラミングインタフェース（以下ＡＰＩと呼ぶ）専用ページです。
　本ＡＰＩを利用することでご自分で作成したプログラムでｅ支店に注文発注ができます。
　例えば、ご自分で注文受発注用のロボットプログラム等を開発し、プログラムから注文受発注を行うことが可能となります。
　従来ブラウザでご利用いただいておりますｅ支店・ＰＣブラウザ画面（以下ｅ支店・標準Ｗｅｂと呼ぶ）操作による注文受発注機能を
　本ＡＰＩを利用しプログラムにて行うことが可能となります。

２．特徴
　本ＡＰＩの特徴としては、通常の要求＆応答方式のＡＰＩ（以下 REQUEST I/F と呼ぶ）とは別に、
　リアルタイム株価ボードシステムの開発で培ったノウハウを利用し
　注文約定等通知データをリアルタイム配信するＡＰＩ（以下 EVENT I/F と呼ぶ）を合わせて兼ね備えている点です。

　従来よくある REQUEST I/F のみのＡＰＩの場合、
　注文入力後に注文照会を何度も呼び出すことで約定したかどうかを確認する（ポーリング方式）必要があるめ
　利用するにも手間がかかる上、システム的にも負荷がかかり、利用者もＡＰＩ提供側にも使いにくいＡＰＩでした。

　本ＡＰＩではポーリング方式の欠点を克服するため導入した EVENT I/F を利用することで、
　毎回ＡＰＩを呼び出す（ポーリングする）ことなく
　ｅ支店システムから約定等通知をリアルタイム（イベント方式）で受信し
　市場での約定等状態をいち早くプログラムで検知することが可能になります。

３．概要
　本ＡＰＩはインターネット経由でｅ支店システムのＷｅｂサーバに接続することで利用できます。
　（１）認証 I/F
　　・プロトコル　：HTTPS GET
　　・データ形式　：JSON
　　・日本語コード：ShiftJIS
　（２）REQUEST I/F
　　・プロトコル　：HTTPS GET
　　・データ形式　：JSON
　　・日本語コード：ShiftJIS
　（３）EVENT I/F
　　・プロトコル　：HTTPS GET (Chunk Responce)
　　・データ形式　：専用形式
　　・日本語コード：ShiftJIS

４．提供機能
　本ＡＰＩでは以下機能を提供します。
　（１）認証機能（認証 I/F）
　　・ログイン
　　・ログアウト
　（２）業務機能（REQUEST I/F）
　　・株式新規注文
　　・株式訂正注文
　　・株式取消注文（含む一括取消）
　　・現物保有銘柄一覧
　　・信用建玉一覧
　　・買余力
　　・建余力＆本日維持率
　　・売却可能数量
　　・注文一覧
　　・注文約定一覧（詳細）
　　・可能額サマリー
　　・可能額推移
　　・現物株式買付可能額詳細
　　・信用新規建て可能額詳細
　　・リアル保証金率
　（３）マスタ機能（MASTER I/F）
　　・マスタ情報ダウンロード
　　　（
　　　　・システムステータス
　　　　・日付情報
　　　　・呼値
　　　　・運用ステータス別状態
　　　　・運用ステータス（株式）
　　　　・運用運用ステータス（派生）
　　　　・株式銘柄マスタ
　　　　・株式銘柄市場マスタ
　　　　・株式銘柄別・市場別規制
　　　　・先物銘柄マスタ
　　　　・オプション銘柄マスタ
　　　　・派生銘柄別・市場別規制
　　　　・代用掛目
　　　　・保証金マスタ
　　　　・取引所エラー等理由コード
　　　）
　　・マスタ情報問合取得
　　　（
　　　　・日付情報
　　　　・株式銘柄マスタ
　　　　・株式銘柄市場マスタ
　　　　・先物銘柄マスタ
　　　　・オプション銘柄マスタ
　　　　・その他（指数等）銘柄マスタ
　　　　・取引所エラー等理由コード
　　　）
　　・ニュースヘッダー問合取得
　　・ニュースボディー問合取得
　（４）時価情報機能（PRICE I/F）
　　・時価情報問合取得
　　・蓄積情報問合取得
　（５）注文約定通知機能（EVENT I/F）
　　・注文約定等通知
　　・ｅ支店システム、システムステータス（開局、閉局等）
　　・ｅ支店システム、運用ステータス（注文受付開始、終了等）
　　・リアルタイム株価ボード・時価
　　・リアルタイム株価ボード・ニュース

戻る リリース＆改定情報

※リリース後の旧バージョン運用ルールについては５．マニュアル、１．共通説明を参照。

2023.07.22 ｅ支店・ＡＰＩ（ｖ４ｒ４）リリース
　　　　　　１．下記仕様追加変更版をｖ４ｒ４としてリリース。
　　　　　　　　JSON 文字列の引数項目追加のためサンプルプログラム mfds_json_api_compress_v4r4.js を改定。

　　　　　　２．ニュース問合取得Ｉ／Ｆ追加。
　　　　　　　　・ニュースヘッダー問合取得I/F(CLMMfdsGetNewsHead)
　　　　　　　　・ニュースボディー問合取得I/F(CLMMfdsGetNewsBody)
　　　　　　　　利用方法については、
　　　　　　　　・別紙「立花証券・ｅ支店・ＡＰＩ、インタフェース概要（ｖ４ｒ４）「３−４−２．マスタ情報問合取得」
　　　　　　　　・別紙「ｅ支店・ＡＰＩ、ブラウザからの利用方法（ｖ４ｒ４）」「ニュース」シート
　　　　　　　　参照。

　　　　　　３．マスタダウンローﾄﾞ機能仕様変更。
　　　　　　　　（１）株式銘柄マスタダウンロード、以下該当レコードを対象から除外。
　　　　　　　　　　・場外（株式銘柄マスタ．　　優先市場コード：09）
　　　　　　　　　　・場外（株式銘柄市場マスタ．上場市場コード：09）
　　　　　　　　（２）株式銘柄市場マスタダウンロード、以下該当レコードを対象から除外。
　　　　　　　　　　・場外（株式銘柄市場マスタ．上場市場コード：09）
　　　　　　　　（３）先物銘柄マスタダウンロード、以下該当レコードを対象から除外。
　　　　　　　　　　・限月超過（限月（YYYYMM）＜営業日（YYYYMM））
　　　　　　　　（４）オプション銘柄マスタダウンロード、以下該当レコードを対象から除外。
　　　　　　　　　　・限月超過（限月（YYYYMM）＜営業日（YYYYMM））
　　　　　　　　※本仕様変更は基幹システムの仕様変更のため
　　　　　　　　　ｅ支店・ＡＰＩの全バージョンが上記仕様となりますのでご注意ください。

　　　　　　　　以下マニュアルを改定。
　　　　　　　　・「立花証券・ｅ支店・ＡＰＩ（ｖ４ｒ４）、REQUEST I/F、マスタデータ利用方法」（改定日:2023.07.22参照）

　　　　　　※上記改定対象外マニュアルにつきましては従来通り
　　　　　　　マニュアルページにありますｖ４ｒ「２３」用各資料をご利用願います。

2023.05.20 ｅ支店・ＡＰＩ（ｖ４ｒ３）保守リリース
　　　　　　マスタダウンローﾄﾞ機能、銘柄マスタ_株、銘柄市場マスタ_株の仕様変更。
　　　　　　１．銘柄マスタ_株の優先市場が東証以外の以下項目を廃止（""で応答）。
　　　　　　　・代用証券評価単価
　　　　　　２．銘柄市場マスタ_株の上場市場が東証以外の以下項目を廃止（""で応答）。
　　　　　　　・値幅下限
　　　　　　　・値幅上限
　　　　　　　・前日終値

2023.04.01 ｅ支店・ＡＰＩ（ｖ４ｒ２）廃止
　　　　　　現行リリースのｅ支店・ＡＰＩ（ｖ４ｒ３）をご利用ください。

2022.11.19 ｅ支店・ＡＰＩ（ｖ４ｒ３）、リリース、（ｖ４ｒ１）廃止
　　　　　　立花証券側サーバ処理キャパシティ向上のための仕様（仮想URL(MASTER）、仮想URL(PRICE））追加を実施。
　　　　　　仮想URL については、別紙「立花証券・ｅ支店・ＡＰＩ、インタフェース概要（ｖ４ｒ３）」参照。

　　　　　　サンプルプログラムページの各サンプルプログラムを最新バージョンに対応し公開。
　　　　　　JSON 文字列の引数項目追加のためサンプルプログラム mfds_json_api_compress_v4r3.js を改定。

　　　　　　時価情報問合取得I/F(CLMMfdsGetMarketPrice)の銘柄指定最大数上限を１２０に制限実施。
　　　　　　時価情報問合取得I/F については、別紙「ｅ支店・ＡＰＩ、ブラウザからの利用方法（ｖ４ｒ３）」の「時価」シート修正。

　　　　　　蓄積情報問合取得I/F(CLMMfdsGetMarketPriceHistory)を追加。
　　　　　　指定銘柄の過去（最大約２０年前）〜前日営業日までの４本値、出来高（ｘ株式分割修正あり、なし）の各値
　　　　　　及び、株式分割日は分割前後の単位数と換算係数が取得できます。
　　　　　　蓄積情報問合取得I/F については、別紙「ｅ支店・ＡＰＩ、ブラウザからの利用方法（ｖ４ｒ３）」の「時価」シート修正。

2022.09.21 デモ環境公開
　　　　　　デモ環境のご利用が可能になりました。
　　　　　　デモ環境のアクセス先ＵＲＬにつきましては「５．マニュアル」を参照願います。
　　　　　　デモ環境のご利用方法（本番環境との違い、稼働時間帯、注意点等）につきましては
　　　　　　ｅ支店ホームページ「こちら」を参照願います。

2022.09.03 ｅ支店・ＡＰＩ（ｖ４ｒ２）、注文一括取消機能追加対応
　　　　　　注文一括取消機能追加に伴う以下マニュアル追記修正。
　　　　　　・「立花証券・ｅ支店・ＡＰＩ（ｖ４ｒ２）、REQUEST I/F、機能毎引数項目仕様」（改定日:2022.08.19参照）
　　　　　　・「立花証券・ｅ支店・ＡＰＩ（ｖ４ｒ２）、REQUEST I/F、注文入力機能引数項目仕様」（改定日:2022.08.19参照）
　　　　　　保守に伴う以下マニュアル修正。
　　　　　　・「立花証券・ｅ支店・ＡＰＩ、EVENT I/F 利用方法、データ仕様」（改定日:2022.07.ox参照）

2022.06.06 ｅ支店・ＡＰＩ（ｖ４ｒ２）、東証障害時対応
　　　　　　・「立花証券・ｅ支店・ＡＰＩ（ｖ４）、REQUEST I/F、機能毎引数項目仕様」（改定日:2022.06.03参照）
　　　　　　・「立花証券・ｅ支店・ＡＰＩ、REQUEST I/F、マスタデータ利用方法」（改定日:2022.04.15参照）

2022.04.02 ｅ支店・ＡＰＩ（ｖ４ｒ２）、東証再編対応
　　　　　　東証再編に伴い以下マニュアルの所属部関連項目名称を修正。
　　　　　　・「立花証券・ｅ支店・ＡＰＩ、EVENT I/F 利用方法、データ仕様」
　　　　　　・「立花証券・ｅ支店・ＡＰＩ（ｖ４）、REQUEST I/F、機能毎引数項目仕様」
　　　　　　・「立花証券・ｅ支店・ＡＰＩ、REQUEST I/F、マスタデータ利用方法」
　　　　　　・「ｅ支店・ＡＰＩ、ブラウザからの利用方法」の「時価配信」シートに時価配信情報取得編を公開。

2021.10.15 ｅ支店・ＡＰＩ（ｖ４ｒ２）、EXECL(VBA) 利用サンプル公開
　　　　　　マニュアルページに 「（６）EXCEL(VBA) からの利用方法」を追記。
　　　　　　時価情報取得 EXCEL サンプルプログラムを公開。

2021.06.27 ｅ支店・ＡＰＩ（ｖ４ｒ２）、リリース、（ｖ４）廃止
　　　　　　要求．送信日時（p_sd_date）による遅延チェック機能を修正。
　　　　　　「立花証券・ｅ支店・ＡＰＩ（ｖ４ｒ２）、REQUEST I/F、利用方法、データ仕様」参照。

　　　　　　REQUEST I/F に時価関連情報取得用Ｉ／Ｆ（CLMMfdsGetMasterData, CLMMfdsGetMarketPrice）を追加。
　　　　　　マニュアル「ｅ支店・ＡＰＩ、ブラウザからの利用方法」の「時価」シートに時価関連情報取得編を公開。

　　　　　　JSON 文字列の引数項目追加のためサンプルプログラム mfds_json_api_compress_v4r2.js を改定。
　　　　　　サンプルプログラムに時価情報取得表示を新規公開。

2021.04.25 ｅ支店・ＡＰＩ、デモ環境リリース
　　　　　　本ＡＰＩテスト環境としてｅ支店・デモ環境を利用した専用環境（専用ＵＲＬ）を公開（「５．マニュアル」参照）。
　　　　　　ｅ支店・デモ環境のご利用方法（ユーザID、暗証番号、ご利用時間等）につきましては、
　　　　　　ｅ支店・推奨環境とツール「デモ環境のご案内」記載の各項目を参照願います。

2021.02.13 ｅ支店・ＡＰＩ（ｖ４ｒ１）、リリース
　　　　　　要求．送信日時（p_sd_date）による遅延チェック機能を追加。
　　　　　　オプション項目、要求．応答データフォーマット指定（sJsonOfmt）に引数項目名で応答する指定を追加。
　　　　　　「立花証券・ｅ支店・ＡＰＩ（ｖ４ｒ１）、REQUEST I/F、利用方法、データ仕様」参照。
　　　　　　JSON 文字列の引数項目追加のためサンプルプログラム mfds_json_api_compress_v4r1.js を改定。

2020.11.22 ｅ支店・ＡＰＩ、ｖ３系廃止
　　　　　　保守効率アップのため、今後の機能追加などについてｖ４系に統一。
　　　　　　マニュアル「ｅ支店・ＡＰＩ、ブラウザからの利用方法」を公開。

2020.10.24 ｅ支店・ＡＰＩ（ｖ４）、リリース
　　　　　　要求重複チェックを送信日時（p_sd_date）から送信通番（p_no）に仕様変更。
　　　　　　JSON 文字列の引数項目追加のためサンプルプログラム mfds_json_api_compress_v4.js を改定。

2020.09.26 ｅ支店・ＡＰＩ（ｖ３ｒ３）、リリース（2020.11.22 廃止）
　　　　　　注文入力Ｉ／Ｆの引数見直し（整理作業）を実施しマニュアルを改定。

2020.09.26 ｅ支店・ＡＰＩ（ｖ３ｒ２）、リリース（2020.11.22 廃止）
　　　　　　JSON 文字列の引数項目追加対応。

2020.08.21 ｅ支店・ＡＰＩ（ｖ３）、リリース（2020.11.22 廃止）
　　　　　　APACHE mod_deflate 機能による application/json, text/json の応答圧縮機能を追加。

2020.07.25 ｅ支店・ＡＰＩ（ｖ２）、リリース（2020.08.21 廃止）

2020.07.14 立花証券・ｅ支店・ＡＰＩ専用ページ（本ページ）開発

2020.07.13 ｅ支店・ＡＰＩ（ｖ２）（公開バージョン）開発

2020.06.29 ｅ支店・ＡＰＩ（ｖ１）（実験バージョン）開発

戻る ご利用方法

１．認証機能（認証 I/F）
　　認証用ＵＲＬへｅ支店口座のログインＩＤ、パスワードを指定し認証要求を送信し結果を応答で受信します。
　　応答が正常の場合、４種類の仮想ＵＲＬ（REQUEST、MASTER、PRICE、EVENT）を返します。
　　応答がエラーの場合はエラーコードにより理由を判断します。
　　※各種書面（金商法交付書面等）が未読の場合、応答が正常でも仮想ＵＲＬが発行されない（ｅ支店・ＡＰＩが利用できない）ため
　　　標準Ｗｅｂにて既読操作をお願いいたします。

２．業務機能（REQUEST I/F）
　　本機能を利用する場合１．で取得した仮想ＵＲＬ（REQUEST）へ該当要求を送信し結果を応答で受信します。
　　※REQUEST I/F は一問一答（要求送信後応答を待ち次の要求を送信する）方式（利用者側での使い方に対する制限）となります。
　　※HTTP プロトコルを利用したインタフェースであるため、使い方により同時並列に要求は出せてしまいますが、
　　　その場合の動作保証はできませんのでご注意下さい（ただし、３．（１）マスタ情報ダウンロードについては並列利用可能です）。
　　※以下各機能も３．（１）マスタ情報ダウンロードを除き基本同様です。

３．マスタ機能（REQUEST I/F）
　　本機能を利用する場合１．で取得した仮想ＵＲＬ（MASTER）へ該当要求を送信し結果を応答で受信します。
　　マスタ機能には以下機能があり利用方法が異なります。
　　・マスタ情報ダウンロード
　　・マスタ情報問合取得
　　弊社で発注可能な銘柄情報や各種規制情報、値幅情報等発注機能に関する各種付帯情報など
　　お客様が発注用アプリケーション等を構築され時に、予め入力チェック等に必要な情報の取得が本機能でできます。
　　※入力チェック等については本ＡＰＩの注文入力各機能で実装のため、お客様のプログラムにてチェック機能の実装無しでも
　　　本システムによりチェックを行いますが、本情報の取得により事前にお客様プログラムにてチェックすることも可能です。

　　（１）マスタ情報ダウンロード
　　　　本機能は通常の要求〜応答による手順とは異なり、要求後はダウンロード終了の通知まで
　　　　初期ダウンロードデータとして各種情報をレコード単位で通知します。
　　　　ダウンロード終了後は日中、弊社基幹システムで更新があった場合、該当情報を更新情報としてレコード単位で通知します。
　　　　※別紙「立花証券・ｅ支店・ＡＰＩ、インタフェース概要（ｖ４ｒ４）「３−４−１．マスタ情報ダウンロード」参照。
　　　　※マスタ情報ダウンロードはお客様の通信環境にもよりますが、弊社本番環境（社内からのアクセス）での計測では
　　　　　約４０秒くらいの時間がかかります。

　　（２）マスタ情報問合取得
　　　　本機能は取得対象のマスタ及び項目を指定し該当要求を送信し結果を応答で受信します。
　　　　※取得したい情報のみを指定し要求応答形式で取得できるため、取得時間短縮や保持リソースを必要な項目のみに抑えられます。

４．時価情報機能（REQUEST I/F）
　　本機能を利用する場合１．で取得した仮想ＵＲＬ（PRICE）へ該当要求を送信し結果を応答で受信します。
　　具体的には銘柄コード及び時価情報項目を複数指定することで、該当情報を問合取得することができます。
　　１要求では最大１２０までの銘柄コードが指定できます。
　　また指定取得できる時価情報項目は株価ボード・ＰＣ画面に表示している各項目になります。

５．注文約定通知機能（EVENT I/F）
　　本機能を利用する場合１．で取得した仮想ＵＲＬ（EVENT）へ該当要求を送信します。
　　その後はｅ支店システムとの接続を維持したまま受信待ちとし、ｅ支店システムから通知データが送信される都度該当データを受信します。
　　※本Ｉ／Ｆは配信専用であるため、利用者側がデータを受信しない場合、ｅ支店システムは送信できるまで待つ仕様です。
　　　通知受信に関してはインターネットの経路、及び受信するハード性能に依存します（俗に言うところのベストエフォート送信です）。
　　※REQUEST I/F で注文入力要求、応答の送受信をした後 EVENT I/F でｅ支店システムからの注文受付等各種通知を送信する
　　　シーケンスですが、ｅ支店システムからお客様プログラムまでの間の通信環境やお客様プログラムの処理の都合により、
　　　応答や通知を受信または処理する順番が逆になるケースが想定されますのでご注意ください。
　　※e支店・ＡＰＩ（ｖ３ｒ２）よりリアルタイム株価ボードの時価通知機能をサポート（公開）致しましたが、
　　　時価については間引き処理をしています。
　　　また、お客様の通信環境等によりデータ受信が遅延する（時価が遅れて受信される）場合がありますので
　　　予めご注意願います。

６．仮想ＵＲＬについて
　　本ＡＰＩ利用時は認証し仮想ＵＲＬを取得する必要があります。
　　仮想ＵＲＬはｅ支店システムで生成するｅ支店システム内でユニーク（重複しない）となります。
　　仮想ＵＲＬは認証後毎回新たに作成すると共に、その時点で先認証で作成した仮想ＵＲＬは無効とします（１顧客１仮想ＵＲＬ）。
　　仮想ＵＲＬが無効になるタイミングは以下です。
　　・多重認証
　　・ログアウト
　　・ｅ支店システム閉局
　　仮想ＵＲＬは無効になると、それ以降ご利用でき（再度有効になり）ません。
　　無効となった仮想ＵＲＬに要求した場合、応答でエラーを返します。

　　仮想ＵＲＬは認証時、機能毎に４種類（仮想ＵＲＬ（REQUEST、MASTER、PRICE、EVENT））取得します。
　　仮想ＵＲＬ REQUEST, MASTER, PRICE は REQUEST I/F（プロトコル）、EVENT は EVENT I/F（プロトコル）で通信を行います。
　　REQUEST I/F と EVENT I/F は同時に（並列）利用できますが、無効化タイミングは同時です。

　　本ＡＰＩは HTTP プロトコル でインタフェースする性質上、
　　仮想ＵＲＬへのアクセスは通常のインターネットページの表示と同様、同時並列に要求を送信可能なインタフェースとなっています。
　　そのインタフェースは照会系機能についての性質であり、サーバへデータを入力する機能については顧客毎にシリアル処理（異なる性質の処理）のため
　　REQUEST I/F は一問一答（要求送信後応答を待ち次の要求を送信する）方式（利用者側での使い方に対する制限）となります。

　　またブラウザ等での自動再送処理等による同要求重複送信をｅ支店システム（受信側）で回避するため、要求データに設定する送信通番を
　　前受信要求．送信通番＞＝今受信要求．送信通番の場合、処理せずエラー応答を返します。

　　EVENT I/F は常時接続利用のため１要求のみ受け付け、先要求は自動で切断します（後要求勝ち）。

　　仮想ＵＲＬはログアウト等で無効化しない場合、最終的にｅ支店システム閉局時までｅ支店システム内で有効な状態として維持します。
　　仮想ＵＲＬを通して注文受発注を行うため、セキュリティ強化を考える場合、認証し必要機能を実施した後、ログアウトすることで
　　仮想ＵＲＬを無効化し、クライアントとｅ支店間のつながり（セッション）を無くすことができます（お客様の利用方法依存のため任意です）。
　　仮想ＲＵＬは意味のない（目で見える）文字列であり、該当文字については決まったフォーマット仕様はありません（任意で仕様が変わります）。

７．利用時間について
　　利用時間はｅ支店システムの稼働時間帯です。
　　ｅ支店システムの保守や障害等発生時は、ｅ支店・標準Ｗｅｂ同様本ＡＰＩもご利用頂けません。
　　本ＡＰＩはｅ支店システムのサブシステムであるため、ｅ支店システムが通常稼働していても
　　本ＡＰＩ用サブシステムが障害発生時はご利用頂けません。
　　このケースの場合、本ＡＰＩで発注した注文についてはｅ支店・標準Ｗｅｂの注文等照会機能によりご確認をお願いいたします。
　　また、その後の注文についての処理（訂正、取消など）についてはｅ支店・標準Ｗｅｂをご利用ください。

８．セキュリティー
　　本ＡＰＩ はインターネット経由でｅ支店口座をお持ちの全てのお客様向けにリリースを想定した機能です。
　　セキュリティー確保の意味ではｅ支店・標準Ｗｅｂ同様 SSL 通信の範囲となります。
　　本ＡＰＩはソフトウエア的に暗号化や圧縮機能は現バージョンでは持っていません。
　　※バージョン（ｖ３）以降は APACHE mod_deflate 機能による application/json, text/json の応答圧縮機能を追加。
　　ご利用にあたりお客様のｅ支店口座のログイン、パスワードによる認証が唯一のセキュリティとなります。
　　本ＡＰＩではそれらを変更する機能はありませんので、変更時はｅ支店・標準Ｗｅｂの操作で実行をお願いいたします。
　　本ＡＰＩはインターネット経由での接続を公開しお客様の責任でご利用頂くインタフェースです。
　　インターネット上に流れる情報についてはインターネット上に公開される（インターネット上に情報が流れるため
　　物理的にはその経路上で他人に見られる可能がある）前提でご利用をお願いいたします。
　　※これは暗号化しても圧縮しても解読に時間がかかるかどうかの問題であり、インターネット上に情報を流したら見えてしまう性質上の問題です。

戻る ご利用にあたって

１．本ＡＰＩのご利用にはｅ支店の口座開設が必要となります。

２．ｅ支店の口座開設後、ｅ支店・標準Ｗｅｂにログイン頂いた後に以下操作が必要になります。
　　　・各種書面（金商法交付書面等）の確認。
　　各種書面が未読の場合、ｅ支店・標準Ｗｅｂがご利用頂けないのと同様、本ＡＰＩもご利用頂けません。

　　本ＡＰＩの機能はｅ支店・標準Ｗｅｂの一部機能について、
　　お客様の画面操作に代わり、お客様が開発したプログラムからｅ支店・標準Ｗｅｂの機能を実行するものです。

　　そのため、本ＡＰＩのご利用はｅ支店・標準Ｗｅｂで上記確認を実施頂くことにより
　　本ＡＰＩを含むｅ支店のご利用によるリスクを全て許容して頂くことが前提となります。

　　また、各種書面については追加変更がありますので、その都度ｅ支店・標準Ｗｅｂにてご確認（許容）頂く必要があります。

３．新規、訂正、取消等の各注文入力機能には第二暗証番号が必要となります。
　　ｅ支店・標準Ｗｅｂ・お客様情報画面、第二暗証番号・暗証番号省略設定の有効、無効に関わらず
　　本ＡＰＩの各注文入力機能には第二暗証番号の引数設定が必須となります。

４．インサイダー申告頂きました銘柄につきましては本ＡＰＩからの新規注文入力機能、訂正注文入力機能はご利用頂けません。
　　ただし、取消注文入力機能については緊急性を考慮しご利用頂けるよう対処しております。
　　インサイダー申告銘柄の新規及び訂正注文入力につきましてはｅ支店・標準Ｗｅｂからのご利用をお願いいたします。

５．本ＡＰＩはお客様が（ご自身で）作成されたプログラムからの利用を想定したインタフェース（機能）の提供を目的としています。
　　そのため、各種注文入力機能等につきましてはｅ支店・標準Ｗｅｂの各種注文入力機能等にあります入力内容確認機能は
　　本ＡＰＩを利用するお客様側のプログラムで実施する前提で、お客様の確認後の入力内容を本ＡＰＩを通して入力頂くことになります。

　　本ＡＰＩを通して入力頂いた注文入力内容は弊社業務システムで必要な業務チェックをした後、
　　問題ない場合はそのまま市場へ取り次ぎ（発注）を行います。

６．当社システムのご利用に際し過負荷であると当社が判断した場合、口座利用を停止させて頂く場合がございます。

７．当社提供情報のご利用については当社規定の範囲内でご利用ください。

８．本ＨＰのマニュアル、及びサンプルプログラムを参照並びに解析頂きご利用ください。
　　本ＡＰＩのご利用に限らず、
　　一般的にＡＰＩと呼ばれるアプリケーションプログラミングインタフェースをご利用する観点での話にはなりますが、
　　一般的にＡＰＩを利用するには、システム開発経験（ＨＴＴＰ及びＪＳＯＮに関する知識、インターネット経由での
　　通信プログラム作成経験や開発能力）等、一定上の開発能力が必要であり、
　　本ＡＰＩのサンプルプログラム、及びマニュアルを見て開発できる力量、技量が必要となりますので予めご留意願います。

９．流量制限
　　本ＡＰＩを各お客様に対し一律安全にご利用頂くため、お客様からの要求受付に対し流量制限（秒１０件）をしております。

戻る マニュアル

１．共通説明
　（１）ｅ支店・ＡＰＩ専用ＵＲＬ
　　　https://kabuka.e-shiten.jp/e_api_v4r4/　　 （本番環境、最新バージョン）
　　　https://demo-kabuka.e-shiten.jp/e_api_v4r4/（デモ環境、最新バージョン）

　　　※現在リリースのバージョンはｅ支店・ＡＰＩ（ｖ４ｒ４）です。
　　　※保守や機能追加等によりＵＲＬのＰｒｅｆｉｘ（e_api_v4r4 部分）を e_api_v4r5（リビジョンＮ）または
　　　　e_api_v5（バージョンＮ）として平行リリースします。
　　　※後続版の平行リリース後６０日前後（リリースは非営業日に実施のため）で旧リリース版の利用を停止（廃止）しますので、
　　　　後続版リリース後はお早めにお客様プログラムの後続版への対応をお願いいたします。
　　　※後続版リリース等の連絡は本ページ・リリース＆改定情報にてお知らせするため、該当ページを定期的に参照願います。

　　　【デモ環境】
　　　　お客様のテスト環境としてｅ支店・デモ環境に専用環境を用意いたしました。
　　　　ご利用時間帯等につきましてはこちらを参照願います。

　（２）インタフェース概要
　　　まず最初にこちらで本ＡＰＩの概要や構成についてご理解頂き、各マニュアルをお読みください。
　　　別紙「立花証券・ｅ支店・ＡＰＩ、インタフェース概要（ｖ４ｒ４）」参照。

　（３）ブラウザからの利用方法
　　　プログラム開発前にとりあえずｅ支店・ＡＰＩをブラウザで試して見たい方は以下方法で試せます。
　　　別紙「ｅ支店・ＡＰＩ、ブラウザからの利用方法」参照。
　　　「基本」シート・・・・・・・・認証、注文入力、注文一覧
　　　「マスタ・時価」シート・・・・マスタ情報問合取得、 時価情報問合取得
　　　「時価配信」・・・・・・・・・EVENT I/F を利用した時価情報配信機能の利用方法
　　　「ニュース」・・・・・・・・・ニュース問合取得
　　　について記載しています。

　（４）業務機能、マスタ機能（仮想ＵＲＬ（REQUEST, MASTER））
　　　※１参照。

　（５）注文約定通知（仮想ＵＲＬ（EVENT））
　　　別紙「立花証券・ｅ支店・ＡＰＩ、EVENT I/F 利用方法、データ仕様」参照。
　　　※時価（EVENT I/F 利用時）についてはこちらを参照。

　（６）EXCEL(VBA) からの利用方法
　　　EXCEL(VBA) からｅ支店・ＡＰＩをご利用頂くためのサンプルモジュール（e_api.bas）及び
　　　それを使用した EXCEL サンプルプログラム で時価情報を取得することができます。
　　　ご利用方法等は EXCEL サンプルプログラム（シート記載内容）を御覧下さい。


２．各機能Ｉ／Ｆ説明

　（１）ログイン（認証）
　　　ＵＲＬ：
　　　　ｅ支店・ＡＰＩ専用ＵＲＬ/auth/

　　　ＪＳＯＮ引数項目：
　　　　{
　　　　　"p_no":"1",
　　　　　"p_sd_date":"2020.07.01-10:00:00.000",
　　　　　"sCLMID":"CLMAuthLoginRequest",
　　　　　"sUserId":"login-id",
　　　　　"sPassword":"pswd"
　　　　}

　　　要求例：
　　　　専用ＵＲＬ/auth/?{"p_no":"1","p_sd_date":"2020.07.01-10:00:00.000","sCLMID":"CLMAuthLoginRequest","sUserId":"login-id","sPassword":"pswd"}

　　　応答例：
　　　　{
　　　　　"p_no":"1",
　　　　　"p_sd_date":"2020.07.01-10:00:00.050",
　　　　　"p_rv_date":"2020.07.01-10:00:00.000",
　　　　　"p_errno":"0",
　　　　　"p_err":"",
　　　　　"sCLMID":"CLMAuthLoginAck",
　　　　　"sResultCode":"0",
　　　　　"sResultText":"",
　　　　　.
　　　　　.... 途中省略 ....
　　　　　.
　　　　　"sFxMousikomiFlg":"0",
　　　　　"sUrlRequest":"仮想ＵＲＬ（REQUEST）",
　　　　　"sUrlMaster":"仮想ＵＲＬ（MASTER）",
　　　　　"sUrlPrice":"仮想ＵＲＬ（PRICE）",
　　　　　"sUrlEvent":"仮想ＵＲＬ（EVENT）"
　　　　}
　　　　※JSON 文字列の引数項目名は通信データ量削減のため、サンプルの変換プログラム mfds_json_api_compress_v4r4.js を利用し
　　　　　引数項目番号に圧縮変換し顧客側システムと立花証券側システムとの間のデータ送受信を行います。
　　　　　（本記載例は分かりやすいよう引数項目名で記載しています）
　　　　　詳細については別紙「ｅ支店・ＡＰＩ、ブラウザからの利用方法」の１１２行目のポイントの記載を参照願います。
　　　　　なお、変換プログラムのご利用方法はサンプルプログラムを参考頂きご利用ください。


　（２）ログアウト
　　　ＵＲＬ：
　　　　仮想ＵＲＬ（REQUEST）/

　　　ＪＳＯＮ引数項目：
　　　　{
　　　　　"p_no":"2",
　　　　　"p_sd_date":"2020.07.01-10:00:00.100",
　　　　　"sCLMID":"CLMAuthLogoutRequest"
　　　　}

　　　要求例：
　　　　仮想ＵＲＬ（REQUEST）/?{"p_no":"2","p_sd_date":"2020.07.01-10:00:00.100","sCLMID":"CLMAuthLogoutRequest"}

　　　応答例：
　　　　{
　　　　　"p_no":"2",
　　　　　"p_sd_date":"2020.07.10-10:00:00.150",
　　　　　"p_rv_date":"2020.07.10-10:00:00.100",
　　　　　"p_errno":"0",
　　　　　"p_err":"",
　　　　　"sCLMID":"CLMAuthLogoutAck",
　　　　　"sResultCode":"0",
　　　　　"sResultText":""
　　　　}

　（３）業務機能
　　　ＵＲＬ：
　　　　仮想ＵＲＬ（REQUEST）/

　　　ＪＳＯＮ引数項目：
　　　　※詳細は※１参照。

　（４）マスタ機能
　　　ＵＲＬ：
　　　　仮想ＵＲＬ（MASTER）/

　　　ＪＳＯＮ引数項目：
　　　　※詳細は※１参照。

　（５）時価情報機能
　　　ＵＲＬ：
　　　　仮想ＵＲＬ（PRICE）/

　　　ＪＳＯＮ引数項目：
　　　　※詳細は※１参照。

　（６）注文約定通知
　　　ＵＲＬ：
　　　　仮想ＵＲＬ（EVENT）/

　　　引数項目：
　　　　１．（５）参照。

　※１．ｅ支店・ＡＰＩは以下を参照。
　　　　・「立花証券・ｅ支店・ＡＰＩ（ｖ４ｒ３）、REQUEST I/F、利用方法、データ仕様」参照。
　　　　・「立花証券・ｅ支店・ＡＰＩ（ｖ４ｒ２）、REQUEST I/F、機能毎引数項目仕様」参照。
　　　　・「立花証券・ｅ支店・ＡＰＩ（ｖ４ｒ２）、REQUEST I/F、注文入力機能引数項目仕様」参照。
　　　　マスタ情報ダウンロード機能で取得可能な各種マスタデータについては以下を参照。
　　　　・「立花証券・ｅ支店・ＡＰＩ（ｖ４ｒ４）、REQUEST I/F、マスタデータ利用方法」参照。

戻る サンプルプログラム

ｅ支店・ＡＰＩ利用サンプルプログラム
１．基本利用方法（ｖ４ｒ４）
２．時価情報取得表示（ｖ４ｒ４）
へアクセスするとサンプルプログラムを表示します。

サンプルプログラムはｅ支店・ＡＰＩの最新バージョンのみに対応したプログラムです。
右クリック（ページソースコード表示）で全て参照＆利用可能です。
ｅ支店・ＡＰＩを利用したプログラム開発の際、参考資料の１つとしてご利用下さい。
※サンプルプログラムはお客様がｅ支店・ＡＰＩを利用したプログラム開発をする目的のみに利用を許諾致します。
※サンプルプログラムは当社の都合により提供の停止を含む機能追加変更削除等を行いますので予めご了承下さい。

なお、
サンプルプログラムはお客様がｅ支店・ＡＰＩを利用したプログラム開発をする目的でｅ支店・ＡＰＩの使い方をその１例として参考提供することが目的ですので
サンプルプログラム（として提供する全てのソースコード）の使用（含む一部機能（クラス、メソッド、サブルーチン等を含む）の利用や流用等）の
実行により生じた全ての障害・損害・不具合等に関しては一切の責任を負いませんので、自己の判断、及び自己の責任においてご（参考）利用をお願いいたします。

戻る その他

１．ネットワーク疎通確認
　　本ＡＰＩのご利用にはお客様のプログラム（以下クライアントと呼ぶ）から弊社本ＡＰＩプログラム（以下サーバと呼ぶ）に
　　インターネットを経由し HTTPS プロトコルで接続及びデータ通信をする必要があります。
　　お客様の契約先インターネット回線から不特定多数の回線業者のルータ等機器類を経由し
　　弊社契約先回線業者を通して弊社サーバに接続し
　　その逆をたどってお客様とのデータ通信を行うことで本ＡＰＩが機能いたします。
　　そのため本ＡＰＩをご利用前に、通信環境の確認として以下をお試しください。

　　（１）立花証券・ｅ支店・ＡＰＩ専用ページ（以下本ページと呼ぶ）の表示確認。
　　　　　本ページ（本記載内容）が見えていることで、クライアントからサーバまでのネットワーク的な疎通確認となります。
　　　　　本ページが見えている＝本ＡＰＩにアクセス可能、本ページが見えていない＝本ＡＰＩにアクセス不可能を意味しますので
　　　　　本ＡＰＩが使えない・・・とか本ＡＰＩに接続できない・・・と思う場合はこちらで判断ください。
　　　　　※ただし、サービス時間帯以外や休日の保守作業による休止時間帯を除きます。

　　（２）本専用ページまでのアクセス時間の確認。
　　　　　クライアントからサーバまでのアクセスが遅い・・・と感じられる場合は以下をお試しください。
　　　　　% wget https://kabuka.e-shiten.jp/e_api_v4/mfds_json_api_sample.html -O output.html
　　　　　実行結果として転送バイト数、ページ取得 % と転送時刻 s などが表示されます。
　　　　　ちなみに、弊社社員の自宅ＰＣ（光回線）から試したところ 26054 バイト を 0.003 秒 で転送（アクセス時間 0.003 秒）した結果でした。
　　　　　結果はクライアント〜サーバ間のシステム構成やネットワーク環境に依存しますので上記の計測結果が遅いと感じられる場合は
　　　　　お客様のご利用ＰＣやシステム環境、通信環境等の見直しが必要となりますので予めご留意願います。
　　　　　※wget は linux のコマンドになりますので、windows をご利用の場合は windows で稼働するフリーの wget ソフト等を
　　　　　　インストール（フリーソフトのインストールや実行については自己責任でお願いいたします）しご確認ください。

２．サーバ障害対策
　　本ＡＰＩの稼働サーバは複数台を並列稼働し本ＡＰＩサービスの提供を行っております。
　　万が一その内の１台が障害で停止した場合は該当サーバを切り捨て他の稼働サーバで継続運用致します。
　　ただし、タイミングにより該当サーバへ処理を割り振られた本ＡＰＩの要求（応答受信前に障害発生）については
　　クライアントは HTTPS のレベルでエラーを検知（本ＡＰＩの応答は返らない）となります。
　　このケースにおいて該当要求が注文入力である場合は応答が返されないため注文入力可否が判定できませんので
　　本ＡＰＩの注文一覧、または標準Ｗｅｂの注文一覧にて該当注文が発注されたかどうかについてご確認をお願いいたします。
　　※ｅ支店システムが障害（例として基幹データベースの障害など）等の場合、各ＡＰＩはエラー応答(p_errno!=0)を返します。
　　※ｅ支店システムが閉局等の場合も同様に各ＡＰＩはエラー応答(p_errno!=0)を返します。
　　※ p_errno については「立花証券・ｅ支店・ＡＰＩ（ｖＮ[ｒＮ]）、REQUEST I/F、利用方法、データ仕様」参照。

３．ＵＲＬエンコード
　　本ＡＰＩは HTTP プロトコルでインタフェースする仕様上
　　お客様からの要求については URL に JSON 文字列として指定頂く仕様となっております。
　　そのため URL の記述仕様上意味を持つ文字（例：「#+/:=」等）は直接指定することができません。
　　それらにつきましてはＵＲＬエンコード（文字変換）を行い、ＵＲＬに指定可能なエンコード文字（列）として指定頂く必要があります。
　　例：「#」→「%23」、「+」→「%2B」、「/」→「%2F」、「:」→「%3A」、「=」→「%3D」など。
　　※通常の業務データ（注文入力等）では上記文字を指定することはありませんが、パスワード等は該当しますのでご注意ください。

戻る