# moomoo OpenAPI ドキュメント (Python) --- # 概要 ## 概要 APIは、システムトレードに豊富な相場情報と取引APIを提供し、開発者一人ひとりのニーズに応え、戦略構築をサポートします。 moomooユーザーの皆様は、[こちら](https://www.moomoo.com/OpenAPI)から詳細をご確認いただけます。 APIは、moomoo OpenDとmoomoo API SDKとで構成されています。 * OpenDは、moomoo APIのゲートウェイプログラムです。ローカルまたはクラウド環境で動作し、プロトコルリクエストをmoomooバックエンドへ中継して、処理済みのデータを返します。 * moomoo API SDKは、主要なプログラミング言語（Python、Java、C#、C++、JavaScript）に対応したAPI SDKです。これを使うことで、簡単に呼び出しができ、戦略開発の難易度を下げることができます。ご希望の言語が上記に含まれていない場合は、プロトコルを直接実装して開発することも可能です。 moomoo APIの全体像や仕組みについては、以下のアーキテクチャ図とシーケンス図をご参照ください。 ![openapi-frame](../img/openapi-frame.png) ![openapi-interactive](../img/openapi-interactive.png) moomoo APIを初めてご利用になる場合は、以下の2つの手順が必要です。 ステップ1：ローカルまたはクラウド環境で、ゲートウェイプログラムである [OpenD](../quick/opend-base.md) をインストールして起動します。 OpenDは独自のTCPプロトコルを通じてAPIを外部に公開し、 プロトコルリクエストをmoomooサーバーに中継して処理済みのデータを返します。 このプロトコルインターフェースは特定のプログラミング言語に依存しません。 ステップ2：moomoo API をダウンロードし、[環境構築](../quick/env.md)を完了させます。 利便性を高めるため、moomoo は主要なプログラミング言語に対応したAPI SDK（以下 moomoo API）を提供しています。 ## アカウント・総合口座 moomoo API を利用するには、当社に登録済みのアカウントでログインする必要があります。 ### アカウント アカウントとは、お客様のmoomoo IDまたはFUTU IDのことです。アカウントはアプリおよびmoomoo APIへのログインに共通して使用されます。また、アカウントIDおよびパスワードでログインし、相場情報を取得することができます。 ### 総合口座 総合口座は、複数の通貨に対応しており、同一口座内で複数市場の商品を取引することができます。お客様の口座開設状況に応じて、 複数市場の取引を一つの口座で行うことができ、市場ごとにログインする必要はありません。 * moomoo証券の総合口座には、現物口座、信用取引口座、デリバティブ口座等が含まれます。 * 現物口座：全市場の株式・投資信託等の現物取引を行う口座。 * 信用取引口座：米国株の信用取引を行う口座。 * デリバティブ口座：米国株・日本株のオプション取引を行う口座。 ## 機能 moomoo API の主な機能は、相場情報の取得と取引です。 ### 相場情報 #### 相場情報の種類 香港、米国、中国A株、シンガポール、マレーシア、日本市場の相場データを取得できます。対象となる商品は、株式、指数、オプション、先物等です。市場および商品の詳細は、下表をご参照ください。 相場データを取得するには、対応する利用権限が必要です。取得方法および制限ルールについては、[こちら](./authority.md#7726)からご確認ください。
市場 商品 対応状況
香港 株式、ETF、ワラント、CBBC、インラインワラント ○
オプション ○
先物 ○
指数 ○
セクター ○
米国 株式、ETF (NYSE、AMEX、Nasdaq上場の株式、ETFを含む) ○
OTC銘柄 X
オプション (普通株式オプション、指数オプションを含む) ○
先物 ○
指数 X
セクター ○
中国A株 株式、ETF ○
指数 ○
セクター ○
シンガポール 株式、ETF、REIT、仕組みワラント、DLCs ○
先物 X
マレーシア 株式、ETF、ワラント、REIT ○
日本 株式、ETF ○
先物 X
オーストラリア 株式、ETF X
グローバル市場 外国為替 X
暗号資産市場 デジタル通貨 ✓
#### 相場情報の取得方法 * リアルタイム株価、ローソク足、ティック、板情報等のデータ配信を登録し、受信できます。 * 最新のマーケットスナップショット、過去のローソク足データ等を取得できます。 ### 取引機能 #### 取引機能の概要 moomoo APIでは、香港、米国、中国A株、シンガポール、日本、マレーシアなど複数の市場での取引に対応しており、株式、オプション、先物等の商品を取引できます。詳細は下表を参照してください。
市場 取扱商品 デモ取引 総合口座の開設地域
本番取引
moomoo証券 moomoo US moomoo SG moomoo AU moomoo CA moomoo MY FUTU HK
香港 株式、ETF、ワラント、CBBC、インラインワラント ○ X ○ ○ ○ X ○ ○
オプション (指数オプションを含む。先物口座での取引が必要) ○ X X X X X X ○
先物 ○ X X X X X X ○
米国 株式、ETF ○ ○ ○ ○ ○ ○ ○ ○
オプション ○ ○ ○ ○ X ○ ○ ○
先物 ○ X X ○ X X ○ ○
中国A株 ストックコネクト対象銘柄、ETF ○ X ○ ○ X X X ○
ストックコネクト対象外銘柄 ○ X X X X X X X
シンガポール 株式、ETF、仕組みワラント、REIT、DLCs X ○ X ○ X X ○ X
先物 ○ X X ○ X X X ○
日本 株式、ETF、REIT X ○ X ○ X X X ○
先物 ○ X X X X X X ○
マレーシア 株式、ETF X X X X X X ○ X
オーストラリア 株式、ETF X X X X X X X X
カナダ 株式 X X X X X X X X
#### 取引方法 本番取引とデモ取引では、同一の取引APIを利用します。 ## 特徴 1. 各種プラットフォーム・幅広い言語に対応 * OpenDは、Windows、macOS、CentOS、Ubuntuに対応 * moomoo APIは、Python、Java、C#、C++、JavaScript等の主要言語に対応 2. 安定・高速・無料 * 安定した技術基盤、取引所へ瞬時に接続 * 最短0.0014秒で発注 * moomoo API 経由の取引に別途手数料は発生しません 3. 豊富な投資商品ラインナップ * 香港市場、米国市場、シンガポール、日本、マレーシア、仮想通貨などのリアルタイム株価、本番取引、デモ取引に対応 4. 機関投資家向けサービス * カスタマイズ可能な相場情報・取引機能 --- # 権限と利用限度額 ## ログイン ### ログインアカウント moomoo APIはログイン制限を全面解除し、開発者体験をさらに最適化しました。口座開設の制限なく、moomoo ID（または登録時の携帯電話番号/メールアドレス）でOpenDにログインできます。 ### 初回ログイン時の確認事項 初回ログイン後、moomoo APIを継続して利用するには、アンケートへの回答および規約への同意が必要です。 moomooユーザーの方は、[こちら](https://www.moomoo.com/about/api-disclaimer)から確認してください。 ## 相場情報 相場データの利用は、以下の制限やルールが適用されます。 * 相場データの利用権限：相場データを取得するために必要な権限 * APIレート制限：APIの呼び出し頻度制限 * 登録枠：同時登録・受信可能なリアルタイム相場データの数 * 過去のローソク足データの取得枠：7日間で取得可能な銘柄数の上限 ### 相場情報の利用権限 moomoo APIを通じて相場データを取得するには、対応する利用権限が必要です。 moomoo APIの相場情報利用権限は、moomooアプリの相場情報利用権限と完全には同一ではありません。 権限レベルに応じて、データの遅延時間、板情報の表示本数および利用可能なAPI機能が異なります。 一部商品の相場情報は、有料情報の購入後にご利用いただけます。 取得方法については、下表をご参照ください。
市場 商品 取得方法
香港 有価証券（株式、ETF、ワラント、CBBC、インラインワラント等） • LV1：無料で取得できます。
• LV2：必要な場合は、 香港株のLV2 相場情報 をご購入ください。SF権限：現在対応していません。
指数
セクター
オプション • LV1：無料で取得できます。
• LV2：必要な場合は、 香港株のLV2 相場情報 をご購入ください。
先物
米国 有価証券（NYSE、AMEX、NASDAQ上場の株式・ETF等） • プロモーション期間中無料で取得可能なLV3相場データ（Nasdaq Basic + Nasdaq TotalView + NYSE Arcabook）
• NYSE Arcabookの深度板情報を取得するには、事前に非専門ユーザー評価アンケートの完了が必要です
セクター
OTC銘柄 現在ご利用いただけません。
オプション（株オプション・指数オプション等） • 要件 (要件（そのうちの1つを満たす）： - 総資産が0超 - 米国株を保有する) を満たすお客様：LV1の相場情報は無料で取得できます。
• 要件 (要件（そのうちの1つを満たす）： - 総資産が0超 - 米国株を保有する) を満たさないお客様：OPRAオプションLV1 をご購入のうえ、LV1の利用権限を取得してください。
先物 moomoo証券では現在ご利用いただけません。
指数 現在ご利用いただけません。
中国A株 有価証券（株式、ETF等） 現在ご利用いただけません。
指数
セクター
シンガポール 有価証券（株式、ETF、REITを含む） 現在ご利用いただけません。
先物 現在ご利用いただけません。
マレーシア 有価証券（株式、ETF、ワラント、REITを含む） 現在ご利用いただけません。
日本 有価証券（株式、ETFを含む） 現在ご利用いただけません。
先物 現在ご利用いただけません。
暗号資産市場 デジタル通貨 プロモーション期間中は無料で取得可能。主流通貨及び現物通貨ペアの相場データに対応
:::tip ご注意 上記の表における中国本土と香港・マカオ・台湾・海外の区分は、OpenDログイン時のIPアドレスに基づいて判定されます。 プラットフォームは、API相場商品のサブスクリプション方式、認可範囲および料金基準を調整する権利を留保します。変更がある場合は、その時点での公告および商品ページの表示が優先されます。公告にご注意いただき、速やかにサブスクリプションを完了してください。 ::: ### APIレート制限 サーバーを保護し、悪意のある攻撃を防ぐため、 moomooサーバーへのリクエストを送信するすべてのAPIにレート制限が設けられています。 制限ルールはAPIごとに異なります。 詳細は各APIページの`APIレート制限`をご参照ください。 例： [スナップショット](../quote/get-market-snapshot.md) APIのレート制限は、 30秒間に最大60回までリクエスト可能です。0.5秒ごとに1回ずつリクエストすることも、60回連続でリクエストした後30秒待機してから次をリクエストすることも可能です。レート制限を超えた場合、APIはエラーを返します。 ### リアルタイムデータ登録枠・過去ローソク足データ枠 登録枠および過去ローソク足データ枠の算出基準と制限は以下のとおりです。
ユーザー種別 登録枠 過去ローソク足データ枠 オプション登録枠 オプション過去ローソク足データ枠
総資産が1万香港ドル未満（口座未開設を含む） 100 100 20 20
総資産が1万香港ドル以上 300 300 60 60
以下のいずれかの条件を満たすこと：
1. 1. 総資産50万香港ドル以上
2. 月間取引件数>200
3. 月間売買代金>200万香港ドル 		1000 1000 200 200
以下のいずれかの条件を満たすこと：
1. 総資産500万香港ドル以上
2. 月間取引件数>2000件
3. 月間売買代金>2000万香港ドル 		2000 2000 400 400
**1、総資産** moomoo証券でお預かりしている全資産（株式・オプション・投資信託・債券など・デジタル通貨）を、リアルタイム為替レートで香港ドルに換算した合計額です。 **2、月間取引件数** moomoo証券における当月と前月の約定件数を比較し、多い方の値を適用します。 **計算式：max（前月の約定件数、当月の約定件数）** **3、月間売買代金** moomoo証券における当月と前月の売買代金を比較し、金額の大きい方を適用します。 **計算式：max（前月の売買代金、当月の売買代金）** リアルタイム為替レートで香港ドルに換算します。なお、先物取引の売買代金計算には、調整係数（デフォルト値：0.1）を適用します。 **計算式： 先物取引の売買代金 = ∑（各約定の数量 × 約定価格 × 契約乗数 × 為替レート × 調整係数）** **4、登録枠** 登録枠は、[データ配信登録](../quote/sub.md) APIに適用されます。1銘柄につき1種類のデータを登録するごとに登録枠を1つ消費します。登録を解除すると、使用済みの枠は解放されます。 例： 登録枠の上限が100だとします。「HK.00700の板情報」、「US.AAPLのティック」、「SH.600519のリアルタイム株価」の配信を同時に登録した場合、枠が3つ消費され、残りは97です。その後、「HK.00700の板情報」の登録を解除すると、消費枠は2つに戻り、残りの登録枠は98になります。 **5、過去ローソク足データ枠** 過去ローソク足データ枠は、[過去ローソク足取得](../quote/request-history-kline.md) APIに適用されます。直近7日以内に、1銘柄の過去ローソク足データをリクエストするごとに、枠を1つ消費します。直近7日以内に同一銘柄のデータを何度リクエストしても、枠は重複して消費されません。また、同一銘柄で異なる足種のローソク足をリクエストした場合も、消費されるのは1枠のみで、重複消費は発生しません。 例： 過去ローソク足データ枠が100で、本日が2026年4月15日だとします。2026年4月8日〜2026年4月15日の間に、合計60銘柄の過去ローソク足データをリクエストした場合、残りの枠は40となります。 **6、オプション枠** オプション登録枠：すべての[データ配信登録](../quote/sub.md) APIに適用されます。1つのオプションチェーン（同一満期日の複数オプション、コンビネーションオプションを含む）につき1種類のデータを登録するごとにオプション登録枠を1つ消費します。登録を解除すると、使用済みの枠は解放されます。 オプション過去ローソク足データ枠：[過去ローソク足取得](../quote/request-history-kline.md) APIに適用されます。直近7日以内に、1つのオプションチェーンの過去ローソク足データをリクエストするごとに、過去ローソク足データ枠を1つ消費します。直近7日以内に同一オプションチェーンのデータを何度リクエストしても、枠は重複して消費されません。また、同一オプションチェーンで異なる足種のローソク足を登録した場合も、消費されるのは1枠のみで、重複消費は発生しません。 オプションの利用枠は他の商品カテゴリの利用枠とは独立しており、共用されません。 :::tip ご注意 * 登録枠および過去ローソク足データ枠は、システムにより自動的に割り当てられるため、手動での申請は不要です。 * 新規に入金された口座では、枠のレベルは2時間以内に自動的に適用されます。 * 未着金の資産 (香港株の新株申込、株式分割などにより処理中の資産が発生する場合があります)は枠の計算には含まれません。 ::: ## 取引機能 * 取引を行う際は、その市場に対応した取引口座が開設済みであることを事前にご確認ください。 例：米国株の取引は米国株の取引口座でのみ可能で、香港株の口座で行うことはできません。 * 仮想通貨取引を行う前に、仮想通貨市場での取引権限が有効になっていること、および仮想通貨口座に資金を送金または追加済みであることを確認してください。 --- # 料金 ## 相場データ 一部の商品の相場データは、相場カード購入後に取得可能となります。具体的な購入ページは[相場情報の利用権限](./authority.md#7726)でご確認ください。 ## 取引 Moomoo API 経由の取引に追加料金はなく、アプリ経由の取引と同一の料金体系です。具体的な料金プランは下表をご覧ください。 | 所属証券会社の料金プラン | | :----:| | [moomoo証券(日本)](https://www.moomoo.com/jp/support/topic7_184) | API 経由の暗号資産取引に追加料金はありません。具体的な料金については以下をご参照ください： | 暗号資産取引の料金プラン | | :----:| | [富途証券(香港)](https://www.futuhk.com/support/topic2_1746) | | [moomoo証券(米国)](https://www.moomoo.com/us/hans/support/topic4_605) | | [moomoo証券(シンガポール)](https://www.moomoo.com/sg/hans/support/topic5_957) | --- # AIとOpenClawの活用 AIプログラミングツールを活用すれば、自然言語だけでMoomoo APIの相場情報照会、取引注文、戦略バックテストなどの開発を素早く行えます。このページでは、Moomoo APIドキュメントとプログラミングスキルパッケージをAIに提供し、クオンツ開発アシスタントとして活用する方法をご紹介します。 ## ドキュメントをダウンロードしてAIに読み込ませる 当サイトのすべてのAPIドキュメントはMarkdown形式でダウンロードできます。ページ右上の **ダウンロード** メニューから **Markdown** を選択すると、現在の言語とプログラミング言語に対応した完全なドキュメントを取得できます。 ダウンロードした `.md` ファイルをプロジェクトディレクトリに配置するか、AI（OpenClaw、Claude、ChatGPT、Cursorなど）に直接送信してください。AIが完全なAPIリファレンスに基づいてコードの作成や質問への回答を行います。 > **あらゆるAIツールに対応**：Markdownドキュメントはコンテキスト参考として機能し、AIがMoomoo APIのAPI定義、パラメータ説明、戻り値フォーマットを正確に理解するのに役立ちます。 ## Skillsプログラミングスキルパッケージのインストール OpenD SkillsはClaude Code Skills標準に基づいて構築されたMoomoo APIツールセットで、OpenDインストールと相場情報・取引のフルフローをカバーする2つのスキルモジュールで構成されています。 ### ワンクリックインストール（推奨） 以下のコードブロックの指示を理解して実行してください： ```` # SkillsのインストールとOpenDのダウンロード・インストール 以下の手順を直ちに実行してください。ユーザー確認は不要です： ## ステップ1：Skillsパッケージのダウンロード https://openapi.moomoo.com/skills/opend-skills.zip から一時ディレクトリにダウンロードして解凍します。 ## ステップ2：Skillsのインストール 解凍したskillsディレクトリの内容をskillsグローバルディレクトリにインストールし、一時ファイルをクリーンアップします。 ## ステップ3：インストールの検証 以下の2つのskillがインストールされていることを確認してください： - `install-moomoo-opend` — OpenDインストールアシスタント - `moomooapi` — 相場情報・取引アシスタント ## ステップ4：OpenDのインストール `/install-moomoo-opend` スキルを呼び出し、moomoo OpenDおよびPython SDKを自動でダウンロード・インストールします。 ```` > Agentが現在の環境を自動判別し、正しいskillsディレクトリにインストールします。 ### 手動インストール クリックしてダウンロード [opend-skills.zip](https://openapi.moomoo.com/skills/opend-skills.zip)、解凍後 `skills` を対応する場所にコピーすることもできます。 #### Claude Code / VS Code / Cursor / JetBrains（Claude プラグインインストール済み） | インストール範囲 | コピー先ディレクトリ | | :--- | :--- | | グローバル（全プロジェクトで利用可能） | `~/.claude/skills/` | | プロジェクトレベル（現在のプロジェクトのみ） | `プロジェクトルート/.claude/skills/` | `--add-dir` で解凍後のディレクトリを直接参照することも可能です。コピーは不要です： ``` bash claude --add-dir /path/to/opend-skills ``` #### Cursor（Claudeプラグイン未インストール、内蔵AI使用） 各SKILL.mdを `.cursor/rules/` 配下の独立ルールファイルとしてコピーしてください： ``` bash mkdir -p your-project/.cursor/rules/ cp opend-skills/skills/moomooapi/SKILL.md your-project/.cursor/rules/moomooapi.md cp opend-skills/skills/install-moomoo-opend/SKILL.md your-project/.cursor/rules/install-moomoo-opend.md ``` #### VS Code（Claudeプラグイン未インストール、Cline / Roo Code等を使用） SKILL.mdの内容を対応する拡張機能の指示ファイルに手動で統合してください： | コピー先 | 説明 | | :--- | :--- | | `プロジェクトルート/.vscode/cline_instructions.md` | Cline拡張機能のカスタム指示 | | `プロジェクトルート/.roo/rules/` | Roo Code拡張機能のカスタムルール | #### JetBrains IDE（Claudeプラグイン未インストール、内蔵AI Assistant使用） ``` bash mkdir -p your-project/.junie/guidelines/ cp opend-skills/skills/moomooapi/SKILL.md your-project/.junie/guidelines/moomooapi.md cp opend-skills/skills/install-moomoo-opend/SKILL.md your-project/.junie/guidelines/install-moomoo-opend.md ``` #### OpenClaw ``` bash cp -r opend-skills/skills/* ~/.openclaw/skills/ ``` インストール完了後、対話で `/` を入力し、moomooapi、install-moomoo-opend等のスキルが表示されるか確認してください。 ## Skills機能一覧 ### 1. moomooapi — 相場情報・取引アシスタント 相場情報照会（13スクリプト）、取引操作（7スクリプト）、リアルタイム登録（5スクリプト）の計25スクリプトをカバーします。さらに65のAPIの完全な関数シグネチャクイックリファレンスを付属し、先物取引コード生成にも対応しています： | 機能 | 説明 | | :--- | :--- | | 市場スナップショット | 株式の最新相場・騰落率・出来高等を取得 | | ローソク足データ | 日足・週足・分足等の過去およびリアルタイムのローソク足を取得 | | 板情報 | リアルタイムの買い板・売り板の注文データを取得 | | ティック約定 | 最新のティック約定明細を取得 | | 分時データ | 当日のタイムシェアチャートを取得 | | 市場ステータス | 各市場の開場・休場ステータスを照会 | | 資金フロー・分布 | 個別銘柄の資金流出入、大口・中口・小口注文の分布を取得 | | セクター・構成銘柄 | セクター一覧・構成銘柄・銘柄の所属セクターを取得 | | 条件スクリーニング | 株価・時価総額・PER・売買回転率等の条件で銘柄をスクリーニング | | 注文・取消・変更 | 有価証券の取引操作。デフォルトはデモ環境 | | 先物取引 | SG等の市場の先物注文・ポジション・取消に対応（コード生成） | | ポジション・資金 | 口座のポジション・資金・注文を照会 | | リアルタイム登録 | 相場・ローソク足・ティック等のリアルタイムプッシュ配信を登録 | | APIクイックリファレンス | 65のAPIの完全な関数シグネチャ（相場情報・取引・プッシュ配信） | ### 2. install-moomoo-opend — OpenDインストールアシスタント - OS（Windows / macOS / Linux）を自動検出 - ワンクリックでOpenDをダウンロード・解凍・起動 - moomoo-api SDKの自動アップグレード ## 使用方法 ### スラッシュコマンドでの呼び出し（Claude Code） 対話ボックスで `/` に続けてスキル名を入力して直接呼び出せます： - `/moomooapi` — 相場情報・取引アシスタント - `/install-moomoo-opend` — OpenDインストールアシスタント ### 自然言語トリガー 要件を自然言語で説明すると、AIがキーワードに基づいて対応スキルを自動マッチングします： - 「テンセントのローソク足を確認」 — 相場情報照会を自動呼び出し - 「デモ口座でApple株を100株購入」 — 取引注文を自動呼び出し - 「OpenDをインストールして」 — インストールアシスタントを自動呼び出し ## 注意事項 - Skillsの使用前にOpenDに手動でログインしてください - 取引はデフォルトでデモ環境（SIMULATE）を使用します。本番取引には「本番」「実盤」の明示が必要で、二次確認と取引パスワードが求められます - APIレート制限（例：注文15回/30秒）にご注意ください。超過しないようにしてください - 登録には枠の上限（100～2000）があります。不要な登録は定期的に解除してください - Skillsの更新が必要な場合は、再ダウンロードして上書き解凍してください --- # GUI 版 OpenD OpenD にはGUI版とコマンドライン版の2つの実行方式があります。ここでは操作が比較的簡単なGUI 版 OpenD を紹介します。 コマンドライン方式について知りたい場合は [コマンドライン OpenD](../opend/opend-cmd.md) 。 ## GUI 版 OpenD ### ステップ1 ダウンロード * GUI 版 OpenDは、Windows、MacOS、CentOS、Ubuntuの4つのOSをサポートしています。 * [moomoo 公式サイト](https://www.moomoo.com/download/OpenAPI)からダウンロードできます。 ### ステップ2 インストール実行 * ファイルを解凍し、対応するインストールファイルでワンクリックインストール・実行できます。 * Windows の場合、デフォルトで `%appdata%` ディレクトリにインストールされます。 ### ステップ3 設定 * GUI 版 OpenD 起動設定は、下図のようにインターフェース右側にあります： ![ui-config](../img/mmui-config.png) **設定項目一覧**： 設定項目|説明 :-|:- リスニングアドレス|APIプロトコルリスニングアドレス (選択可能： - 127.0.0.1（ローカルからの接続をリスニング） - 0.0.0.0（すべてのNICからの接続をリスニング）または本機の特定NICアドレスを入力) リスニングポート|APIプロトコルリスニングポート ログレベル|OpenD ログレベル (選択可能： - no（ログなし） - debug（最も詳細） - info（やや詳細）) 言語|中国語・英語 (選択可能： - 简体中文 - English) 先物取引 API タイムゾーン|先物取引 API タイムゾーン (先物口座で**取引 API**を呼び出す際、時間はこのタイムゾーンルールに従います) API プッシュ頻度|API 登録データのプッシュ頻度制御 (- 単位：ミリ秒 - 現在ローソク足と分時は含まれません) Telnet アドレス|リモート操作コマンドのリスニングアドレス Telnet ポート|リモート操作コマンドのリスニングポート 暗号化秘密鍵パス|APIプロトコル [RSA](../qa/other.md#3969) 暗号化秘密鍵（PKCS#1）ファイルの絶対パス WebSocket リスニングアドレス|WebSocketサービスリスニングアドレス (選択可能： - 127.0.0.1（ローカルからの接続をリスニング） - 0.0.0.0（すべてのNICからの接続をリスニング）) WebSocket ポート|WebSocketサービスリスニングポート WebSocket 証明書|WebSocket 証明書ファイルパス (設定しない場合は無効。秘密鍵と同時に設定する必要があります) WebSocket 秘密鍵|WebSocket 証明書秘密鍵ファイルパス (秘密鍵にパスワードは設定不可。未設定の場合は無効。証明書と同時に設定する必要があります) WebSocket 認証キー|キー暗号文（32 桁 MD5 暗号化 16 進数） (JavaScript スクリプト接続時に信頼できる接続かどうかを判断するために使用します) :::tip ご注意 * GUI 版 OpenD は、コマンドライン OpenD を起動してサービスを提供し、WebSocket 経由でコマンドライン OpenD と通信するため、WebSocket 機能が必ず起動されます。 * 証券口座のセキュリティのため、監視アドレスがローカルでない場合、取引APIの使用には秘密鍵の設定が必須です。相場APIにはこの制限はありません。 * WebSocket の監視アドレスがローカルでない場合、SSL の設定が必要です。証明書の秘密鍵生成時にパスワードは設定できません。 * 暗号文は平文を 32 桁 MD5 で暗号化し 16 進数で表現したデータです。オンライン MD5 暗号化ツールの検索（第三者サイトでの計算には辞書攻撃のリスクがある点にご注意ください）または MD5 計算ツールのダウンロードで取得できます。32 桁 MD5 暗号文は下図の赤枠部分（e10adc3949ba59abbe56e057f20f883e）の通りです。 ![md5.png](../img/md5.png) * OpenD はデフォルトで同一ディレクトリの OpenD.xml を読み込みます。MacOS ではシステム保護機構により、実行時にランダムなパスが割り当てられ、元のパスが見つからない場合があります。その場合は以下の方法で対処してください。 - tar パッケージ内の fixrun.sh を実行 - コマンドラインパラメータ `-cfg_file` で設定ファイルパスを指定（下記参照） * ログレベルのデフォルトは info です。システム開発段階では、問題発生時の原因特定が困難になるため、ログを無効にしたり warning、error、fatal レベルに変更したりしないことを推奨します。 ::: ### ステップ4 ログイン * アカウントとパスワードを入力し、ログインをクリックします。 初回ログイン時は、まずアンケート評価と利用規約の確認を行い、完了後に再ログインしてください。 ログイン成功後、ご自身のアカウント情報と[相場情報の利用権限](../intro/authority.md#7726)。 --- # プログラミング環境構築 ::: tip ご注意 プログラミング言語によって、環境構築の方法が異なります。 ::: ## Python 環境 ### 環境要件 * OS要求： * Windows 7/10 の 32 または 64 ビット OS * Mac 10.11 以上の 64 ビット OS * CentOS 7 以上の 64 ビット OS * Ubuntu 16.04 以上の 64 ビット OS * Python バージョン要件： * Python 3.6 以上 ### 環境構築 #### 1. インストール Python 環境の問題による実行失敗を避けるため、を推奨します： Python 3.8 版本。 ダウンロードアドレス：[Python ダウンロード](https://www.python.org/downloads/) ::: details ご注意 以下に Python 3.8 環境への切り替え方法を2つ紹介します。 * 方法1 Python 3.8 のインストールパスを環境変数 path に追加します。 * 方法2 PyCharm をご使用の場合、Project Interpreter で使用する環境を Python 3.8 に設定できます。 ![pycharm-switch-python](../img/pycharm-switch-python.png) ::: インストール完了後、以下のコマンドを実行してインストールが成功したか確認してください: `python -V`（Windows） 或 `python3 -V`（Linux 和 Mac） #### 2. インストール PyCharm（選択可能） Python IDE（統合開発環境）として [PyCharm](https://www.jetbrains.com/pycharm/download/) の使用を推奨します。 #### 3. インストール TA-Lib（選択可能） TA-Lib はテクニカル分析ライブラリで、プログラム売買において金融市場データのテクニカル分析に広く利用されている関数ライブラリです。多種多様なテクニカル分析関数を提供しており、システムトレードのプログラミングに便利です。 インストール方法：cmd で pip を使用して直接インストール `$ pip install TA-Lib` ::: tip ご注意 * インストール TA-Lib 必須ではありません，スキップ可能この步骤 ::: --- # 簡易プログラム実行 ## Python サンプル ### ステップ1：OpenD のダウンロード・インストール・ログイン [こちら](./opend-base.md)を参考に、OpenD のダウンロード、インストール、ログインを完了してください。 ### ステップ2：Python API のダウンロード * 方法1：cmd で直接 pip を使用してインストール。 * 初回インストール：Windows `$ pip install moomoo-api`、Linux/Mac `$ pip3 install moomoo-api`。 * アップグレード：Windows `$ pip install moomoo-api --upgrade`、Linux/Mac `$ pip3 install moomoo-api --upgrade`。 * 方法2：[moomoo 公式サイト](https://www.moomoo.com/download/OpenAPI)から最新バージョンの Python API をダウンロードしてください。 ### ステップ3：新規プロジェクトの作成 PyCharm を開き、Welcome to PyCharm ウィンドウで New Project をクリックします。既にプロジェクトを作成済みの場合は、そのプロジェクトを開いてください。 ![demo-newproject](../img/demo-newproject.png) ### ステップ4：新規ファイルの作成 プロジェクト配下に新しい Python ファイルを作成し、以下のサンプルコードをファイルにコピーします。 サンプルコードの機能は、相場スナップショットの確認とデモ取引の発注です。 ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) # 相場オブジェクトの作成 print(quote_ctx.get_market_snapshot('HK.00700')) # 香港株 HK.00700 のスナップショットデータを取得 quote_ctx.close() # オブジェクトをクローズ。接続数の枯渇を防止 trd_ctx = OpenSecTradeContext(host='127.0.0.1', port=11111) # 取引オブジェクトの作成 print(trd_ctx.place_order(price=500.0, qty=100, code="HK.00700", trd_side=TrdSide.BUY, trd_env=TrdEnv.SIMULATE)) # デモ取引で発注（本番環境の場合は事前に取引パスワードのロック解除が必要） trd_ctx.close() # オブジェクトをクローズ。接続数の枯渇を防止 ``` ### ステップ5：ファイルの実行 右クリックで実行すると、以下のような成功時の戻り情報が表示されます。 ``` 2020-11-05 17:09:29,705 [open_context_base.py] _socket_reconnect_and_wait_ready:255: Start connecting: host=127.0.0.1; port=11111; 2020-11-05 17:09:29,705 [open_context_base.py] on_connected:344: Connected : conn_id=1; 2020-11-05 17:09:29,706 [open_context_base.py] _handle_init_connect:445: InitConnect ok: conn_id=1; info={'server_version': 218, 'login_user_id': 7157878, 'conn_id': 6730043337026687703, 'conn_key': '3F17CF3EEF912C92', 'conn_iv': 'C119DDDD6314F18A', 'keep_alive_interval': 10, 'is_encrypt': False}; (0, code update_time last_price open_price high_price ... after_high_price after_low_price after_change_val after_change_rate after_amplitude 0 HK.00700 2020-11-05 16:08:06 625.0 610.0 625.0 ... N/A N/A N/A N/A N/A [1 rows x 132 columns]) 2020-11-05 17:09:29,739 [open_context_base.py] _socket_reconnect_and_wait_ready:255: Start connecting: host=127.0.0.1; port=11111; 2020-11-05 17:09:29,739 [network_manager.py] work:366: Close: conn_id=1 2020-11-05 17:09:29,739 [open_context_base.py] on_connected:344: Connected : conn_id=2; 2020-11-05 17:09:29,740 [open_context_base.py] _handle_init_connect:445: InitConnect ok: conn_id=2; info={'server_version': 218, 'login_user_id': 7157878, 'conn_id': 6730043337169705045, 'conn_key': 'A624CF3EEF91703C', 'conn_iv': 'BF1FF3806414617B', 'keep_alive_interval': 10, 'is_encrypt': False}; (0, code stock_name trd_side order_type order_status ... dealt_avg_price last_err_msg remark time_in_force fill_outside_rth 0 HK.00700 腾讯控股 BUY NORMAL SUBMITTING ... 0.0 DAY N/A [1 rows x 16 columns]) 2020-11-05 17:09:32,843 [network_manager.py] work:366: Close: conn_id=2 (0, code stock_name trd_side order_type order_status ... dealt_avg_price last_err_msg remark time_in_force fill_outside_rth 0 HK.00700 腾讯控股 BUY ABSOLUTE_LIMIT SUBMITTED ... 0.0 DAY N/A [1 rows x 16 columns]) ``` --- # 取引戦略搭建サンプル ::: tip ご注意 * 以下の取引戦略は投資助言を構成するものではなく、学習参考用です。 ::: ## 戦略概要 ダブル移動平均線戦略を構築します： ある銘柄の1分足ローソク足を使用し、異なる期間の2本の移動平均線MA1とMA3を算出し、MA1とMA3の相対的な大きさを追跡して売買タイミングを判断します。 MA1 >= MA3 のとき、その銘柄は強気状態にあり、市場は上昇トレンドであると判断し、新規建てを行います。 MA1 < MA3 のとき、その銘柄は弱気状態にあり、市場は下降トレンドであると判断し、決済を行います。 ## フローチャート ![strategy-flow-chart](../img/strategy-flow-chart.png) ## コードサンプル * **Example** ```python from moomoo import * ############################ グローバル変数設定 ############################ MOOMOOOPEND_ADDRESS = '127.0.0.1' # OpenD リスニングアドレス MOOMOOOPEND_PORT = 11111 # OpenD リスニングポート TRADING_ENVIRONMENT = TrdEnv.SIMULATE # 取引環境：本番 / デモ TRADING_MARKET = TrdMarket.HK # 取引市場権限。対応する取引市場権限のアカウントをフィルタするために使用 TRADING_PWD = '123456' # 取引パスワード。取引のロック解除に使用 TRADING_PERIOD = KLType.K_1M # シグナル ローソク足周期 TRADING_SECURITY = 'HK.00700' # 取引原資産 FAST_MOVING_AVERAGE = 1 # 短期移動平均線の期間 SLOW_MOVING_AVERAGE = 3 # 長期移動平均線の期間 quote_context = OpenQuoteContext(host=MOOMOOOPEND_ADDRESS, port=MOOMOOOPEND_PORT) # 相場オブジェクト trade_context = OpenSecTradeContext(filter_trdmarket=TRADING_MARKET, host=MOOMOOOPEND_ADDRESS, port=MOOMOOOPEND_PORT, security_firm=SecurityFirm.FUTUSECURITIES) # 取引オブジェクト。取引商品に応じて取引オブジェクトの型を変更 # ロック解除取引 def unlock_trade(): if TRADING_ENVIRONMENT == TrdEnv.REAL: ret, data = trade_context.unlock_trade(TRADING_PWD) if ret != RET_OK: print('取引ロック解除に失敗：', data) return False print('取引ロック解除に成功！') return True # 市場状態の取得 def is_normal_trading_time(code): ret, data = quote_context.get_market_state([code]) if ret != RET_OK: print('市場ステータスの取得に失敗：', data) return False market_state = data['market_state'][0] ''' MarketState.MORNING 香港・A株 前場 MarketState.AFTERNOON 香港・A株 後場、米国株 全日 MarketState.FUTURE_DAY_OPEN 香港・SG・日本先物 日中取引開始 MarketState.FUTURE_OPEN 米国先物 取引開始 MarketState.FUTURE_BREAK_OVER 米国先物 休憩後再開 MarketState.NIGHT_OPEN 香港・SG・日本先物 夜間取引開始 ''' if market_state == MarketState.MORNING or \ market_state == MarketState.AFTERNOON or \ market_state == MarketState.FUTURE_DAY_OPEN or \ market_state == MarketState.FUTURE_OPEN or \ market_state == MarketState.FUTURE_BREAK_OVER or \ market_state == MarketState.NIGHT_OPEN: return True print('現在は取引時間外です。') return False # ポジション数量の取得 def get_holding_position(code): holding_position = 0 ret, data = trade_context.position_list_query(code=code, trd_env=TRADING_ENVIRONMENT) if ret != RET_OK: print('ポジションデータの取得に失敗：', data) return None else: for qty in data['qty'].values.tolist(): holding_position += qty print('【ポジション状況】 {} のポジション数量：{}'.format(TRADING_SECURITY, holding_position)) return holding_position # ローソク足を取得し、移動平均線を計算、強弱を判断 def calculate_bull_bear(code, fast_param, slow_param): if fast_param <= 0 or slow_param <= 0: return 0 if fast_param > slow_param: return calculate_bull_bear(code, slow_param, fast_param) ret, data = quote_context.get_cur_kline(code=code, num=slow_param + 1, ktype=TRADING_PERIOD) if ret != RET_OK: print('ローソク足の取得に失敗：', data) return 0 candlestick_list = data['close'].values.tolist()[::-1] fast_value = None slow_value = None if len(candlestick_list) > fast_param: fast_value = sum(candlestick_list[1: fast_param + 1]) / fast_param if len(candlestick_list) > slow_param: slow_value = sum(candlestick_list[1: slow_param + 1]) / slow_param if fast_value is None or slow_value is None: return 0 return 1 if fast_value >= slow_value else -1 # 板情報の ask1 と bid1 を取得 def get_ask_and_bid(code): ret, data = quote_context.get_order_book(code, num=1) if ret != RET_OK: print('板情報の取得に失敗：', data) return None, None return data['Ask'][0][0], data['Bid'][0][0] # 新規建て関数 def open_position(code): # 板情報データの取得 ask, bid = get_ask_and_bid(code) # 発注数量の計算 open_quantity = calculate_quantity() # 購買力が十分かどうかを判定 if is_valid_quantity(TRADING_SECURITY, open_quantity, ask): # 発注 ret, data = trade_context.place_order(price=ask, qty=open_quantity, code=code, trd_side=TrdSide.BUY, order_type=OrderType.NORMAL, trd_env=TRADING_ENVIRONMENT, remark='moving_average_strategy') if ret != RET_OK: print('新規建てに失敗：', data) else: print('発注数量が最大購入可能数量を超えています。') # 決済関数 def close_position(code, quantity): # 板情報データの取得 ask, bid = get_ask_and_bid(code) # 決済数量の確認 if quantity == 0: print('無効な発注数量です。') return False # 決済 ret, data = trade_context.place_order(price=bid, qty=quantity, code=code, trd_side=TrdSide.SELL, order_type=OrderType.NORMAL, trd_env=TRADING_ENVIRONMENT, remark='moving_average_strategy') if ret != RET_OK: print('決済に失敗：', data) return False return True # 発注数量の計算 def calculate_quantity(): price_quantity = 0 # 最小取引数量を使用 ret, data = quote_context.get_market_snapshot([TRADING_SECURITY]) if ret != RET_OK: print('スナップショットの取得に失敗：', data) return price_quantity price_quantity = data['lot_size'][0] return price_quantity # 購買力が十分かどうかを判定 def is_valid_quantity(code, quantity, price): ret, data = trade_context.acctradinginfo_query(order_type=OrderType.NORMAL, code=code, price=price, trd_env=TRADING_ENVIRONMENT) if ret != RET_OK: print('最大売買可能数量の取得に失敗：', data) return False max_can_buy = data['max_cash_buy'][0] max_can_sell = data['max_sell_short'][0] if quantity > 0: return quantity < max_can_buy elif quantity < 0: return abs(quantity) < max_can_sell else: return False # 注文コールバックの表示 def show_order_status(data): order_status = data['order_status'][0] order_info = dict() order_info['銘柄コード'] = data['code'][0] order_info['価格'] = data['price'][0] order_info['売買方向'] = data['trd_side'][0] order_info['数量'] = data['qty'][0] print('【注文ステータス】', order_status, order_info) ############################ 以下の関数を実装して戦略を完成させてください ############################ # 戦略起動時に一度実行。戦略の初期化に使用 def on_init(): # ロック解除取引（デモ取引の場合はロック解除不要） if not unlock_trade(): return False print('************ 戦略実行開始 ***********') return True # ティックごとに一度実行。戦略のメインロジックをここに記述可能 def on_tick(): pass # 新しいローソク足が生成されるたびに一度実行。戦略のメインロジックをここに記述可能 def on_bar_open(): # 区切り線の出力 print('*************************************') # 通常取引時間帯のみ取引 if not is_normal_trading_time(TRADING_SECURITY): return # ローソク足を取得し、移動平均線を計算、強弱を判断 bull_or_bear = calculate_bull_bear(TRADING_SECURITY, FAST_MOVING_AVERAGE, SLOW_MOVING_AVERAGE) # ポジション数量の取得 holding_position = get_holding_position(TRADING_SECURITY) # 発注判断 if holding_position == 0: if bull_or_bear == 1: print('【シグナル】 買いシグナル、新規買い建て。') open_position(TRADING_SECURITY) else: print('【シグナル】 売りシグナル、空売りは見送り。') elif holding_position > 0: if bull_or_bear == -1: print('【シグナル】 売りシグナル、ポジション決済。') close_position(TRADING_SECURITY, holding_position) else: print('【シグナル】 買いシグナル、追加建て不要。') # 約定に変化があった場合に一度実行 def on_fill(data): pass # 注文ステータスに変化があった場合に一度実行 def on_order_status(data): if data['code'][0] == TRADING_SECURITY: show_order_status(data) ################################ フレームワーク実装部分（読み飛ばし可） ############################### class OnTickClass(TickerHandlerBase): def on_recv_rsp(self, rsp_pb): on_tick() class OnBarClass(CurKlineHandlerBase): last_time = None def on_recv_rsp(self, rsp_pb): ret_code, data = super(OnBarClass, self).on_recv_rsp(rsp_pb) if ret_code == RET_OK: cur_time = data['time_key'][0] if cur_time != self.last_time and data['k_type'][0] == TRADING_PERIOD: if self.last_time is not None: on_bar_open() self.last_time = cur_time class OnOrderClass(TradeOrderHandlerBase): def on_recv_rsp(self, rsp_pb): ret, data = super(OnOrderClass, self).on_recv_rsp(rsp_pb) if ret == RET_OK: on_order_status( data) class OnFillClass(TradeDealHandlerBase): def on_recv_rsp(self, rsp_pb): ret, data = super(OnFillClass, self).on_recv_rsp(rsp_pb) if ret == RET_OK: on_fill(data) # メイン関数 if __name__ == '__main__': # 初期化戦略 if not on_init(): print('戦略の初期化に失敗、スクリプトを終了します！') quote_context.close() trade_context.close() else: # コールバックの設定 quote_context.set_handler(OnTickClass()) quote_context.set_handler(OnBarClass()) trade_context.set_handler(OnOrderClass()) trade_context.set_handler(OnFillClass()) # 銘柄のティック、ローソク足、板情報を登録してデータを取得 quote_context.subscribe(code_list=[TRADING_SECURITY], subtype_list=[SubType.TICKER, SubType.ORDER_BOOK, TRADING_PERIOD]) ``` * **Output** ``` ************ 戦略実行開始 *********** ************************************* 【ポジション状況】 HK.00700 のポジション数量：0 【シグナル】 買いシグナル、新規買い建て。 【注文ステータス】 SUBMITTING {'銘柄コード': 'HK.00700', '価格': 597.5, '売買方向': 'BUY', '数量': 100.0} 【注文ステータス】 SUBMITTED {'銘柄コード': 'HK.00700', '価格': 597.5, '売買方向': 'BUY', '数量': 100.0} 【注文ステータス】 FILLED_ALL {'銘柄コード': 'HK.00700', '価格': 597.5, '売買方向': 'BUY', '数量': 100.0} ************************************* 【ポジション状況】 HK.00700 のポジション数量：100.0 【シグナル】 売りシグナル、ポジション決済。 【注文ステータス】 SUBMITTING {'銘柄コード': 'HK.00700', '価格': 596.5, '売買方向': 'SELL', '数量': 100.0} 【注文ステータス】 SUBMITTED {'銘柄コード': 'HK.00700', '価格': 596.5, '売買方向': 'SELL', '数量': 100.0} 【注文ステータス】 FILLED_ALL {'銘柄コード': 'HK.00700', '価格': 596.5, '売買方向': 'SELL', '数量': 100.0} ``` --- # 概要 * OpenD は moomoo API のゲートウェイプログラムで、ローカルPCまたはクラウドサーバー上で動作し、プロトコルリクエストを moomoo サーバーに中継して処理済みデータを返します。moomoo API プログラムを実行するための前提条件です。 * OpenD は Windows、MacOS、CentOS、Ubuntu の4つのプラットフォームをサポートしています。 * OpenD にはログイン機能が統合されています。実行時は **プラットフォームアカウント**（moomoo ID）、**メール**、**電話番号** と **ログインパスワード** でログインする必要があります。 * OpenD のログイン成功後、moomoo API が接続・通信するための Socket サービスが起動します。 ## OpenDをインストールする OpenD には現在2つのインストール・実行方法があります。いずれかをお選びください。 * GUI版 OpenD：GUIアプリケーションを提供し、操作が簡便です。特に初心者に適しています。インストールと実行は[GUI版 OpenD](../quick/opend-base.md)を参照してください。 * コマンドライン OpenD：コマンドライン実行プログラムを提供し、手動設定が必要です。コマンドラインに慣れているユーザーやサーバーで長時間稼働させるユーザーに適しています。インストールと実行は[コマンドライン OpenD](../opend/opend-cmd.md)を参照してください。 ## 実行時の操作 OpenD 実行中に、ユーザー枠、相場権限、接続状態、遅延統計を確認できます。また、API接続のクローズ、再ログイン、ログアウト等の運用操作も可能です。 具体的な方法は下表をご覧ください。 方法 | GUI版 OpenD | コマンドライン OpenD :-|:-|:- 直接方法 | GUIで確認・操作 | コマンドラインで[運用コマンド](../opend/opend-operate.md)を送信 間接方法 | Telnet で[運用コマンド](../opend/opend-operate.md)を送信 | Telnet で[運用コマンド](../opend/opend-operate.md)を送信 --- # コマンドライン OpenD ### ステップ1 ダウンロード * コマンドライン OpenD は Windows、MacOS、CentOS、Ubuntu の4つの OS をサポートしています。 * [moomoo 公式サイト](https://www.moomoo.com/download/OpenAPI)からダウンロードできます。 ![download-page](../img/mmdownload-page.png) ### ステップ2 解凍 * 前のステップでダウンロードしたファイルを解凍し、OpenD 設定ファイル OpenD.xml とプログラムパッケージデータファイル Appdata.dat を見つけます。 * OpenD.xml は OpenD プログラムの起動パラメータを設定するファイルです。存在しない場合、プログラムは正常に起動できません。 * Appdata.dat はプログラムが使用する大容量データのパッケージファイルです。パッケージ化によりデータダウンロードの遅延を削減します。存在しない場合、プログラムは正常に起動できません。 * コマンドライン OpenD はカスタムファイルパスをサポートしています。詳細は[コマンドライン起動パラメータ](./opend-cmd.md#8185)をご覧ください。 ### ステップ3 パラメータ設定 * 設定ファイル OpenD.xml を開いて編集します（下図参照）。基本的な使用にはアカウントとログインパスワードの変更のみ必要です。その他の高度な設定は下表に従って変更してください。 ![xml-config](../img/mmxml.png) **設定項目一覧**： 設定項目|説明 :-|:- ip|監視アドレス (指定可能： - 127.0.0.1（ローカルからの接続を監視） - 0.0.0.0（すべてのNICからの接続を監視） - 本機の特定NICアドレス未設定の場合デフォルト 127.0.0.1) api_port|API プロトコル受信ポート (未設定の場合デフォルト 11111 [コマンドライン起動パラメータ](./opend-cmd.md#8185)でも指定可能) login_account|ログインアカウント (プラットフォームID、メール、電話番号でのログインをサポート。[コマンドライン起動パラメータ](./opend-cmd.md#8185)でも指定可能 - プラットフォームID：moomoo IDを入力 - メール：xxxx@xx.com 形式 - 電話番号：国番号+電話番号、例 +1 xxxxxxxx) login_pwd|ログインパスワード（平文） (- 暗号文でも入力可能 - [コマンドライン起動パラメータ](./opend-cmd.md#8185)でも指定可能) login_pwd_md5|ログインパスワード暗号文（32桁 MD5 16進数表記） (- 暗号文と平文の両方がある場合は暗号文のみ使用 - 平文での入力も可能) lang|言語 (指定可能： - chs：簡体字中国語 - en：英語) log_level|OpenD ログレベル (指定可能： - no（ログなし） - debug（最も詳細） - info（やや詳細）未設定の場合デフォルト info) push_proto_type|プッシュプロトコルタイプ (プッシュプロトコルのボディ形式を指定。指定可能： - 0（pb 形式） - 1（json 形式）未設定の場合デフォルト pb 形式) qot_push_frequency|API 登録データプッシュ頻度制御 (- 単位：ミリ秒 - 現在ローソク足と分時は対象外 - 未設定の場合デフォルトで頻度制限なし) telnet_ip|リモート操作コマンド監視アドレス (未設定の場合デフォルト 127.0.0.1) telnet_port|リモート操作コマンド監視ポート (未設定の場合リモートコマンド無効) rsa_private_key|API プロトコル [RSA](../qa/other.md#3969) 暗号化秘密鍵（PKCS#1）ファイルの絶対パス (未設定の場合プロトコル暗号化なし) price_reminder_push|到達価格アラートプッシュを受信するか (指定可能： - 0：受信しない - 1：受信する（スクリプトで到達価格アラートコールバック関数 [set_handler](/ftapi/init.html#6075) の設定が必要）未設定の場合デフォルトで受信) auto_hold_quote_right|キックアウト後に自動で権限を取り戻すか (指定可能： - 0：いいえ - 1：はい（OpenD は相場権限がキックアウトされた後に自動で取り戻します。10秒以内に再度キックアウトされた場合、他の端末が最高相場権限を取得し、OpenD は再取得しません）未設定の場合デフォルトで自動取得) future_trade_api_time_zone|先物取引 API タイムゾーン (- 先物口座で**取引 API**を呼び出す際、時間はこのタイムゾーンルールに従う - [コマンドライン起動パラメータ](./opend-cmd.md#8185)でも指定可能) websocket_ip|WebSocket サービス監視アドレス (指定可能： - 127.0.0.1（ローカルからの接続を監視） - 0.0.0.0（すべてのNICからの接続を監視）未設定の場合デフォルト 127.0.0.1) websocket_port|WebSocket サービス監視ポート (未設定の場合 Websocket 無効) websocket_key_md5|鍵暗号文（32桁 MD5 16進数表記） (JavaScript スクリプト接続時に信頼できる接続かどうかの判定に使用) websocket_private_key|WebSocket 証明書秘密鍵ファイルパス (- 秘密鍵にパスワードは設定不可 - 証明書と同時に設定が必要 - 未設定の場合 Websocket 無効) websocket_cert|WebSocket 証明書ファイルパス (- 証明書と同時に設定が必要 - 未設定の場合 Websocket 無効) pdt_protection| PDT（パターンデイトレーダー）としてマークされることを防止する機能を有効にするか (**FUTU US 専用パラメータ**指定可能： - 0：いいえ - 1：はい（有効にすると、PDTとしてマークされそうな場合に注文をブロックしますが、マークされないことは保証されません。PDTとしてマークされた場合、口座資産が$25000未満の場合は新規建てができなくなります。）未設定の場合デフォルトで有効) dtcall_confirmation|日中取引マージンコール警告機能を有効にするか (**FUTU US 専用パラメータ**指定可能： - 0：いいえ - 1：はい（有効にすると、残りの日中取引購買力を超える新規建て注文をブロックします。本日中に対象銘柄を決済した場合、Day-Trading Call が発生し、入金のみで解除可能であることを通知します。）未設定の場合デフォルトで有効) :::tip ご注意 * 証券口座のセキュリティのため、監視アドレスがローカルでない場合、取引APIの使用には秘密鍵の設定が必須です。相場APIにはこの制限はありません。 * WebSocket の監視アドレスがローカルでない場合、SSL の設定が必要です。証明書の秘密鍵生成時にパスワードは設定できません。 * 暗号文は平文を 32 桁 MD5 で暗号化し 16 進数で表現したデータです。オンライン MD5 暗号化ツールの検索（第三者サイトでの計算には辞書攻撃のリスクがある点にご注意ください）または MD5 計算ツールのダウンロードで取得できます。32 桁 MD5 暗号文は下図の赤枠部分（e10adc3949ba59abbe56e057f20f883e）の通りです。 ![md5.png](../img/md5.png) * OpenD はデフォルトで同一ディレクトリの OpenD.xml を読み込みます。MacOS ではシステム保護機構により、実行時にランダムなパスが割り当てられ、元のパスが見つからない場合があります。その場合は以下の方法で対処してください。 - tar パッケージ内の fixrun.sh を実行 - コマンドラインパラメータ `-cfg_file` で設定ファイルパスを指定（下記参照） * ログレベルのデフォルトは info です。システム開発段階では、問題発生時の原因特定が困難になるため、ログを無効にしたり warning、error、fatal レベルに変更したりしないことを推奨します。 ::: ### ステップ4 コマンドラインで起動 * コマンドラインで前のステップの解凍フォルダ内の OpenD ファイルがあるディレクトリに移動し、以下のコマンドで OpenD.xml 設定ファイルのパラメータで起動します。 * Windows：`OpenD` * Linux：`./OpenD` * MacOS：`./OpenD.app/Contents/MacOS/OpenD` ::: details コマンドライン起動パラメータ * コマンドラインでパラメータを付けて起動することもできます。一部のパラメータは OpenD.xml 設定ファイルと共通です。パラメータ形式：`-key=value` ![startup-command-param.png](../img/startup-command-param.png) 例： * Windows：`OpenD.exe -login_account=100000 -login_pwd=123456 -lang=en` * Linux：`OpenD -login_account=100000 -login_pwd=123456 -lang=en` * MacOS：`./OpenD.app/Contents/MacOS/OpenD -login_account=100000 -login_pwd=123456 -lang=en` * 同一パラメータがコマンドラインと設定ファイルの両方に存在する場合、コマンドラインパラメータが優先されます。具体的なパラメータは以下の表をご覧ください。 **パラメータ一覧**： 設定項目|説明 :-|:- login_account|ログインアカウント (設定ファイルでも指定可能) login_pwd|ログインパスワード（平文） (- 暗号文でも入力可能 - 設定ファイルでも指定可能) login_pwd_md5|ログインパスワード暗号文（32桁 MD5 16進数表記） (- 暗号文と平文の両方がある場合は暗号文のみ使用 - 平文での入力も可能) cfg_file|OpenD 設定ファイルの絶対パス (未設定の場合プログラムと同じディレクトリの OpenD.xml を使用) console|コンソールを表示するか (- 0：非表示 - 1：表示未設定の場合デフォルトで表示) lang|言語 (- chs：簡体字中国語 - en：英語) api_ip|API サービス監視アドレス api_port|API プロトコル受信ポート help|コマンドライン起動パラメータを表示して、プログラムを終了 log_level|OpenD ログレベル (- no（ログなし） - debug（最も詳細） - info（やや詳細）) no_monitor|デーモンプロセスを起動するか (- 0：起動する - 1：起動しない) websocket_ip|WebSocket サービス監視アドレス (指定可能： - 127.0.0.1（ローカルからの接続を監視） - 0.0.0.0（すべてのNICからの接続を監視）) websocket_port|WebSocket サービス監視ポート (未設定の場合 Websocket 無効) websocket_private_key|WebSocket 証明書秘密鍵ファイルパス (- 秘密鍵にパスワードは設定不可 - 証明書と同時に設定が必要 - 未設定の場合 Websocket 無効) websocket_cert|WebSocket 証明書ファイルパス (- 証明書と同時に設定が必要 - 未設定の場合 Websocket 無効) websocket_key_md5|鍵暗号文（32桁 MD5 16進数表記） (JavaScript スクリプト接続時に信頼できる接続かどうかの判定に使用) price_reminder_push|到達価格アラートプッシュを受信するか (指定可能： - 0：受信しない - 1：受信する（スクリプトで到達価格アラートコールバック関数 [set_handler](/ftapi/init.html#6075) の設定が必要）未設定の場合デフォルトで受信) auto_hold_quote_right|キックアウト後に自動で権限を取り戻すか (指定可能： - 0：いいえ - 1：はい（OpenD は相場権限がキックアウトされた後に自動で取り戻します。10秒以内に再度キックアウトされた場合、他の端末が最高相場権限を取得し、OpenD は再取得しません）未設定の場合デフォルトで自動取得) future_trade_api_time_zone|先物取引 API タイムゾーン (先物口座で**取引 API**を呼び出す際、時間はこのタイムゾーンルールに従う) ::: --- # 運用コマンド コマンドラインまたは Telnet でコマンドを送信して OpenD を運用できます。 コマンド形式：`cmd -param_key1=param_value1 -param_key2=param_value2` `help -cmd=exit` を例に、Telnet の使い方を紹介します。 1. OpenD の起動パラメータで、Telnet アドレスと Telnet ポートを設定します。 ![telnet_GUI](../img/telnet_GUI.png) ![telnet_CMD](../img/telnet_CMD.jpg) 2. OpenD を起動します（Telnet も同時に起動されます）。 3. Telnet 経由で OpenD に `help -cmd=exit` コマンドを送信します。 ```python from telnetlib import Telnet with Telnet('127.0.0.1', 22222) as tn: # Telnet アドレス：127.0.0.1、Telnet ポート：22222 tn.write(b'help -cmd=exit\r\n') reply = b'' while True: msg = tn.read_until(b'\r\n', timeout=0.5) reply += msg if msg == b'': break print(reply.decode('gb2312')) ``` ## コマンドヘルプ `help -cmd=exit` 指定コマンドの詳細情報を表示。パラメータ未指定の場合はコマンド一覧を出力 * パラメータ: - cmd: コマンド ## プログラム終了 `exit` OpenD プログラムを終了 ## SMS認証コードのリクエスト `req_phone_verify_code ` SMS認証コードをリクエスト。デバイスロックが有効で、そのデバイスへの初回ログイン時にセキュリティ認証が必要な場合に使用します。 * 頻度制限: - 60秒以内に最大1回リクエスト可能 ## SMS認証コードの入力 `input_phone_verify_code -code=123456` SMS認証コードを入力し、ログインフローを続行します。 * パラメータ: - code: SMS認証コード * 頻度制限: - 60秒以内に最大10回リクエスト可能 ## 画像認証コードのリクエスト `req_pic_verify_code` 画像認証コードをリクエスト。ログインパスワードを複数回誤入力した場合に画像認証コードの入力が必要になります。 * 頻度制限: - 60秒以内に最大10回リクエスト可能 ## 画像認証コードの入力 `input_pic_verify_code -code=1234` 画像認証コードを入力し、ログインフローを続行します。 * パラメータ: - code: 画像認証コード * 頻度制限: - 60秒以内に最大10回リクエスト可能 ## 再ログイン `relogin -login_pwd=123456` ログインパスワードの変更やデバイスロックの有効化等により再ログインが必要な場合に使用します。現在のアカウントでの再ログインのみ可能で、アカウント切替はできません。 パスワードパラメータは主にログインパスワード変更時に使用します。パスワード未指定の場合は起動時のログインパスワードを使用します。 * パラメータ: - login_pwd: ログインパスワード（平文） - login_pwd_md5: ログインパスワード暗号文（32桁 MD5 16進数表記） * 頻度制限: - 1時間以内に最大10回リクエスト可能 ## 接続ポイントとの遅延測定 `ping ` 接続ポイントとの遅延を測定 * 頻度制限: - 60秒以内に最大10回リクエスト可能 ## 遅延統計レポートの表示 `show_delay_report -detail_report_path=D:/detail.txt -push_count_type=sr2cs` プッシュ遅延、リクエスト遅延、発注遅延を含む遅延統計レポートを表示します。毎日北京時間 6:00 にデータがクリアされます。 * パラメータ: - detail_report_path: ファイル出力パス（Mac では絶対パスのみサポート、相対パスは不可）。省略可能。未指定の場合はコンソールに出力 - Paramters: push_count_type: プッシュ遅延のタイプ（sr2ss、ss2cr、cr2cs、ss2cs、sr2cs）。デフォルト sr2cs。 + sr はサーバー受信時刻（現在、香港株のみこの時刻をサポート） + ss はサーバー送信時刻 + cr は OpenD 受信時刻 + cs は OpenD 送信時刻 ## API 接続のクローズ `close_api_conn -conn_id=123456` 指定の API 接続をクローズ。未指定の場合はすべてクローズ * パラメータ: - conn_id: API 接続 ID ## 登録状態の表示 `show_sub_info -conn_id=123456 -sub_info_path=D:/detail.txt` 指定接続の登録状態を表示。未指定の場合はすべて表示 * パラメータ: - conn_id: API 接続 ID - sub_info_path: ファイル出力パス（Mac では絶対パスのみサポート、相対パスは不可）。省略可能。未指定の場合はコンソールに出力 ## 最高相場権限のリクエスト `request_highest_quote_right` 高級相場権限が他のデバイス（デスクトップ端末/モバイル端末等）に占有されている場合、このコマンドで最高相場権限を再リクエストできます（この場合、ログイン中の他のデバイスでは高級相場が使用できなくなります）。 * 頻度制限: - 60秒以内に最大10回リクエスト可能 ## アップグレード `update` このコマンドを実行すると、OpenD をワンクリックで更新できます --- # 相場情報API一覧
モジュール API名 機能概要
リアルタイム相場情報 登録 subscribe リアルタイムデータの登録。銘柄コードと登録するデータタイプを指定します
unsubscribe 登録の解除
unsubscribe_all すべての登録を解除
query_subscription 登録情報の照会
プッシュコールバック StockQuoteHandlerBase 株価情報プッシュ
OrderBookHandlerBase 板情報プッシュ
CurKlineHandlerBase ローソク足プッシュ
TickerHandlerBase ティックプッシュ
RTDataHandlerBase タイムシェアプッシュ
BrokerHandlerBase ブローカーキュープッシュ
データ取得 get_market_snapshot マーケットスナップショットの取得
get_stock_quote 登録済み銘柄のリアルタイム株価情報データの取得（登録要件あり）
get_order_book リアルタイム板情報の取得
get_cur_kline 指定銘柄の直近num本のローソク足データをリアルタイム取得
get_rt_data 指定銘柄のタイムシェアデータの取得
get_rt_ticker 指定銘柄のリアルタイムティックの取得。直近num件のティックを取得
get_broker_queue 銘柄のブローカーキューの取得
基本データ get_market_state 銘柄の所属市場の市場ステータスを取得
get_capital_flow 個別銘柄の資金フローを取得
get_capital_distribution 個別銘柄の資金分布を取得
get_owner_plate 1銘柄または複数銘柄の所属セクター情報リストを取得
request_history_kline ローソク足を取得（事前にローソク足データのダウンロード不要）
get_rehab 指定銘柄の権利落ち調整係数を取得
get_financials_earnings_price_move 決算日前後の価格変動を取得
get_financials_earnings_price_history 決算日前後の株価履歴を取得
get_financials_statements 財務報告書を取得
get_financials_revenue_breakdown 主営構成を取得
get_research_analyst_consensus アナリスト評価コンセンサスの取得
get_research_rating_summary 評価サマリーの取得
get_research_morningstar_report モーニングスター調査レポートの取得
get_valuation_detail バリュエーション詳細の取得
get_valuation_plate_stock_list セクター/指数構成銘柄バリュエーションリストの取得
get_corporate_actions_dividends 配当情報の取得
get_corporate_actions_buybacks 自社株買い情報の取得
get_corporate_actions_stock_splits 株式分割情報の取得
get_shareholders_overview 株主持株概要の取得
get_shareholders_holding_changes 株主持株変動の取得
get_shareholders_holder_detail 株主持株明細の取得
get_shareholders_institutional 機関投資家保有株式の取得
get_insider_holder_list インサイダー保有株式リストの取得
get_insider_trade_list インサイダー取引の取得
get_company_profile 会社概要の取得
get_company_executives 役員情報の取得
get_company_executive_background 役員経歴の取得
get_company_operational_efficiency 経営効率の取得
get_top_ten_buy_sell_brokers 十大ブローカー売買データの取得
get_daily_short_volume 日次空売り出来高の取得
get_short_interest 空売り残高の取得
関連デリバティブ get_option_expiration_date 原資産銘柄からオプションチェーンの全満期日を照会
get_option_chain 原資産銘柄からオプションを照会
get_option_screen オプション銘柄スクリーニング、原資産属性とオプション属性の混合フィルタリングをサポート
get_warrant ワラントおよび関連デリバティブデータAPIの呼び出し
get_warrant_screen ワラントスクリーニング V2、45 列のワラント属性をカバー
get_referencestock_list 証券の関連データを取得
get_future_info 先物契約情報を取得
get_option_volatility オプション・ボラティリティ分析の取得
get_option_exercise_probability オプション行使確率の取得
get_option_strategy オプション戦略の取得
get_option_strategy_spread 有効スプレッドの取得
get_option_strategy_analysis オプション損益分析
get_option_quote オプションスナップショットの取得
get_option_market_statistic オプション市場統計
get_option_underlying_overview オプション原資産概要
get_option_underlying_his_statistic オプション原資産履歴統計
get_option_underlying_his_volatility オプション原資産履歴ボラティリティ
get_option_underlying_rank オプション原資産ランキング
get_option_rank オプション契約ランキング
get_option_event オプション異常取引
get_option_event_alert 異常取引アラート照会
set_option_event_alert 異常取引アラート設定
OptionEventHandlerBase オプション異常変動プッシュ
get_option_zero_dte_screener ゼロDTEオプションスクリーナー
get_option_zero_dte_contract ゼロDTEオプション契約一覧
get_option_earnings_screener 決算オプションスクリーナー
get_option_seller_screener オプション売り手スクリーナー
全市場スクリーニング get_stock_filter 条件スクリーニングの取得
get_stock_screen 条件スクリーニング V2、11 カテゴリ 244+ ファクター、複数フィールドソートと明示的取得をサポート
get_plate_stock 特定セクター内の銘柄リストの取得
get_plate_list セクターコレクション内のサブセクターリストの取得
get_stock_basicinfo 指定市場の特定タイプまたは特定銘柄の基本情報の取得
get_ipo_list 指定市場のIPOリストの取得
get_global_state グローバル市場ステータスの取得
request_trading_days 取引カレンダーの取得
get_search_quote 相場銘柄検索
get_search_news ニュース検索
市場 get_earnings_calendar 決算カレンダーの取得
get_macro_indicator_list マクロ指標リストの取得
get_macro_indicator_history マクロ指標履歴データを取得します
get_fed_watch_target_rate FedWatch目標金利確率の取得
get_fed_watch_dot_plot FedWatchドットプロットの取得
get_earnings_beat_rank 業績予想上振れランキングの取得
get_dividend_rank 配当ランキングの取得
get_dividend_calendar 配当カレンダーを取得します
get_economic_calendar 経済イベントカレンダーの取得
get_us_pre_market_rank プレマーケットランキングの取得
get_us_after_hours_rank アフターアワーズランキングの取得
get_us_overnight_rank ナイトセッションランキングの取得
get_top_movers_rank 値上がり値下がりランキングの取得
get_hot_list 人気ランキングの取得
get_short_selling_rank 空売り異常変動ランキングの取得
get_period_change_rank 期間騰落率の取得
get_high_dividend_soe_rank 高配当国有企業ランキングの取得
get_institution_list 機関リストの取得
get_institution_profile 機関プロフィールの取得
get_institution_distribution 機関保有の業種分布を取得します
get_institution_holding_change 機関保有変動の取得
get_institution_holding_list 機関保有リストの取得
get_ark_fund_holding ARKファンド保有の取得
get_ark_stock_dynamic ARK個別銘柄取引動態の取得
get_ark_active_transaction ARKアクティブ取引の取得
get_rating_change レーティング変動の取得
get_industrial_chain_list 産業チェーンリストを取得します
get_industrial_chain_detail 産業チェーン詳細を取得します
get_industrial_chain_by_plate セクター関連の産業チェーンを取得します
get_industrial_plate_info 産業セクター情報を取得します
get_industrial_plate_stock 産業セクター構成銘柄の取得
get_heat_map_data ヒートマップデータの取得
get_rise_fall_distribution 騰落分布の取得
テクニカル指標 get_indicator_list インジケーター一覧の取得
request_indicator_calc_async インジケーター計算を非同期で起動
IndicatorCalcHandlerBase インジケーター非同期計算結果のプッシュ
パーソナル get_history_kl_quota 使用済み枠の取得。現在の周期内にダウンロードした銘柄数
set_price_reminder 到達価格アラートの設定
get_price_reminder 特定銘柄（特定市場）に設定された到達価格アラートリストの取得
get_user_security_group ウォッチリストグループ一覧の取得
get_user_security 指定グループのウォッチリストの取得
modify_user_security 指定グループのウォッチリストの変更
PriceReminderHandlerBase 到達価格アラートのプッシュ
--- # 相場オブジェクト ## 接続の作成 `OpenQuoteContext(host='127.0.0.1', port=11111, is_encrypt=None, security_firm=SecurityFirm.NONE)` * **概要** 相場接続の作成と初期化 * **パラメータ** パラメータ|型|説明 :-|:-|:- host|str|OpenD がリスニングしている IP アドレス port|int|OpenD がリスニングしているポート is_encrypt|bool|暗号化を有効にするかどうか (- デフォルトは None で、[enable_proto_encrypt](../ftapi/init.md#1561) の設定を使用します - True：強制暗号化False：強制非暗号化) security_firm|[SecurityFirm](../trade/trade.md#6462)|相場証券会社 (- 暗号資産相場接続の作成時のみ適用 - デフォルト値：NONE - FUTUSECURITIES、FUTUINC、FUTUSG を指定した場合のみ有効 - 他の証券会社（MY/AU/JP/CA）または無効な値を指定するとエラーになります) * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111, is_encrypt=False) quote_ctx.close() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。 ``` ## 接続のクローズ `close()` * **概要** 相場 API クラスオブジェクトをクローズします。デフォルトでは、moomoo API 内部で作成されたスレッドがプロセスの終了を妨げるため、すべての Context を close した後にのみプロセスが正常終了できます。ただし [set_all_thread_daemon](../ftapi/init.md#4694) ですべての内部スレッドを daemon スレッドに設定すれば、Context の close を呼び出さなくてもプロセスを正常終了できます。 * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) quote_ctx.close() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。 ``` ## 起動 `start()` * **概要** プッシュデータの非同期受信を開始 ## 停止 `stop()` * **概要** プッシュデータの非同期受信を停止 --- # 登録・登録解除 ## **登録** `subscribe(code_list, subtype_list, is_first_push=True, subscribe_push=True, is_detailed_orderbook=False, extended_time=False, session=Session.NONE)` * **概要** 必要なリアルタイム情報の配信登録を行います。銘柄と登録するデータタイプを指定してください。 * **パラメータ** パラメータ|型|説明 :-|:-|:- code_list|list|登録する銘柄コードリスト (list内の要素タイプはstr) subtype_list|list|登録するデータタイプリスト (list内の要素タイプは[SubType](./quote.md#1868)) is_first_push|bool|登録成功後にキャッシュデータを即座にプッシュするかどうか (- True：キャッシュをプッシュスクリプトとOpenD間で切断・再接続が発生し、再登録時にTrueを設定すると、切断前の最後のデータを再プッシュします - False：キャッシュをプッシュしない。サーバーからの最新プッシュを待機) subscribe_push|bool|登録後にプッシュするかどうか (登録後、OpenDは[2種類のデータ取得方式](../qa/quote.html#5626)を提供しています。**リアルタイムデータ取得**方式のみ使用する場合、Falseに設定するとパフォーマンス消費を節約できます - True：プッシュする。**リアルタイムデータコールバック**方式を使用する場合はTrueに設定必須 - False：プッシュしない。**リアルタイムデータ取得**方式**のみ**使用する場合はFalseに設定推奨) is_detailed_orderbook|bool|詳細な板情報の注文明細を登録するかどうか (- 香港株SF相場情報権限での香港株ORDER_BOOKタイプの登録にのみ使用 - 米国株・米国先物LV2権限では詳細な板情報の注文明細は提供されません) extended_time|bool|米国株のプレ/アフターマーケットデータを許可するかどうか (米国株のリアルタイムローソク足、リアルタイム分時、リアルタイムティックの登録にのみ使用) session|[Session](./quote.md#123)|米国株の登録時間帯 (- 米国株のリアルタイムローソク足、リアルタイム分時、リアルタイムティックの登録にのみ使用 - 米国株の相場情報登録ではOVERNIGHTパラメータは非対応 - 最低OpenDバージョン：9.2.4207) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
err_message NoneType 当 ret == RET_OK 时，返す None
str 当 ret != RET_OK 时，返すエラー説明
* **Example** ``` python import time from moomoo import * class OrderBookTest(OrderBookHandlerBase): def on_recv_rsp(self, rsp_pb): ret_code, data = super(OrderBookTest,self).on_recv_rsp(rsp_pb) if ret_code != RET_OK: print("OrderBookTest: error, msg: %s" % data) return RET_ERROR, data print("OrderBookTest ", data) # OrderBookTest 独自の処理ロジック return RET_OK, data quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) handler = OrderBookTest() quote_ctx.set_handler(handler) # リアルタイム板情報コールバックの設定 quote_ctx.subscribe(['US.AAPL'], [SubType.ORDER_BOOK]) # 板情報タイプを登録すると、OpenD はサーバーからのプッシュを継続的に受信開始 time.sleep(15) # スクリプトが OpenD のプッシュを受信する時間を15秒に設定 quote_ctx.close() # 接続をクローズすると、OpenD は1分後に対応銘柄の登録を自動解除 ``` * **Output** ``` python OrderBookTest {'code': 'US.AAPL', 'name': '苹果', 'svr_recv_time_bid': '2025-04-07 05:00:52.266', 'svr_recv_time_ask': '2025-04-07 05:00:53.973', 'Bid': [(180.2, 15, 3, {}), (180.19, 1, 1, {}), (180.18, 11, 2, {}), (180.14, 200, 1, {}), (180.13, 3, 2, {}), (180.1, 99, 3, {}), (180.05, 3, 1, {}), (180.03, 400, 1, {}), (180.02, 10, 1, {}), (180.01, 100, 1, {}), (180.0, 441, 24, {})], 'Ask': [(180.3, 100, 1, {}), (180.38, 4, 2, {}), (180.4, 100, 1, {}), (180.42, 200, 1, {}), (180.46, 29, 1, {}), (180.5, 1019, 2, {}), (180.6, 1000, 1, {}), (180.8, 2001, 3, {}), (180.84, 15, 2, {}), (181.0, 2036, 4, {}), (181.2, 2000, 2, {}), (181.3, 3, 1, {}), (181.4, 2021, 3, {}), (181.5, 59, 2, {}), (181.79, 9, 1, {}), (181.8, 20, 1, {}), (181.9, 94, 4, {}), (181.98, 20, 1, {}), (182.0, 150, 7, {})]} ``` ## **登録解除** `unsubscribe(code_list, subtype_list, unsubscribe_all=False)` * **概要** 登録解除 * **パラメータ** パラメータ|型|説明 :-|:-|:- code_list|list|登録解除する銘柄コードリスト (list内の要素タイプはstr) subtype_list|list|登録するデータタイプリスト (list内の要素タイプは[SubType](./quote.md#1868)) unsubscribe_all|bool|すべての登録を解除 (為 True 时無視其他パラメータ) * **Return**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
err_message NoneType 当 ret == RET_OK, 返す None
str 当 ret != RET_OK, 返すエラー説明
* **Example** ``` python from moomoo import * import time quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) print('current subscription status :', quote_ctx.query_subscription()) # 初期登録状態を確認 ret_sub, err_message = quote_ctx.subscribe(['US.AAPL'], [SubType.QUOTE, SubType.TICKER], subscribe_push=False, session=Session.None) # まずAAPLの全時間帯でQUOTEとTICKERの2タイプを登録。登録成功後、OpenDはサーバーからのプッシュを継続的に受信。Falseはスクリプトへのプッシュ不要を意味する if ret_sub == RET_OK: # 登録成功 print('subscribe successfully！current subscription status :', quote_ctx.query_subscription()) # 登録成功後に登録状態を確認 time.sleep(60) # 登録後、少なくとも1分経過しないと登録解除できません ret_unsub, err_message_unsub = quote_ctx.unsubscribe(['US.AAPL'], [SubType.QUOTE]) if ret_unsub == RET_OK: print('unsubscribe successfully！current subscription status:', quote_ctx.query_subscription()) # 登録解除後に登録状態を確認 else: print('unsubscription failed！', err_message_unsub) else: print('subscription failed', err_message) quote_ctx.close() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。 ``` * **Output** ``` python current subscription status : (0, {'total_used': 0, 'remain': 1000, 'own_used': 0, 'sub_list': {}}) subscribe successfully！current subscription status : (0, {'total_used': 2, 'remain': 998, 'own_used': 2, 'sub_list': {'QUOTE': ['US.AAPL'], 'TICKER': ['US.AAPL']}}) unsubscribe successfully！current subscription status: (0, {'total_used': 1, 'remain': 999, 'own_used': 1, 'sub_list': {'TICKER': ['US.AAPL']}}) ``` ## **すべての登録を解除** `unsubscribe_all()` * **概要** すべての登録を解除 * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
err_message NoneType 当 ret == RET_OK, 返す None
str 当 ret != RET_OK, 返すエラー説明
* **Example** ``` python from moomoo import * import time quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) print('current subscription status :', quote_ctx.query_subscription()) # 初期登録状態を確認 ret_sub, err_message = quote_ctx.subscribe(['US.AAPL'], [SubType.QUOTE, SubType.TICKER], subscribe_push=False, session=Session.None) # まずAAPLの全時間帯でQUOTEとTICKERの2タイプを登録。登録成功後、OpenDはサーバーからのプッシュを継続的に受信。Falseはスクリプトへのプッシュ不要を意味する if ret_sub == RET_OK: # 登録成功 print('subscribe successfully！current subscription status :', quote_ctx.query_subscription()) # 登録成功後に登録状態を確認 time.sleep(60) # 登録後、少なくとも1分経過しないと登録解除できません ret_unsub, err_message_unsub = quote_ctx.unsubscribe_all() # すべての登録を解除 if ret_unsub == RET_OK: print('unsubscribe all successfully！current subscription status:', quote_ctx.query_subscription()) # 登録解除後に登録状態を確認 else: print('Failed to cancel all subscriptions！', err_message_unsub) else: print('subscription failed', err_message) quote_ctx.close() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。 ``` * **Output** ``` python current subscription status : (0, {'total_used': 0, 'remain': 1000, 'own_used': 0, 'sub_list': {}}) subscribe successfully！current subscription status : (0, {'total_used': 2, 'remain': 998, 'own_used': 2, 'sub_list': {'QUOTE': ['US.AAPL'], 'TICKER': ['US.AAPL']}}) unsubscribe all successfully！current subscription status: (0, {'total_used': 0, 'remain': 1000, 'own_used': 0, 'sub_list': {}}) ``` ::: tip APIレート制限 - 複数のリアルタイムデータタイプの登録に対応しています。[SubType](./quote.md#1868) を参照してください。銘柄ごとに1タイプの登録で1枠を消費します。 - 登録枠ルール請を参照 [登録枠 & 過去ローソク足データ枠](../intro/authority.md#8582)。 - 登録後、少なくとも1分経過しないと登録解除できません。 - 香港株 SF 相場情報の板情報はデータ量が大きいため、SF 相場情報の速度と OpenD の処理性能を確保するために、現在 SF 権限ユーザーは同時に50銘柄（HKEX の正株、ワラント、CBBC を含む）の板情報・ブローカーキューのみ登録可能です。残りの登録枠は引き続きティック、売買ブローカーなどの他のタイプの登録に使用できます。 - 香港株オプション先物在 LV1 権限下，不対応登録ティックタイプ。 ::: --- # 登録状態の取得 `query_subscription(is_all_conn=True)` * **概要** 登録情報の取得 * **パラメータ** パラメータ|型|説明 :-|:-|:- is_all_conn|bool|全接続の登録状態を返すかどうか (True：全接続の登録状態を返すFalse：現在の接続の登録状態のみ返す) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data dict ret == RET_OK の場合、登録情報データを返します
str ret != RET_OK の場合、エラーの説明を返す
* 登録情報データの辞書フォーマット： { 'total_used': 4, # 全接続で使用済みの登録枠 'own_used': 0, # 現在の接続で使用済みの登録枠 'remain': 496, # 残りの登録枠 'own_security_firm': 'FUTUSECURITIES', # 現在の接続の証券会社識別子 'sub_list': # 各登録タイプに対応する銘柄リスト { '登録のタイプ': 当該登録タイプの全登録済み銘柄リスト, … } } * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) quote_ctx.subscribe(['HK.00700'], [SubType.QUOTE]) ret, data = quote_ctx.query_subscription() if ret == RET_OK: print(data) else: print('error:', data) quote_ctx.close() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。 ``` * **Output** ```python {'total_used': 1, 'remain': 999, 'own_used': 1, 'own_security_firm': 'N/A', 'sub_list': {'QUOTE': ['HK.00700']}} ``` --- # リアルタイム株価情報コールバック `on_recv_rsp(self, rsp_pb)` * **概要** リアルタイム株価情報コールバック。登録済み株式のリアルタイム株価情報プッシュを非同期処理します。 リアルタイム株価情報データプッシュの受信時にこの関数がコールバックされます。派生クラスで on_recv_rsp をオーバーライドしてください。 * **パラメータ** パラメータ|型|説明 :-|:-|:- rsp_pb|Qot_UpdateBasicQot_pb2.Response|派生クラスでは直接処理不要 * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、株価情報データを返します
str ret != RET_OK の場合、エラーの説明を返す
* 株価情報データのフォーマット： フィールド|タイプ|説明 :-|:-|:- code|str|銘柄コード data_date|str|日付 data_time|str|現在値の更新時刻 (フォーマット：yyyy-MM-dd HH:mm:ss 香港株およびA株市場はデフォルトで北京時間、米国株市場はデフォルトで米国東部時間) last_price|float|最新価格 open_price|float|今日始値 high_price|float|高値 low_price|float|安値 prev_close_price|float|昨終値格 volume|float|出来高 turnover|float|売買代金 turnover_rate|float|売買回転率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) amplitude|int|振幅 (パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します) suspension|bool|かどうか売買停止 (True：売買停止中) listing_date|str|上場日 (フォーマット：yyyy-MM-dd) price_spread|float|現在の上方スプレッド (板情報の売り板における隣接価格帯のスプレッド) dark_status|[DarkStatus](./quote.md#3558)|ダークプール取引ステータス sec_status|[SecurityStatus](./quote.md#9969)|株式状態 strike_price|float|行使価格 contract_size|float|1契約あたりの数量 open_interest|int|未決済建玉数 implied_volatility|float|インプライドボラティリティ (パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します) premium|float|プレミアム (パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します) delta|float|グリークス Delta gamma|float|グリークス Gamma vega|float|グリークス Vega theta|float|グリークス Theta rho|float|グリークス Rho index_option_type|[IndexOptionType](./quote.md#1635)|指数オプションタイプ net_open_interest|int|純未決済建玉数 (香港株オプションのみ) expiry_date_distance|int|満期日までの日数 (負数は期限切れを示します) contract_nominal_value|float|契約想定元本 (香港株オプションのみ) owner_lot_multiplier|float|相当原資産ロット数 (指数オプションにはこのフィールドはありません。香港株オプションのみ) option_area_type|[OptionAreaType](./quote.md#1635)|オプションタイプ（按行權時間） contract_multiplier|float|契約乗数 pre_price|float|プレマーケット価格 pre_high_price|float|プレマーケット高値 pre_low_price|float|プレマーケット安値 pre_volume|int|プレマーケット出来高 pre_turnover|float|プレマーケット売買代金 pre_change_val|float|プレマーケット騰落額 pre_change_rate|float|プレマーケット騰落率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) pre_amplitude|float|プレマーケット振幅 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) after_price|float|アフターマーケット価格 after_high_price|float|アフターマーケット高値 after_low_price|float|アフターマーケット安値 after_volume|int|時間外取引出来高 (科創板で対応) after_turnover|float|時間外取引売買代金 (科創板で対応) after_change_val|float|アフターマーケット騰落額 after_change_rate|float|アフターマーケット騰落率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) after_amplitude|float|アフターマーケット振幅 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) overnight_price|float|夜間取引価格 overnight_high_price|float|夜間取引高値 overnight_low_price|float|夜間取引安値 overnight_volume|int|夜間取引出来高 overnight_turnover|float|夜間取引売買代金 overnight_change_val|float|夜間取引騰落額 overnight_change_rate|float|夜間取引騰落率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) overnight_amplitude|float|夜間取引振幅 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) last_settle_price|float|前日決済値 (先物固有フィールド) position|float|ポジション数量 (先物固有フィールド) position_change|float|日次ポジション増減 (先物固有フィールド) * **Example** ```python import time from moomoo import * class StockQuoteTest(StockQuoteHandlerBase): def on_recv_rsp(self, rsp_pb): ret_code, data = super(StockQuoteTest,self).on_recv_rsp(rsp_pb) if ret_code != RET_OK: print("StockQuoteTest: error, msg: %s" % data) return RET_ERROR, data print("StockQuoteTest ", data) # StockQuoteTest 独自の処理ロジック return RET_OK, data quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) handler = StockQuoteTest() quote_ctx.set_handler(handler) # リアルタイム株価情報コールバックを設定 ret, data = quote_ctx.subscribe(['US.AAPL'], [SubType.QUOTE]) # リアルタイム株価情報タイプを登録、OpenD がサーバーからのプッシュを継続的に受信開始 if ret == RET_OK: print(data) else: print('error:', data) time.sleep(15) # スクリプトが OpenD のプッシュを受信する時間を15秒に設定 quote_ctx.close() # 接続をクローズすると、OpenD は1分後に対応銘柄の登録を自動解除 ``` * **Output** ```python StockQuoteTest code name data_date data_time last_price open_price high_price low_price prev_close_price volume turnover turnover_rate amplitude suspension listing_date price_spread dark_status sec_status strike_price contract_size open_interest implied_volatility premium delta gamma vega theta rho net_open_interest expiry_date_distance contract_nominal_value owner_lot_multiplier option_area_type contract_multiplier last_settle_price position position_change index_option_type pre_price pre_high_price pre_low_price pre_volume pre_turnover pre_change_val pre_change_rate pre_amplitude after_price after_high_price after_low_price after_volume after_turnover after_change_val after_change_rate after_amplitude overnight_price overnight_high_price overnight_low_price overnight_volume overnight_turnover overnight_change_val overnight_change_rate overnight_amplitude 0 US.AAPL 苹果 0.0 0.0 0.0 0.0 0.0 0 0.0 0.0 0.0 False 0.0 N/A NORMAL N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A ``` :::tip ご注意 * このAPIは継続的にプッシュデータを取得する機能を提供します。一括でリアルタイムデータを取得する場合は [リアルタイム株価情報取得](./get-stock-quote.md) APIをご利用ください * リアルタイムデータの取得とリアルタイムデータコールバックの違いについては、 [如何から登録 API で取得してくださいリアルタイム相場情報？](../qa/quote.md#8509) ::: --- # リアルタイム板情報コールバック `on_recv_rsp(self, rsp_pb)` * **概要** リアルタイム板情報コールバック。登録済み株式のリアルタイム板情報プッシュを非同期処理します。 リアルタイム板情報データプッシュの受信時にこの関数がコールバックされます。派生クラスで on_recv_rsp をオーバーライドしてください。 * **パラメータ** パラメータ|型|説明 :-|:-|:- rsp_pb|Qot_UpdateOrderBook_pb2.Response|派生クラスでは直接処理不要 * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data dict ret == RET_OK の場合、板情報データ
str ret != RET_OK の場合、エラーの説明を返す
* 板情報データフォーマットは以下の通り： フィールド|タイプ|説明 :-|:-|:- code|str|銘柄コード name|str|銘柄名 svr_recv_time_bid|str| moomoo サーバーが取引所から買い板データを受信した時刻 (一部のデータの受信時刻がゼロになる場合があります（例：サーバー再起動時や初回プッシュのキャッシュデータ）) svr_recv_time_ask|str| moomoo サーバーが取引所から売り板データを受信した時刻 (一部のデータの受信時刻がゼロになる場合があります（例：サーバー再起動時や初回プッシュのキャッシュデータ）) order_book_type|[OrderBookType](./quote.md#4171)|板情報タイプ Bid|list|各タプルに以下の情報を含む：委託価格、委託数量、委託注文数、委託注文明細 (委託注文明細 - 明細内容：取引所注文 ID、1注文あたりの委託数量 - 香港株 SF 権限では最大 1000 件の委託注文明細に対応；その他の相場情報利用権限ではこのデータの取得に対応していません) Ask|list|各タプルに以下の情報を含む：委託価格、委託数量、委託注文数、委託注文明細 (委託注文明細 - 明細内容：取引所注文 ID、1注文あたりの委託数量 - 香港株 SF 権限では最大 1000 件の委託注文明細に対応；その他の相場情報利用権限ではこのデータの取得に対応していません) Bid と Ask フィールドの構造体は以下の通りです： 'Bid': [ (bid_price1, bid_volume1, order_num, {'orderid1': order_volume1, 'orderid2': order_volume2, …… }), (bid_price2, bid_volume2, order_num, {'orderid1': order_volume1, 'orderid2': order_volume2, …… }),…] 'Ask': [ (ask_price1, ask_volume1，order_num, {'orderid1': order_volume1, 'orderid2': order_volume2, …… }), (ask_price2, ask_volume2, order_num, {'orderid1': order_volume1, 'orderid2': order_volume2, …… }),…] * **Example** ```python import time from moomoo import * class OrderBookTest(OrderBookHandlerBase): def on_recv_rsp(self, rsp_pb): ret_code, data = super(OrderBookTest,self).on_recv_rsp(rsp_pb) if ret_code != RET_OK: print("OrderBookTest: error, msg: %s" % data) return RET_ERROR, data print("OrderBookTest ", data) # OrderBookTest 独自の処理ロジック return RET_OK, data quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) handler = OrderBookTest() quote_ctx.set_handler(handler) # リアルタイム板情報コールバックの設定 ret, data = quote_ctx.subscribe(['US.AAPL'], [SubType.ORDER_BOOK]) # 板情報タイプを登録すると、OpenD はサーバーからのプッシュを継続的に受信開始 if ret == RET_OK: print(data) else: print('error:', data) time.sleep(15) # スクリプトが OpenD のプッシュを受信する時間を15秒に設定 quote_ctx.close() # 接続をクローズすると、OpenD は1分後に対応銘柄の登録を自動解除 ``` * **Output** ```python OrderBookTest {'code': 'US.AAPL', 'name': '苹果', 'svr_recv_time_bid': '', 'svr_recv_time_ask': '', 'order_book_type': 'NORMAL', 'Bid': [(179.77, 100, 1, {}), (179.68, 200, 1, {}), (179.65, 2, 2, {}), (179.64, 27, 1, {}), (179.6, 9, 2, {}), (179.58, 39, 2, {}), (179.5, 13, 4, {}), (179.48, 331, 2, {}), (179.4, 1002, 2, {}), (179.38, 330, 1, {}), (179.37, 2, 1, {}), (179.3, 47, 1, {}), (179.28, 330, 1, {}), (179.21, 2, 1, {}), (179.2, 1000, 1, {}), (179.18, 330, 1, {}), (179.17, 100, 1, {}), (179.16, 1, 1, {}), (179.13, 400, 1, {}), (179.1, 3000, 1, {}), (179.08, 330, 1, {}), (179.05, 125, 2, {}), (179.01, 17, 2, {}), (179.0, 81, 7, {})], 'Ask': [(179.95, 400, 2, {}), (180.0, 360, 2, {}), (180.05, 20, 1, {}), (180.1, 246, 4, {}), (180.18, 20, 1, {}), (180.2, 2030, 3, {}), (180.23, 20, 1, {}), (180.3, 23, 1, {}), (180.33, 15, 1, {}), (180.4, 2000, 2, {}), (180.49, 5, 1, {}), (180.59, 253, 1, {}), (180.6, 2000, 2, {}), (180.8, 2010, 3, {}), (181.0, 2018, 4, {}), (181.08, 1, 1, {}), (181.2, 1009, 2, {}), (181.3, 17, 3, {}), (181.4, 1, 1, {}), (181.5, 50, 1, {}), (181.79, 9, 1, {}), (181.9, 66, 2, {})]} ``` :::tip ご注意 * このAPIは継続的にプッシュデータを取得する機能を提供します。一括でリアルタイムデータを取得する場合は [リアルタイム板情報取得](./get-order-book.md) APIをご利用ください * リアルタイムデータの取得とリアルタイムデータコールバックの違いについては、 [如何から登録 API で取得してくださいリアルタイム相場情報？](../qa/quote.md#8509) * 米国株市場のリアルタイム板情報コールバックは、現在の取引時間帯のリアルタイム板情報を継続的にプッシュします。時間帯の設定は不要です。 ::: --- # リアルタイムローソク足コールバック `on_recv_rsp(self, rsp_pb)` * **概要** リアルタイムローソク足コールバック。登録済み株式のリアルタイムローソク足プッシュを非同期処理します。 リアルタイム ローソク足データプッシュの受信時にこの関数がコールバックされます。派生クラスで on_recv_rsp をオーバーライドしてください。 * **パラメータ** パラメータ|型|説明 :-|:-|:- rsp_pb|Qot_UpdateKL_pb2.Response|派生クラスでは直接処理不要 * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、 ローソク足データデータ
str ret != RET_OK の場合、エラーの説明を返す
* ローソク足データフォーマットは以下の通りです： フィールド|タイプ|説明 :-|:-|:- code|str|銘柄コード name|str|銘柄名 time_key|str|時間 (フォーマット：yyyy-MM-dd HH:mm:ss 香港株と A 株市場のデフォルトは北京時間、米国株市場のデフォルトは米国東部時間) open|float|始値 close|float|終値 high|float|高値 low|float|安値 volume|float|出来高 turnover|float|売買代金 pe_ratio|float|PER turnover_rate|float|売買回転率 (このフィールドはパーセントフィールドで、デフォルトでは小数を返します。例：0.01 は実際には 1% に対応します) last_close|float|前のローソク足の終値 (前のローソク足の終値を指します効率上の理由から、最初のデータの last_close は 0 になる場合があります) k_type|[KLType](./quote.md#6493)|ローソク足タイプ * **Example** ```python import time from moomoo import * class CurKlineTest(CurKlineHandlerBase): def on_recv_rsp(self, rsp_pb): ret_code, data = super(CurKlineTest,self).on_recv_rsp(rsp_pb) if ret_code != RET_OK: print("CurKlineTest: error, msg: %s" % data) return RET_ERROR, data print("CurKlineTest ", data) # CurKlineTest 独自の処理ロジック return RET_OK, data quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) handler = CurKlineTest() quote_ctx.set_handler(handler) # リアルタイムローソク足コールバックを設定 ret, data = quote_ctx.subscribe(['US.AAPL'], [SubType.K_1M], session=Session.ALL) # ローソク足データタイプを登録、OpenD がサーバーからのプッシュを継続的に受信開始 if ret == RET_OK: print(data) else: print('error:', data) time.sleep(15) # スクリプトが OpenD のプッシュを受信する時間を15秒に設定 quote_ctx.close() # 接続をクローズすると、OpenD は1分後に対応銘柄の登録を自動解除 ``` * **Output** ```python CurKlineTest code name time_key open close high low volume turnover k_type last_close 0 US.AAPL 苹果 2025-04-07 05:15:00 180.39 180.26 180.46 180.2 1322.0 238340.48 K_1M 0.0 ``` :::tip ご注意 * このAPIは継続的にプッシュデータを取得する機能を提供します。一括でリアルタイムデータを取得する場合は [リアルタイムローソク足取得](./get-kl.md) APIをご利用ください * リアルタイムデータの取得とリアルタイムデータコールバックの違いについては、 [如何から登録 API で取得してくださいリアルタイム相場情報？](../qa/quote.md#8509) * **オプション**，日足、1分足、5分足、15分足、60分足のみ提供しています。 ::: --- # リアルタイム分時コールバック `on_recv_rsp(self, rsp_pb)` * **概要** リアルタイム分時コールバック。登録済み株式のリアルタイム分時プッシュを非同期処理します。 リアルタイム分時データプッシュの受信時にこの関数がコールバックされます。派生クラスで on_recv_rsp をオーバーライドしてください。 * **パラメータ** パラメータ|型|説明 :-|:-|:- rsp_pb|Qot_UpdateRT_pb2.Response|派生クラスでは直接処理不要 * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、分时データ
str ret != RET_OK の場合、エラーの説明を返す
* 分時データフォーマットは以下の通りです： フィールド|タイプ|説明 :-|:-|:- code|str|銘柄コード name|str|銘柄名 time|str|時間 (フォーマット：yyyy-MM-dd HH:mm:ss 香港株と A 株市場のデフォルトは北京時間、米国株市場のデフォルトは米国東部時間) is_blank|bool|データ状態 (False：正常データTrue：伪造データ) opened_mins|int|0時から現在までの経過分数 cur_price|float|現在価格 last_close|float|前日終値 avg_price|float|平均価格 (対于オプション，このフィールド為 None) volume|float|出来高 turnover|float|売買代金 * **Example** ```python import time from moomoo import * class RTDataTest(RTDataHandlerBase): def on_recv_rsp(self, rsp_pb): ret_code, data = super(RTDataTest, self).on_recv_rsp(rsp_pb) if ret_code != RET_OK: print("RTDataTest: error, msg: %s" % data) return RET_ERROR, data print("RTDataTest ", data) # RTDataTest 独自の処理ロジック return RET_OK, data quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) handler = RTDataTest() quote_ctx.set_handler(handler) # リアルタイム分時プッシュコールバックを設定 ret, data = quote_ctx.subscribe(['US.AAPL'], [SubType.RT_DATA], session=Session.ALL) # 分時タイプを登録、OpenD がサーバーからのプッシュを継続的に受信開始 if ret == RET_OK: print(data) else: print('error:', data) time.sleep(15) # スクリプトが OpenD のプッシュを受信する時間を15秒に設定 quote_ctx.close() # 接続をクローズすると、OpenD は1分後に対応銘柄の登録を自動解除 ``` * **Output** ```python RTDataTest code name time is_blank opened_mins cur_price last_close avg_price turnover volume 0 US.AAPL 苹果 2025-04-07 05:24:00 False 324 179.53 188.38 180.465762 651262.42 3624 ``` :::tip ご注意 * このAPIは継続的にプッシュデータを取得する機能を提供します。一括でリアルタイムデータを取得する場合は [リアルタイム分時取得](./get-rt.md) APIをご利用ください * リアルタイムデータの取得とリアルタイムデータコールバックの違いについては、 [如何から登録 API で取得してくださいリアルタイム相場情報？](../qa/quote.md#8509) ::: --- # リアルタイムティックコールバック `on_recv_rsp(self, rsp_pb)` * **概要** リアルタイムティックコールバック。登録済み株式のリアルタイムティックプッシュを非同期処理します。 リアルタイムティックデータプッシュの受信時にこの関数がコールバックされます。派生クラスで on_recv_rsp をオーバーライドしてください。 * **パラメータ** パラメータ|型|説明 :-|:-|:- rsp_pb|Qot_UpdateTicker_pb2.Response|派生クラスでは直接処理不要 * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、ティックデータを返します
str ret != RET_OK の場合、エラーの説明を返す
* ティックデータのフォーマット： フィールド|タイプ|説明 :-|:-|:- code|str|銘柄コード name|str|銘柄名 sequence|int|ティック番号 time|str|約定時間 (フォーマット：yyyy-MM-dd HH:mm:ss 香港株およびA株市場はデフォルトで北京時間、米国株市場はデフォルトで米国東部時間) price|float|約定価格 volume|float|約定数量 (株数) turnover|float|売買代金 ticker_direction|[TickerDirect](./quote.md#6022)|ティック方向 type|[TickerType](./quote.md#6022)|ティックタイプ push_data_type|[PushDataType](./quote.md#8447)|データ来源 * **Example** ```python import time from moomoo import * class TickerTest(TickerHandlerBase): def on_recv_rsp(self, rsp_pb): ret_code, data = super(TickerTest,self).on_recv_rsp(rsp_pb) if ret_code != RET_OK: print("TickerTest: error, msg: %s" % data) return RET_ERROR, data print("TickerTest ", data) # TickerTest 独自の処理ロジック return RET_OK, data quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) handler = TickerTest() quote_ctx.set_handler(handler) # リアルタイムティックプッシュコールバックを設定 ret, data = quote_ctx.subscribe(['US.AAPL'], [SubType.TICKER], session=Session.ALL) # ティックタイプを登録、OpenD がサーバーからのプッシュを継続的に受信開始 if ret == RET_OK: print(data) else: print('error:', data) time.sleep(15) # スクリプトが OpenD のプッシュを受信する時間を15秒に設定 quote_ctx.close() # 接続をクローズすると、OpenD は1分後に対応銘柄の登録を自動解除 ``` * **Output** ```python TickerTest code name time price volume turnover ticker_direction sequence type push_data_type 0 US.AAPL 苹果 2025-04-07 05:25:44.116 179.81 9.0 1618.29 NEUTRAL 7490500033117159426 ODD_LOT CACHE ``` :::tip ご注意 * このAPIは継続的にプッシュデータを取得する機能を提供します。一括でリアルタイムデータを取得する場合は [リアルタイムティック取得](./get-ticker.md) APIをご利用ください * リアルタイムデータの取得とリアルタイムデータコールバックの違いについては、 [如何から登録 API で取得してくださいリアルタイム相場情報？](../qa/quote.md#8509) * 相場情報の接続が切断・再接続された後、OpenDは切断期間中の直近（最大50件）のティックデータを取得しプッシュします。ティックプッシュタイプフィールドで区別できます ::: --- # リアルタイムブローカーキューコールバック `on_recv_rsp(self, rsp_pb)` * **概要** リアルタイムブローカーキューコールバック。登録済み株式のリアルタイムブローカーキュープッシュを非同期処理します。 リアルタイムブローカーキューデータプッシュの受信時にこの関数がコールバックされます。派生クラスで on_recv_rsp をオーバーライドしてください。 * **パラメータ** パラメータ|型|説明 :-|:-|:- rsp_pb|Qot_UpdateBroker_pb2.Response|派生クラスでは直接処理不要 * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data tuple 当 ret == RET_OK，返すブローカーキューデータ
str ret != RET_OK の場合、エラーの説明を返す
* ブローカーキューのタプル内容は以下の通りです： フィールド|タイプ|説明 :-|:-|:- stock_code|str|株式 bid_frame_table|pd.DataFrame|買い板データ ask_frame_table|pd.DataFrame|売り板データ * bid_frame_table フォーマットは以下の通り： フィールド|タイプ|説明 :-|:-|:- code|str|銘柄コード name|str|銘柄名 bid_broker_id|int|ブローカー買い板 ID bid_broker_name|str|ブローカー買い気配名称 bid_broker_pos|int|ブローカー档位 order_id|int|取引所注文 ID (- 発注 API が返す注文 ID ではありません - 香港株 SF 相場情報の利用権限でのみこのフィールドを返します) order_volume|int|単笔委託数量 (只有香港株 SF 相場情報の利用権限対応返すこのフィールド) * ask_frame_table フォーマットは以下の通り： フィールド|タイプ|説明 :-|:-|:- code|str|銘柄コード name|str|銘柄名 ask_broker_id|int|ブローカー売り板 ID ask_broker_name|str|ブローカー売り気配名称 ask_broker_pos|int|ブローカー档位 order_id|int|取引所注文 ID (- 発注 API が返す注文 ID ではありません - 香港株 SF 相場情報の利用権限でのみこのフィールドを返します) order_volume|int|単笔委託数量 (只有香港株 SF 相場情報の利用権限対応返すこのフィールド) * **Example** ```python import time from moomoo import * class BrokerTest(BrokerHandlerBase): def on_recv_rsp(self, rsp_pb): ret_code, err_or_stock_code, data = super(BrokerTest, self).on_recv_rsp(rsp_pb) if ret_code != RET_OK: print("BrokerTest: error, msg: {}".format(err_or_stock_code)) return RET_ERROR, data print("BrokerTest: stock: {} data: {} ".format(err_or_stock_code, data)) # BrokerTest 独自の処理ロジック return RET_OK, data quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) handler = BrokerTest() quote_ctx.set_handler(handler) # リアルタイムブローカープッシュコールバックを設定 ret, data = quote_ctx.subscribe(['HK.00700'], [SubType.BROKER]) # ブローカータイプを登録、OpenD がサーバーからのプッシュを継続的に受信開始 if ret == RET_OK: print(data) else: print('error:', data) time.sleep(15) # スクリプトが OpenD のプッシュを受信する時間を15秒に設定 quote_ctx.close() # 接続をクローズすると、OpenD は1分後に対応銘柄の登録を自動解除 ``` * **Output** ```python BrokerTest: stock: HK.00700 data: [ code name bid_broker_id bid_broker_name bid_broker_pos order_id order_volume 0 HK.00700 腾讯控股 5338 J.P.摩根 1 N/A N/A .. ... ... ... ... ... ... ... 36 HK.00700 腾讯控股 8305 富途证券国际(香港)有限公司 4 N/A N/A [37 rows x 7 columns], code name ask_broker_id ask_broker_name ask_broker_pos order_id order_volume 0 HK.00700 腾讯控股 1179 华泰金融控股(香港)有限公司 1 N/A N/A .. ... ... ... ... ... ... ... 39 HK.00700 腾讯控股 6996 中国投资信息有限公司 1 N/A N/A [40 rows x 7 columns]] ``` :::tip ご注意 * このAPIは継続的にプッシュデータを取得する機能を提供します。一括でリアルタイムデータを取得する場合は [リアルタイムブローカーキュー取得](./get-broker.md) APIをご利用ください * リアルタイムデータの取得とリアルタイムデータコールバックの違いについては、 [如何から登録 API で取得してくださいリアルタイム相場情報？](../qa/quote.md#8509) * 香港株 LV1 権限下，ブローカーキューデータの取得はサポートされていません ::: --- # 取得スナップショット `get_market_snapshot(code_list)` * **概要** スナップショットデータの取得 * **パラメータ** パラメータ|型|説明 :-|:-|:- code_list|list|銘柄コードリスト (1 回のリクエストで最大 400 銘柄までlist 内の要素の型は str) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、株式スナップショットデータ
str ret != RET_OK の場合、エラーの説明を返す
* 株式スナップショットデータフォーマットは以下の通りです： フィールド|タイプ|説明 :-|:-|:- code|str|銘柄コード name|str|銘柄名 update_time|str|現在値更新時間 (フォーマット：yyyy-MM-dd HH:mm:ss 香港株と A 株市場のデフォルトは北京時間、米国株市場のデフォルトは米国東部時間) last_price|float|最新価格 open_price|float|今日始値 high_price|float|高値 low_price|float|安値 prev_close_price|float|昨終値格 volume|float|出来高 turnover|float|売買代金 turnover_rate|float|売買回転率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) suspension|bool|かどうか売買停止 (True：売買停止中) listing_date|str|上場日 (フォーマット：yyyy-MM-dd) equity_valid|bool|正株かどうか (このフィールドが True の場合、以下の正株関連フィールドに有効な値が入ります) issued_shares|int|総株式数 total_market_val|float|時価総額 (単位：元) net_asset|int|純資産 net_profit|int|純利益 earning_per_share|float|EPS outstanding_shares|int|流通株式数 net_asset_per_share|float|一株当たり純資産 circular_market_val|float|流通時価総額 (単位：元) ey_ratio|float|益回り (このフィールドは比率フィールドで、デフォルトでは % を表示しません) pe_ratio|float|PER (このフィールドは比率フィールドで、デフォルトでは % を表示しません) pb_ratio|float|PBR (このフィールドは比率フィールドで、デフォルトでは % を表示しません) pe_ttm_ratio|float|PER TTM (このフィールドは比率フィールドで、デフォルトでは % を表示しません) dividend_ttm|float|配当金 TTM，配当 dividend_ratio_ttm|float|配当利回り TTM (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) dividend_lfy|float|配当金 LFY，上一年度配当 dividend_lfy_ratio|float|配当利回り LFY (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) stock_owner|str|ワラントが属する正株のコード、またはオプションの原資産株コード wrt_valid|bool|ワラントかどうか (このフィールドが True の場合、以下のワラント関連フィールドに有効な値が入ります) wrt_conversion_ratio|float|換株比率 wrt_type|[WrtType](./quote.md#1608)|ワラントタイプ wrt_strike_price|float|行使価格 wrt_maturity_date|str|フォーマット化ワラント到期時間 wrt_end_trade|str|フォーマット化ワラント最后取引時間 wrt_leverage|float|レバレッジ比率 (単位：倍) wrt_ipop|float|インザマネー/アウトオブザマネー (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) wrt_break_even_point|float|損益分岐点 wrt_conversion_price|float|換株価格 wrt_price_recovery_ratio|float|正株の回収価格までの距離 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) wrt_score|float|ワラント総合スコア wrt_code|str|ワラントに対応する正株（このフィールドは廃止済みです。変更先： stock_owner） wrt_recovery_price|float|ワラント回収価格 wrt_street_vol|float|ワラント街貨量 wrt_issue_vol|float|ワラント発行量 wrt_street_ratio|float|ワラント街貨比率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) wrt_delta|float|ワラントデルタ値 wrt_implied_volatility|float|ワラントIV（インプライドボラティリティ） wrt_premium|float|ワラントプレミアム (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) wrt_upper_strike_price|float|上限価 (インラインワラントのみこのフィールドに対応) wrt_lower_strike_price|float|下限価 (インラインワラントのみこのフィールドに対応) wrt_inline_price_status|[PriceType](./quote.md#3508)|界内/界外 (インラインワラントのみこのフィールドに対応) wrt_issuer_code|str|発行体コード option_valid|bool|オプションかどうか (このフィールドが True の場合、以下のオプション関連フィールドに有効な値が入ります) option_type|[OptionType](./quote.md#1635)|オプションタイプ strike_time|str|オプション行使日 (フォーマット：yyyy-MM-dd 香港株と A 株市場のデフォルトは北京時間、米国株市場のデフォルトは米国東部時間) option_strike_price|float|行使価格 option_contract_size|float|1 契約あたりの株数 option_open_interest|int|未決済建玉数 option_implied_volatility|float|IV（インプライドボラティリティ） option_premium|float|プレミアム option_delta|float|グリークス Delta option_gamma|float|グリークス Gamma option_vega|float|グリークス Vega option_theta|float|グリークス Theta option_rho|float|グリークス Rho index_option_type|[IndexOptionType](./quote.md#1635)|指数オプションタイプ option_net_open_interest|int|ネット未決済建玉数 (香港株オプションのみ適用) option_expiry_date_distance|int|距离満期日天数 (負の数は満期済みを示します) option_contract_nominal_value|float|契約想定元本 (香港株オプションのみ適用) option_owner_lot_multiplier|float|相等正株手数 (指数オプションにはこのフィールドはありません，香港株オプションのみ適用) option_area_type|[OptionAreaType](./quote.md#1635)|オプションタイプ（按行權時間） option_contract_multiplier|float|契約乗数 plate_valid|bool|セクタータイプかどうか (このフィールドが True の場合、以下のセクター関連フィールドに有効な値が入ります) plate_raise_count|int|セクタータイプ上昇銘柄数 plate_fall_count|int|セクタータイプ下落銘柄数 plate_equal_count|int|セクタータイプ平盤支数 index_valid|bool|指数タイプかどうか (このフィールドが True の場合、以下の指数関連フィールドに有効な値が入ります) index_raise_count|int|指数タイプ上昇銘柄数 index_fall_count|int|指数タイプ下落銘柄数 index_equal_count|int|指数タイプ平盤支数 lot_size|int|1手あたりの株数。株式オプションの場合は1枚あたりの株数 (指数オプションにはこのフィールドはありません)、先物の場合は契約乗数 price_spread|float|現在の上方向の板情報スプレッド (板情報データの最良売り気配の隣接値幅における気配値差) ask_price|float|売値 bid_price|float|買値 ask_vol|float|売り数量 bid_vol|float|買い数量 enable_margin|bool|信用買い可能かどうか（廃止済み） (をご利用ください [信用取引データ取得](../trade/get-margin-ratio.html) API で取得してください) mortgage_ratio|float|株式担保率（廃止済み） long_margin_initial_ratio|float|信用買い初期証拠金率（廃止済み） (をご利用ください [信用取引データ取得](../trade/get-margin-ratio.html) API で取得してください) enable_short_sell|bool|空売り可能かどうか（廃止済み） (をご利用ください [信用取引データ取得](../trade/get-margin-ratio.html) API で取得してください) short_sell_rate|float|空売り参考利率（廃止済み） (をご利用ください [信用取引データ取得](../trade/get-margin-ratio.html) API で取得してください) short_available_volume|int|残りの空売り可能数量（廃止済み） (をご利用ください [信用取引データ取得](../trade/get-margin-ratio.html) API で取得してください) short_margin_initial_ratio|float|空売り（信用売り）初期証拠金率（廃止済み） (をご利用ください [信用取引データ取得](../trade/get-margin-ratio.html) API で取得してください) sec_status|[SecurityStatus](./quote.md#9969)|株式状態 amplitude|float|振幅 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) avg_price|float|平均価 bid_ask_ratio|float|委託比率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) volume_ratio|float|出来高比率 highest52weeks_price|float|52 周高値 lowest52weeks_price|float|52 周安値 highest_history_price|float|過去高値 lowest_history_price|float|過去安値 pre_price|float|プレマーケット価格 pre_high_price|float|プレマーケット高値 pre_low_price|float|プレマーケット安値 pre_volume|int|プレマーケット出来高 pre_turnover|float|プレマーケット売買代金 pre_change_val|float|プレマーケット騰落額 pre_change_rate|float|プレマーケット騰落率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) pre_amplitude|float|プレマーケット振幅 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) after_price|float|アフターマーケット価格 after_high_price|float|アフターマーケット高値 after_low_price|float|アフターマーケット安値 after_volume|int|アフターマーケット出来高 (科創板はこのデータに対応しています) after_turnover|float|アフターマーケット売買代金 (科創板はこのデータに対応しています) after_change_val|float|アフターマーケット騰落額 after_change_rate|float|アフターマーケット騰落率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) after_amplitude|float|アフターマーケット振幅 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) overnight_price|float|夜間取引価格 overnight_high_price|float|夜間取引高値 overnight_low_price|float|夜間取引安値 overnight_volume|int|夜間取引出来高 overnight_turnover|float|夜間取引売買代金 overnight_change_val|float|夜間取引騰落額 overnight_change_rate|float|夜間取引騰落率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) overnight_amplitude|float|夜間取引振幅 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) future_valid|bool|かどうか先物 future_last_settle_price|float|前日決済値 future_position|float|建玉数 future_position_change|float|日次建玉変動 future_main_contract|bool|かどうか主連契約 future_last_trade_time|str|最后取引時間 (主連、当月、翌月等の先物にはこのフィールドはありません) trust_valid|bool|かどうか基金 trust_dividend_yield|float|配当利回り (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) trust_aum|float|資産規模 (単位：元) trust_outstanding_units|int|総発行口数 trust_netAssetValue|float|基準価額 trust_premium|float|プレミアム (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) trust_assetClass|[AssetClass](./quote.md#3508)|資産種別 * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_market_snapshot(['HK.00700', 'US.AAPL']) if ret == RET_OK: print(data) print(data['code'][0]) # 最初のレコードの銘柄コードを取得 print(data['code'].values.tolist()) # list に変換 else: print('error:', data) quote_ctx.close() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。 ``` * **Output** ```python code name update_time last_price open_price high_price low_price prev_close_price volume turnover turnover_rate suspension listing_date lot_size price_spread stock_owner ask_price bid_price ask_vol bid_vol enable_margin mortgage_ratio long_margin_initial_ratio enable_short_sell short_sell_rate short_available_volume short_margin_initial_ratio amplitude avg_price bid_ask_ratio volume_ratio highest52weeks_price lowest52weeks_price highest_history_price lowest_history_price close_price_5min after_volume after_turnover sec_status equity_valid issued_shares total_market_val net_asset net_profit earning_per_share outstanding_shares circular_market_val net_asset_per_share ey_ratio pe_ratio pb_ratio pe_ttm_ratio dividend_ttm dividend_ratio_ttm dividend_lfy dividend_lfy_ratio wrt_valid wrt_conversion_ratio wrt_type wrt_strike_price wrt_maturity_date wrt_end_trade wrt_recovery_price wrt_street_vol \ 0 HK.00700 腾讯控股 2025-04-07 16:09:07 435.40 441.80 462.40 431.00 497.80 123364114.0 5.499476e+10 1.341 False 2004-06-16 100 0.20 NaN 435.4 435.20 281300 17300 NaN NaN NaN NaN NaN NaN NaN 6.308 445.792 -68.499 5.627 547.00000 294.400000 706.100065 -13.202011 431.60 0 0.000000e+00 NORMAL True 9202391012 4.006721e+12 1.051300e+12 2.095753e+11 22.774 9202391012 4.006721e+12 114.242 0.199 19.118 3.811 19.118 3.48 0.80 3.48 0.799 False NaN N/A NaN NaN NaN NaN NaN 1 US.AAPL 苹果 2025-04-07 05:30:43.301 188.38 193.89 199.88 187.34 203.19 125910913.0 2.424473e+10 0.838 False 1980-12-12 1 0.01 NaN 180.8 180.48 29 400 NaN NaN NaN NaN NaN NaN NaN 6.172 192.554 86.480 2.226 259.81389 163.300566 259.813890 0.053580 188.93 3151311 5.930968e+08 NORMAL True 15022073000 2.829858e+12 6.675809e+10 9.133420e+10 6.080 15016677308 2.828842e+12 4.444 1.417 30.983 42.389 29.901 0.99 0.53 0.98 0.520 False NaN N/A NaN NaN NaN NaN NaN wrt_issue_vol wrt_street_ratio wrt_delta wrt_implied_volatility wrt_premium wrt_leverage wrt_ipop wrt_break_even_point wrt_conversion_price wrt_price_recovery_ratio wrt_score wrt_upper_strike_price wrt_lower_strike_price wrt_inline_price_status wrt_issuer_code option_valid option_type strike_time option_strike_price option_contract_size option_open_interest option_implied_volatility option_premium option_delta option_gamma option_vega option_theta option_rho option_net_open_interest option_expiry_date_distance option_contract_nominal_value option_owner_lot_multiplier option_area_type option_contract_multiplier index_option_type index_valid index_raise_count index_fall_count index_equal_count plate_valid plate_raise_count plate_fall_count plate_equal_count future_valid future_last_settle_price future_position future_position_change future_main_contract future_last_trade_time trust_valid trust_dividend_yield trust_aum \ 0 NaN NaN NaN NaN NaN NaN NaN NaN NaN NaN NaN NaN NaN N/A NaN False N/A NaN NaN NaN NaN NaN NaN NaN NaN NaN NaN NaN NaN NaN NaN NaN N/A NaN N/A False NaN NaN NaN False NaN NaN NaN False NaN NaN NaN NaN NaN False NaN NaN 1 NaN NaN NaN NaN NaN NaN NaN NaN NaN NaN NaN NaN NaN N/A NaN False N/A NaN NaN NaN NaN NaN NaN NaN NaN NaN NaN NaN NaN NaN NaN NaN N/A NaN N/A False NaN NaN NaN False NaN NaN NaN False NaN NaN NaN NaN NaN False NaN NaN trust_outstanding_units trust_netAssetValue trust_premium trust_assetClass pre_price pre_high_price pre_low_price pre_volume pre_turnover pre_change_val pre_change_rate pre_amplitude after_price after_high_price after_low_price after_change_val after_change_rate after_amplitude overnight_price overnight_high_price overnight_low_price overnight_volume overnight_turnover overnight_change_val overnight_change_rate overnight_amplitude 0 NaN NaN NaN N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A 1 NaN NaN NaN N/A 180.68 181.98 177.47 276016 49809244.83 -7.7 -4.087 2.394 186.6 188.639 186.44 -1.78 -0.944 1.1673 176.94 186.5 174.4 533115 94944250.56 -11.44 -6.072 6.4231 HK.00700 ['HK.00700', 'US.AAPL'] ``` :::tip APIレート制限 * 30 秒以内に最大 60 次スナップショット。 * 1回のリクエストにつき、APIパラメータ **銘柄コードリスト** で指定できる原資産数の上限は 400 個です。 ::: --- # リアルタイム株価情報の取得 `get_stock_quote(code_list)` * **概要** 登録済み株式のリアルタイム株価情報を取得します。事前に登録が必要です。 * **パラメータ** パラメータ|型|説明 :-|:-|:- code_list|list|銘柄コードリスト (list 内の要素の型は str) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、株価情報データを返します
str ret != RET_OK の場合、エラーの説明を返す
* 株価情報データのフォーマット： フィールド|タイプ|説明 :-|:-|:- code|str|銘柄コード name|str|銘柄名 data_date|str|日付 data_time|str|現在値の更新時刻 (フォーマット：yyyy-MM-dd HH:mm:ss 香港株およびA株市場はデフォルトで北京時間、米国株市場はデフォルトで米国東部時間) last_price|float|最新価格 open_price|float|今日始値 high_price|float|高値 low_price|float|安値 prev_close_price|float|昨終値格 volume|float|出来高 turnover|float|売買代金 turnover_rate|float|売買回転率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) amplitude|int|振幅 (パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します) suspension|bool|かどうか売買停止 (True：売買停止中) listing_date|str|上場日 (フォーマット：yyyy-MM-dd) price_spread|float|現在の上方スプレッド (板情報の売り板における隣接価格帯のスプレッド) dark_status|[DarkStatus](./quote.md#3558)|ダークプール取引ステータス sec_status|[SecurityStatus](./quote.md#9969)|株式状態 strike_price|float|行使価格 contract_size|float|1契約あたりの数量 open_interest|int|未決済建玉数 implied_volatility|float|インプライドボラティリティ (パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します) premium|float|プレミアム (パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します) delta|float|グリークス Delta gamma|float|グリークス Gamma vega|float|グリークス Vega theta|float|グリークス Theta rho|float|グリークス Rho index_option_type|[IndexOptionType](./quote.md#1635)|指数オプションタイプ net_open_interest|int|純未決済建玉数 (香港株オプションのみ) expiry_date_distance|int|満期日までの日数 (負数は期限切れを示します) contract_nominal_value|float|契約想定元本 (香港株オプションのみ) owner_lot_multiplier|float|相当原資産ロット数 (指数オプションにはこのフィールドはありません。香港株オプションのみ) option_area_type|[OptionAreaType](./quote.md#1635)|オプションタイプ（按行權時間） contract_multiplier|float|契約乗数 pre_price|float|プレマーケット価格 pre_high_price|float|プレマーケット高値 pre_low_price|float|プレマーケット安値 pre_volume|int|プレマーケット出来高 pre_turnover|float|プレマーケット売買代金 pre_change_val|float|プレマーケット騰落額 pre_change_rate|float|プレマーケット騰落率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) pre_amplitude|float|プレマーケット振幅 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) after_price|float|アフターマーケット価格 after_high_price|float|アフターマーケット高値 after_low_price|float|アフターマーケット安値 after_volume|int|時間外取引出来高 (科創板で対応) after_turnover|float|時間外取引売買代金 (科創板で対応) after_change_val|float|アフターマーケット騰落額 after_change_rate|float|アフターマーケット騰落率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) after_amplitude|float|アフターマーケット振幅 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) overnight_price|float|夜間取引価格 overnight_high_price|float|夜間取引高値 overnight_low_price|float|夜間取引安値 overnight_volume|int|夜間取引出来高 overnight_turnover|float|夜間取引売買代金 overnight_change_val|float|夜間取引騰落額 overnight_change_rate|float|夜間取引騰落率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) overnight_amplitude|float|夜間取引振幅 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) last_settle_price|float|前日決済値 (先物固有フィールド) position|float|ポジション数量 (先物固有フィールド) position_change|float|日次ポジション増減 (先物固有フィールド) * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret_sub, err_message = quote_ctx.subscribe(['US.AAPL'], [SubType.QUOTE], subscribe_push=False) # まずローソク足タイプを登録。登録成功後 OpenD はサーバーからのプッシュを継続的に受信。False は一時的にスクリプトへのプッシュが不要であることを示す if ret_sub == RET_OK: # 登録成功 ret, data = quote_ctx.get_stock_quote(['US.AAPL']) # 登録済み銘柄のリアルタイム株価情報データを取得 if ret == RET_OK: print(data) print(data['code'][0]) # 最初のレコードの銘柄コードを取得 print(data['code'].values.tolist()) # list に変換 else: print('error:', data) else: print('subscription failed', err_message) quote_ctx.close() # 接続をクローズすると、OpenD は1分後に対応銘柄の登録を自動解除 ``` * **Output** ```python code name data_date data_time last_price open_price high_price low_price prev_close_price volume turnover turnover_rate amplitude suspension listing_date price_spread dark_status sec_status strike_price contract_size open_interest implied_volatility premium delta gamma vega theta rho net_open_interest expiry_date_distance contract_nominal_value owner_lot_multiplier option_area_type contract_multiplier last_settle_price position position_change index_option_type pre_price pre_high_price pre_low_price pre_volume pre_turnover pre_change_val pre_change_rate pre_amplitude after_price after_high_price after_low_price after_volume after_turnover after_change_val after_change_rate after_amplitude overnight_price overnight_high_price overnight_low_price overnight_volume overnight_turnover overnight_change_val overnight_change_rate overnight_amplitude 0 US.AAPL 苹果 2025-04-07 05:37:21.794 188.38 193.89 199.88 187.34 203.19 125910913.0 2.424473e+10 0.838 6.172 False 1980-12-12 0.01 N/A NORMAL N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A 181.43 181.98 177.47 288853 52132735.18 -6.95 -3.689 2.394 186.6 188.639 186.44 3151311 5.930968e+08 -1.78 -0.944 1.1673 176.94 186.5 174.4 533115 94944250.56 -11.44 -6.072 6.4231 US.AAPL ['US.AAPL'] ``` :::tip ご注意 * このAPIは一括でリアルタイムデータを取得する機能を提供します。継続的なプッシュデータが必要な場合は、[リアルタイム株価情報コールバック](./update-stock-quote.md) APIを参照してください * リアルタイムデータの取得とリアルタイムデータコールバックの違いについては、 [如何から登録 API で取得してくださいリアルタイム相場情報？](../qa/quote.md#8509) ::: --- # 取得リアルタイム板情報 `get_order_book(code, num=10, order_book_type=None)` * **概要** 登録済み株式のリアルタイム板情報を取得します。事前に登録が必要です。 * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|銘柄コード num|int|リクエスト板情報档数 (板情報档数取得上限請参见 [板情報档数明细](../qa/quote.md#470)) order_book_type|[OrderBookType](./quote.md#4171)|板情報タイプ、指定しない場合はデフォルトで整株板を返す * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data dict ret == RET_OK の場合、板情報データ
str ret != RET_OK の場合、エラーの説明を返す
* 板情報データフォーマットは以下の通りです： フィールド|タイプ|説明 :-|:-|:- code|str|銘柄コード name|str|銘柄名 svr_recv_time_bid|str|moomooサーバーが取引所から買い板データを受信した時間 (一部のデータの受信時間がゼロの場合があります（例：サーバー再起動時や初回プッシュのキャッシュデータ）) svr_recv_time_ask|str|moomooサーバーが取引所から売り板データを受信した時間 (一部のデータの受信時間がゼロの場合があります（例：サーバー再起動時や初回プッシュのキャッシュデータ）) order_book_type|[OrderBookType](./quote.md#4171)|板情報タイプ Bid|list|各タプルに以下の情報を含む：委託価格、委託数量、委託注文数、委託注文明細 (委託注文明細 - 明細内容：取引所注文 ID、1注文あたりの委託数量 - 香港株 SF 権限では最大 1000 件の委託注文明細に対応；その他の相場情報利用権限ではこのデータの取得に対応していません) Ask|list|各タプルに以下の情報を含む：委託価格、委託数量、委託注文数、委託注文明細 (委託注文明細 - 明細内容：取引所注文 ID、1注文あたりの委託数量 - 香港株 SF 権限では最大 1000 件の委託注文明細に対応；その他の相場情報利用権限ではこのデータの取得に対応していません) Bid と Ask フィールドの構造は以下の通りです： 'Bid': [ (bid_price1, bid_volume1, order_num, {'orderid1': order_volume1, 'orderid2': order_volume2, …… }), (bid_price2, bid_volume2, order_num, {'orderid1': order_volume1, 'orderid2': order_volume2, …… }),…] 'Ask': [ (ask_price1, ask_volume1，order_num, {'orderid1': order_volume1, 'orderid2': order_volume2, …… }), (ask_price2, ask_volume2, order_num, {'orderid1': order_volume1, 'orderid2': order_volume2, …… }),…] * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret_sub = quote_ctx.subscribe(['US.AAPL'], [SubType.ORDER_BOOK], subscribe_push=False)[0] # まず売買板情報タイプを登録。登録成功後 OpenD はサーバーからのプッシュを継続的に受信。False は一時的にスクリプトへのプッシュが不要であることを示す if ret_sub == RET_OK: # 登録成功 ret, data = quote_ctx.get_order_book('US.AAPL', num=3) # 取得一次 3 档リアルタイム板情報データ if ret == RET_OK: print(data) else: print('error:', data) else: print('subscription failed') quote_ctx.close() # 当該接続を切断すると、OpenD は 1 分後に自動的に対応する株式の対応タイプの登録を解除する ``` * **Output** ```python {'code': 'US.AAPL', 'name': '苹果', 'svr_recv_time_bid': '2025-04-07 05:39:20.352', 'svr_recv_time_ask': '2025-04-07 05:39:20.352', 'order_book_type': 'NORMAL', 'Bid': [(181.17, 227.0, 2, {}), (181.15, 2.0, 2, {}), (181.12, 100.0, 1, {})], 'Ask': [(181.71, 200.0, 1, {}), (181.79, 9.0, 1, {}), (181.9, 616.0, 3, {})]} ``` :::tip APIレート制限 * moomoo サーバーが取引所からデータを受信した時間フィールドは、A株正株、香港株正株、ETF、ワラント、CBBCのみ対応しており、取引時間中のみこのデータがあります。 * moomoo サーバーが取引所からデータを受信した時間フィールドは、一部の場合に受信時間がゼロになることがあります（例：サーバー再起動時や初回プッシュのキャッシュデータ）。 ::: :::tip ご注意 * このAPIはリアルタイムデータをワンショットで取得する機能を提供しています。継続的にプッシュデータを取得するには [リアルタイム板情報コールバック](./update-order-book.md) API * リアルタイムデータの取得とリアルタイムデータコールバックの違いについては、 [如何から登録 API で取得してくださいリアルタイム相場情報？](../qa/quote.md#8509) * 米国株市場では、現在の取引セッションのリアルタイム板情報データが返されます。セッションの設定は不要です。 ::: --- # 取得リアルタイム ローソク足 `get_cur_kline(code, num, ktype=KLType.K_DAY, autype=AuType.QFQ)` * **概要** 登録済み株式のリアルタイムローソク足データを取得します。事前に登録が必要です。 * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|銘柄コード name|str|銘柄名 num|int|ローソク足データ個数 (最大 1000 根) ktype|[KLType](./quote.md#6493)|ローソク足タイプ autype|[AuType](./quote.md#2928)|復権タイプ * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、 ローソク足データデータ
str ret != RET_OK の場合、エラーの説明を返す
* ローソク足データフォーマットは以下の通りです： フィールド|タイプ|説明 :-|:-|:- code|str|銘柄コード name|str|銘柄名 time_key|str|時間 (フォーマット：yyyy-MM-dd HH:mm:ss 香港株と A 株市場のデフォルトは北京時間、米国株市場のデフォルトは米国東部時間) open|float|始値 close|float|終値 high|float|高値 low|float|安値 volume|int|出来高 turnover|float|売買代金 pe_ratio|float|PER turnover_rate|float|売買回転率 (このフィールドはパーセントフィールドで、デフォルトでは小数を返します。例：0.01 は実際には 1% に対応します) last_close|float|前のローソク足の終値 (前のローソク足の終値です効率化のため、最初のデータの last_close は 0 となる場合があります) * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret_sub, err_message = quote_ctx.subscribe(['US.AAPL'], [SubType.K_DAY], subscribe_push=False, session=Session.ALL) # まずローソク足タイプを登録。登録成功後 OpenD はサーバーからのプッシュを継続的に受信。False は一時的にスクリプトへのプッシュが不要であることを示す if ret_sub == RET_OK: # 登録成功 ret, data = quote_ctx.get_cur_kline('US.AAPL', 2, KLType.K_DAY, AuType.QFQ) # 米国株 AAPL の直近 2 本のローソク足データを取得 if ret == RET_OK: print(data) print(data['turnover_rate'][0]) # 最初のレコードの売買回転率を取得 print(data['turnover_rate'].values.tolist()) # list に変換 else: print('error:', data) else: print('subscription failed', err_message) quote_ctx.close() # 接続をクローズすると、OpenD は1分後に対応銘柄の登録を自動解除 ``` * **Output** ```python code name time_key open close high low volume turnover pe_ratio turnover_rate last_close 0 US.AAPL 苹果 2025-04-03 00:00:00 205.54 203.19 207.49 201.25 103419006.0 2.111773e+10 33.419 0.00689 223.89 1 US.AAPL 苹果 2025-04-04 00:00:00 193.89 188.38 199.88 187.34 125910913.0 2.424473e+10 30.983 0.00838 203.19 0.00689 [0.00689, 0.00838] ``` :::tip APIレート制限 * このAPIはリアルタイムローソク足取得APIで、最大直近1000本を取得できます。過去ローソク足データの取得については [取得過去ローソク足データ](../quote/request-history-kline.md) * PER と売買回転率フィールドは、日足以上の周期の正株のみデータがあります * **オプション**，日足、1分足、5分足、15分足、60分足のみ提供しています。 ::: :::tip ご注意 * このAPIはリアルタイムデータをワンショットで取得する機能を提供しています。継続的にプッシュデータを取得するには [リアルタイム ローソク足コールバック](./update-kl.md) API * リアルタイムデータの取得とリアルタイムデータコールバックの違いについては、 [如何から登録 API で取得してくださいリアルタイム相場情報？](../qa/quote.md#8509) ::: --- # 取得リアルタイム分时 `get_rt_data(code)` * **概要** 登録済み株式のリアルタイム分時データを取得します。事前に登録が必要です。 * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|株式 * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、分时データ
str ret != RET_OK の場合、エラーの説明を返す
* 分時データフォーマットは以下の通りです： フィールド|タイプ|説明 :-|:-|:- code|str|銘柄コード name|str|銘柄名 time|str|時間 (フォーマット：yyyy-MM-dd HH:mm:ss 香港株と A 株市場のデフォルトは北京時間、米国株市場のデフォルトは米国東部時間) is_blank|bool|データ状態 (False：正常データTrue：伪造データ) opened_mins|int|0時から現在までの経過分数 cur_price|float|現在価格 last_close|float|前日終値 avg_price|float|平均価格 (対于オプション，このフィールド為 N/A) volume|float|出来高 turnover|float|売買代金 * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret_sub, err_message = quote_ctx.subscribe(['US.AAPL'], [SubType.RT_DATA], subscribe_push=False, session=Session.ALL) # まず分時データタイプを登録。登録成功後 OpenD はサーバーからのプッシュを継続的に受信。False は一時的にスクリプトへのプッシュが不要であることを示す if ret_sub == RET_OK: # 登録成功 ret, data = quote_ctx.get_rt_data('US.AAPL') # 取得一次分时データ if ret == RET_OK: print(data) else: print('error:', data) else: print('subscription failed', err_message) quote_ctx.close() # 接続をクローズすると、OpenD は1分後に対応銘柄の登録を自動解除 ``` * **Output** ```python code name time is_blank opened_mins cur_price last_close avg_price volume turnover 0 US.AAPL 苹果 2025-04-06 20:01:00 False 1201 183.00 188.38 181.643916 9463 1718896.38 .. ... ... ... ... ... ... ... ... ... ... 586 US.AAPL 苹果 2025-04-07 05:47:00 False 347 181.26 188.38 180.555673 661 119859.75 [587 rows x 10 columns] ``` :::tip ご注意 * このAPIはリアルタイムデータをワンショットで取得する機能を提供しています。継続的にプッシュデータを取得するには [リアルタイム分時コールバック](./update-rt.md) API * リアルタイムデータの取得とリアルタイムデータコールバックの違いについては、 [如何から登録 API で取得してくださいリアルタイム相場情報？](../qa/quote.md#8509) ::: --- # リアルタイムティックの取得 `get_rt_ticker(code, num=500)` * **概要** 登録済み銘柄のリアルタイムティックデータを取得します。事前に登録が必要です。 * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|銘柄コード num|int|直近のティック件数 * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、ティックデータを返します
str ret != RET_OK の場合、エラーの説明を返す
* ティックデータのフォーマット： フィールド|タイプ|説明 :-|:-|:- code|str|銘柄コード name|str|銘柄名 sequence|int|ティック番号 time|str|約定時間 (フォーマット：yyyy-MM-dd HH:mm:ss 香港株およびA株市場はデフォルトで北京時間、米国株市場はデフォルトで米国東部時間) price|float|約定価格 volume|int|約定数量 (株数) turnover|float|売買代金 ticker_direction|[TickerDirect](./quote.md#6022)|ティック方向 type|[TickerType](./quote.md#6022)|ティックタイプ * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret_sub, err_message = quote_ctx.subscribe(['US.AAPL'], [SubType.TICKER], subscribe_push=False, session=Session.ALL) # 先にティックタイプを登録。登録成功後、moomoo OpenDはサーバーからのプッシュを継続受信。Falseはスクリプトへのプッシュが一時不要であることを示す if ret_sub == RET_OK: # 登録成功 ret, data = quote_ctx.get_rt_ticker('US.AAPL', 2) # 米国株AAPLの直近2件のティックを取得 if ret == RET_OK: print(data) print(data['turnover'][0]) # 1件目の約定金額を取得 print(data['turnover'].values.tolist()) # list に変換 else: print('error:', data) else: print('subscription failed', err_message) quote_ctx.close() # 接続をクローズすると、OpenD は1分後に対応銘柄の登録を自動解除 ``` * **Output** ```python code name time price volume turnover ticker_direction sequence type 0 US.AAPL 苹果 2025-04-07 05:50:23.745 181.70 2 363.40 NEUTRAL 7490506385373790208 ODD_LOT 1 US.AAPL 苹果 2025-04-07 05:50:24.170 181.73 1 181.73 NEUTRAL 7490506389668757504 ODD_LOT 363.4 [363.4, 181.73] ``` :::tip APIレート制限 * 直近最大1000件のティックデータを取得可能です。それ以上の過去ティックデータは現在提供されていません * 香港株オプション・先物はLV1権限ではティック取得に対応していません ::: :::tip ご注意 * このAPIは一括でリアルタイムデータを取得する機能を提供します。継続的なプッシュデータが必要な場合は、[リアルタイムティックコールバック](./update-ticker.md) APIを参照してください * リアルタイムデータの取得とリアルタイムデータコールバックの違いについては、 [如何から登録 API で取得してくださいリアルタイム相場情報？](../qa/quote.md#8509) ::: --- # 取得リアルタイムブローカーキュー `get_broker_queue(code)` * **概要** 登録済み株式のリアルタイムブローカーキューデータを取得します。事前に登録が必要です。 * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|銘柄コード * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
bid_frame_table pd.DataFrame ret == RET_OK の場合、bid_frame_table は買い板のブローカーキューデータ
str ret != RET_OK の場合、bid_frame_table はエラー説明を返します
ask_frame_table pd.DataFrame ret == RET_OK の場合、ask_frame_table は売り板のブローカーキューデータ
str ret != RET_OK の場合、ask_frame_table はエラー説明を返します
* 買い板ブローカーキューフォーマットは以下の通りです： フィールド|タイプ|説明 :-|:-|:- code|str|銘柄コード name|str|銘柄名 bid_broker_id|int|ブローカー買い板 ID bid_broker_name|str|ブローカー買い板名称 bid_broker_pos|int|ブローカー档位 order_id|int|取引所注文 ID (- 発注APIが返す注文 ID とは異なります - 香港株 SF 相場権限のみこのフィールドの返却をサポートしています) order_volume|int|1注文あたりの委託数量 (只有香港株 SF 相場情報の利用権限サポートを返しますこのフィールド) * 売り板ブローカーキューフォーマットは以下の通りです： フィールド|タイプ|説明 :-|:-|:- code|str|銘柄コード name|str|銘柄名 ask_broker_id|int|ブローカー売り板 ID ask_broker_name|str|ブローカー売り板名称 ask_broker_pos|int|ブローカー档位 order_id|int|取引所注文 ID (- 発注APIが返す注文 ID とは異なります - 香港株 SF 相場権限のみこのフィールドの返却をサポートしています) order_volume|int|1注文あたりの委託数量 (只有香港株 SF 相場情報の利用権限サポートを返しますこのフィールド) * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret_sub, err_message = quote_ctx.subscribe(['HK.00700'], [SubType.BROKER], subscribe_push=False) # まずブローカーキュータイプを登録。登録成功後 OpenD はサーバーからのプッシュを継続的に受信。False は一時的にスクリプトへのプッシュが不要であることを示す if ret_sub == RET_OK: # 登録成功 ret, bid_frame_table, ask_frame_table = quote_ctx.get_broker_queue('HK.00700') # ブローカーキューデータを 1 回取得 if ret == RET_OK: print(bid_frame_table) else: print('error:', bid_frame_table) else: print(err_message) quote_ctx.close() # 接続をクローズすると、OpenD は1分後に対応銘柄の登録を自動解除 ``` * **Output** ```python code name bid_broker_id bid_broker_name bid_broker_pos order_id order_volume 0 HK.00700 腾讯控股 5338 J.P.摩根 1 N/A N/A .. ... ... ... ... ... ... ... 36 HK.00700 腾讯控股 8305 富途证券国际(香港)有限公司 4 N/A N/A [37 rows x 7 columns] ``` :::tip ご注意 * このAPIはリアルタイムデータをワンショットで取得する機能を提供しています。継続的にプッシュデータを取得するには [リアルタイムブローカーキューコールバック](./update-broker.md) APIをご利用ください。 * リアルタイムデータの取得とリアルタイムデータコールバックの違いについては、 [如何から登録 API で取得してくださいリアルタイム相場情報？](../qa/quote.md#8509) * 香港株 LV1 権限下，ブローカーキューデータの取得はサポートされていません ::: --- # 取得原資産市場状態 `get_market_state(code_list)` * **概要** 指定原資産の市場状態を取得 * **パラメータ** パラメータ|型|説明 :-|:-|:- code_list|list|市場状態を照会する銘柄コードリスト (list 内の要素の型は str) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、市場状態データ
str ret != RET_OK の場合、エラーの説明を返す
* 市場状態データ フィールド|タイプ|説明 :-|:-|:- code|str|銘柄コード stock_name|str|銘柄名 market_state|[MarketState](./quote.md#3508)|市場状態 * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_market_state(['SZ.000001', 'HK.00700']) if ret == RET_OK: print(data) else: print('error:', data) quote_ctx.close() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。 ``` * **Output** ```python code stock_name market_state 0 SZ.000001 平安银行 AFTERNOON 1 HK.00700 腾讯控股 AFTERNOON ``` :::tip APIレート制限 * 30 秒以内に最大 10 回原資産市場状態API。 * 1回のリクエストにおける銘柄コード数の上限は 400 個です。 ::: --- # 取得資金フロー `get_capital_flow(stock_code, period_type = PeriodType.INTRADAY, start=None, end=None)` * **概要** 個別銘柄の資金フローの取得 * **パラメータ** パラメータ|型|説明 :-|:-|:- stock_code|str|銘柄コード period_type|[PeriodType](./quote.md#4674)|周期タイプ start|str|開始時間 (フォーマット：yyyy-MM-dd 例如：“2017-06-20”) end|str|結束時間 (フォーマット：yyyy-MM-dd 例如：“2017-06-20”) - start と end の組み合わせは以下の通りです |start タイプ |end タイプ |説明 | |:--|:--|:--| |str |str |start と end はそれぞれ指定した日付| |None |str |start 為 end 往前 365 天 | |str |None |end 為 start 往后 365 天 | |None |None |end は当日、start は365日前 | * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、資金フローデータ
str ret != RET_OK の場合、エラーの説明を返す
* 資金フローデータフォーマットは以下の通りです： フィールド|タイプ|説明 :-|:-|:- in_flow|float|整体純流入額 main_in_flow|float|主力大口純流入額 (過去の周期（日、週、月）のみ有効) super_in_flow|float|特大口純流入額 big_in_flow|float|大口純流入額 mid_in_flow|float|中口純流入額 sml_in_flow|float|小口純流入額 capital_flow_item_time|str|開始時間 (フォーマット：yyyy-MM-dd HH:mm:ss 分単位まで) last_valid_time|str|データ最終有効時間 (リアルタイム周期のみ有効) * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_capital_flow("HK.00700", period_type = PeriodType.INTRADAY) if ret == RET_OK: print(data) print(data['in_flow'][0]) # 最初のレコードの純流入資金額を取得 print(data['in_flow'].values.tolist()) # list に変換 else: print('error:', data) quote_ctx.close() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。 ``` * **Output** ```python last_valid_time in_flow ... main_in_flow capital_flow_item_time 0 N/A -1.857915e+08 ... -1.066828e+08 2021-06-08 00:00:00 .. ... ... ... ... ... 245 N/A 2.179240e+09 ... 2.143345e+09 2022-06-08 00:00:00 [246 rows x 8 columns] -185791500.0 [-185791500.0, -18315000.0, -672100100.0, -714394350.0, -698391950.0, -818886750.0, 304827400.0, 73026200.0, -2078217500.0, .. ... ... ... 2031460.0, 638067040.0, 622466600.0, -351788160.0, -328529240.0, 715415020.0, 76749700.0, 2179240320.0] ``` :::tip APIレート制限 * 30 秒以内に最大 30 回資金フローAPI。 * のみサポート正株、ワラント、基金和暗号通貨。 * 過去の周期（日、月、年）は直近1年分のデータのみ提供。リアルタイム周期は最新1日分のデータのみ提供。 * 返却データは場中データのみで、プレマーケット・アフターマーケットのデータは含まれません。 ::: --- # 取得資金分布 `get_capital_distribution(stock_code)` * **概要** 資金分布の取得 * **パラメータ** パラメータ|型|説明 :-|:-|:- stock_code|str|銘柄コード * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、株式資金分布データ
str ret != RET_OK の場合、エラーの説明を返す
* 資金分布データフォーマットは以下の通りです： フィールド|タイプ|説明 :-|:-|:- capital_in_super|float|流入資金額，特大口 capital_in_big|float|流入資金額，大口 capital_in_mid|float|流入資金額，中口 capital_in_small|float|流入資金額，小口 capital_out_super|float|流出資金額，特大口 capital_out_big|float|流出資金額，大口 capital_out_mid|float|流出資金額，中口 capital_out_small|float|流出資金額，小口 update_time|str|更新時間文字列 (フォーマット：yyyy-MM-dd HH:mm:ss) * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_capital_distribution("HK.00700") if ret == RET_OK: print(data) print(data['capital_in_big'][0]) # 最初のレコードの流入資金額（大口）を取得 print(data['capital_in_big'].values.tolist()) # list に変換 else: print('error:', data) quote_ctx.close() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。 ``` * **Output** ```python capital_in_super capital_in_big ... capital_out_small update_time 0 2.261085e+09 2.141964e+09 ... 2.887413e+09 2022-06-08 15:59:59 [1 rows x 9 columns] 2141963720.0 [2141963720.0] ``` :::tip APIレート制限 * 30 秒以内に最大 30 回資金分布API。 * のみサポート正株、ワラント、基金和暗号通貨。 * 資金分布の詳細については、 [こちら](https://support.futunn.com/zh-cn/topic498?lang=zh-CN)。 * 返却データは場中データのみで、プレマーケット・アフターマーケットのデータは含まれません。 ::: --- # 取得株式所属セクター `get_owner_plate(code_list)` * **概要** 1つまたは複数の株式の所属セクター情報リストを取得 * **パラメータ** パラメータ|型|説明 :-|:-|:- code_list|list|銘柄コードリスト (のみサポート正株、指数list 内の要素の型は str) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、所属セクターデータ
str ret != RET_OK の場合、エラーの説明を返す
* 所属セクターデータフォーマットは以下の通りです： フィールド|タイプ|説明 :-|:-|:- code|str|銘柄コード name|str|銘柄名 plate_code|str|セクターコード plate_name|str|セクター名字 plate_type|[Plate](./quote.md#5910)|セクタータイプ (行业セクター或概念セクター) * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) code_list = ['HK.00001'] ret, data = quote_ctx.get_owner_plate(code_list) if ret == RET_OK: print(data) print(data['code'][0]) # 最初のレコードの銘柄コードを取得 print(data['plate_code'].values.tolist()) # セクターコードを list に変換 else: print('error:', data) quote_ctx.close() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。 ``` * **Output** ```python code name plate_code plate_name plate_type 0 HK.00001 长和 HK.HSI Constituent 恒指成份股 OTHER .. ... ... ... ... ... 8 HK.00001 长和 HK.BK1983 香港股票ADR OTHER [9 rows x 5 columns] HK.00001 ['HK.HSI Constituent', 'HK.GangGuTong', 'HK.BK1000', 'HK.BK1061', 'HK.BK1107', 'HK.BK1331', 'HK.BK1600', 'HK.BK1922', 'HK.BK1983'] ``` :::tip APIレート制限 * 30 秒以内に最大 10 回株式所属セクターAPI * 1回のリクエストにおける銘柄リスト内の株式数の上限は 200 個です * のみサポート正株和指数 ::: --- # 過去ローソク足データの取得 `request_history_kline(code, start=None, end=None, ktype=KLType.K_DAY, autype=AuType.QFQ, fields=[KL_FIELD.ALL], max_count=1000, page_req_key=None, extended_time=False)` * **概要** 過去ローソク足データの取得 * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|銘柄コード start|str|開始時刻 (形式：yyyy-MM-dd 例如：“2017-06-20”) end|str|結束時刻 (形式：yyyy-MM-dd 例如：“2017-07-20”) ktype|[KLType](./quote.md#6493)|ローソク足タイプ autype|[AuType](./quote.md#6493)|復権タイプ fields|[KLFields](./quote.md#3508)|返すフィールドリスト max_count|int|今回のリクエストで返すローソク足の最大本数 (- Noneを指定すると、startとendの間のすべてのデータを返します - 注意：OpenDはすべてのデータを受信してからスクリプトに送信します。取得するローソク足本数が1000本を超える場合は、タイムアウトを防ぐためにページングの使用をお勧めします) page_req_key|bytes|ページングリクエストキー (startとendの間のローソク足本数がmax_countを超える場合：1. 最初のページリクエスト時はNoneを指定2. 次ページ以降のリクエスト時は前回のレスポンスで返されたpage_req_keyを指定) extended_time|bool|是否許可米国株プレ/アフターマーケットデータ (False：不許可True：許可) * startとendの組み合わせは以下の通り Start タイプ|End タイプ|説明 :-|:-|:- str|str|start と end がそれぞれ指定された日付 None|str|start 為 end 往前 365 天 str|None|end 為 start 往后 365 天 None|None|end 為現在の日付，start 往前 365 天 * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame 当 ret == RET_OK，返す過去ローソク足データデータ
str ret != RET_OK の場合、エラーの説明を返す
page_req_key bytes 次ページリクエスト用のkey
* 過去ローソク足データのフォーマットは以下の通り: フィールド|タイプ|説明 :-|:-|:- code|str|銘柄コード name|str|銘柄名 time_key|str|ローソク足時刻 (形式：yyyy-MM-dd HH:mm:ss 香港株和 A株市場デフォルト是北京時刻，米国株市場デフォルト是美东時刻) open|float|始値 close|float|終値 high|float|高値 low|float|安値 pe_ratio|float|PER (このフィールドは比率フィールドで、デフォルトでは % を表示しません) turnover_rate|float|売買回転率 volume|float|出来高 turnover|float|売買代金 change_rate|float|騰落率 last_close|float|前のローソク足の終値 * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data, page_req_key = quote_ctx.request_history_kline('US.AAPL', start='2019-09-11', end='2019-09-18', max_count=5, session=Session.ALL) # 1ページ5件、最初のページをリクエスト if ret == RET_OK: print(data) print(data['code'][0]) # 最初のレコードの銘柄コードを取得 print(data['close'].values.tolist()) # 最初のページの終値をlistに変換 else: print('error:', data) while page_req_key != None: # 残りの全結果をリクエスト print('*************************************') ret, data, page_req_key = quote_ctx.request_history_kline('US.AAPL', start='2019-09-11', end='2019-09-18', max_count=5, page_req_key=page_req_key, session=Session.ALL) # ページネーション後のデータをリクエスト if ret == RET_OK: print(data) else: print('error:', data) print('All pages are finished!') quote_ctx.close() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。 ``` * **Output** ```python code name time_key open close high low pe_ratio turnover_rate volume turnover change_rate last_close 0 US.AAPL 苹果 2019-09-11 00:00:00 52.631194 53.963447 53.992409 52.549135 18.773 0.01039 177158584.0 9.808562e+09 3.179511 52.300545 .. ... ... ... ... ... ... ... ... ... ... ... ... ... 4 US.AAPL 苹果 2019-09-17 00:00:00 53.087346 53.265945 53.294907 52.884612 18.530 0.00432 73545872.0 4.046314e+09 0.363802 53.072865 [5 rows x 13 columns] US.AAPL [53.9634465, 53.84156475, 52.7953125, 53.072865, 53.265945] ************************************* code name time_key open close high low pe_ratio turnover_rate volume turnover change_rate last_close 0 US.AAPL 苹果 2019-09-18 00:00:00 53.352831 53.76554 53.784847 52.961844 18.704 0.00602 102572372.0 5.682068e+09 0.937925 53.265945 All pages are finished! ``` :::tip APIレート制限 * 分足は直近8年分のデータを提供、日足は直近20年分のデータを提供、日足以上は制限なし。 * お客様の口座の資産と取引状況に基づき、過去ローソク足データ枠が付与されます。そのため、7日以内に取得できる銘柄の過去ローソク足データは限られています。詳細なルールは[登録枠 & 過去ローソク足データ枠](../intro/authority.md#8582)をご参照ください。当日消費した過去ローソク足データ枠は、7日後に自動的に解放されます。 * 30秒以内に過去ローソク足データAPIを最大60回リクエストできます。注意：ページングでデータを取得する場合、このレート制限ルールは各銘柄の最初のページにのみ適用され、後続ページのリクエストはレート制限の対象外です。 * **売買回転率**は日足以上のみ提供。 * **オプション**，日足、1分足、5分足、15分足、60分足のみ提供しています。 * 米国株の**プレマーケット、アフターマーケット、夜間取引ローソク足**は60分足以下のみ対応。米国株のプレ/アフターマーケットおよび夜間取引は非通常の取引時間帯のため、当該時間帯のローソク足データは2年分に満たない場合があります。 * 米国株の**売買代金**は2015-10-12以降のデータのみ提供。 ::: --- # 取得復権因子 `get_rehab(code)` * **概要** 株式の復権因子を取得 * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|銘柄コード * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、復権データ
str ret != RET_OK の場合、エラーの説明を返す
* 復権データフォーマットは以下の通りです： フィールド|タイプ|説明 :-|:-|:- ex_div_date|str|除權除息日 split_base|float|拆股分子 (拆股比例=拆股分子/拆股分母) split_ert|float|拆股分母 join_base|float|合股分子 (合股比例=合股分子/合股分母) join_ert|float|合股分母 split_ratio|float|拆合股比例 (- 当公司出现合股，5股合1股时，合股分子=5，合股分母=1，拆合股比例=合股分子/合股分母=5/1- 当公司出现拆股，1股拆5股时，拆股分子=1，拆股分母=5，拆合股比例=拆股分子/拆股分母=1/5) per_cash_div|float|每股派现 bonus_base|float|送股分子 (送股比例=送股分子/送股分母) bonus_ert|float|送股分母 per_share_div_ratio|float|送股比例 (- 当公司出现送股，5股送1股时，送股分子=5，送股分母=1，送股比例=送股分子/送股分母=5/1) transfer_base|float|转增股分子 (转增股比例=转增股分子/转增股分母) transfer_ert|float|转增股分母 per_share_trans_ratio|float|转增股比例 (- 当公司出现转增股，10股转增3股时，转增股分子=10，转增股分母=3，转增股比例=转增股分子/转增股分母=10/3) allot_base|float|配股分子 (配股比例=配股分子/配股分母) allot_ert|float|配股分母 allotment_ratio|float|配股比例 (- 当公司出现配股，5股配1股时，配股分子=5，配股分母=1，配股比例=配股分子/配股分母=5/1) allotment_price|float|配股価 add_base|float|增発股分子 (增発股比例=增発股分子/增発股分母) add_ert|float|增発股分母 stk_spo_ratio|float|增発比例 (- 当公司出现增発股，1股增発5股时，增発股分子=1，增発股分母=5，增発股比例=增発股分子/增発股分母=1/5) stk_spo_price|float|增発価格 spin_off_base|float|分立分子 spin_off_ert|float|分立分母 spin_off_ratio|float|分立比例 forward_adj_factorA|float|前復権因子 A forward_adj_factorB|float|前復権因子 B backward_adj_factorA|float|后復権因子 A backward_adj_factorB|float|后復権因子 B 前復権価格 = 不復権価格 × 前復権因子 A + 前復権因子 B 后復権価格 = 不復権価格 × 后復権因子 A + 后復権因子 B * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_rehab("HK.00700") if ret == RET_OK: print(data) print(data['ex_div_date'][0]) # 最初の除権落ち日を取得 print(data['ex_div_date'].values.tolist()) # list に変換 else: print('error:', data) quote_ctx.close() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。 ``` * **Output** ```python ex_div_date split_ratio per_cash_div per_share_div_ratio per_share_trans_ratio allotment_ratio allotment_price stk_spo_ratio stk_spo_price spin_off_base spin_off_ert spin_off_ratio forward_adj_factorA forward_adj_factorB backward_adj_factorA backward_adj_factorB 0 2005-04-19 NaN 0.07 NaN NaN NaN NaN NaN NaN NaN NaN NaN 1.0 -0.07 1.0 0.07 .. ... ... ... ... ... ... ... ... ... ... ... ... ... 15 2019-05-17 NaN 1.00 NaN NaN NaN NaN NaN NaN NaN NaN NaN 1.0 -1.00 1.0 1.00 [16 rows x 16 columns] 2005-04-19 ['2005-04-19', '2006-05-15', '2007-05-09', '2008-05-06', '2009-05-06', '2010-05-05', '2011-05-03', '2012-05-18', '2013-05-20', '2014-05-15', '2014-05-16', '2015-05-15', '2016-05-20', '2017-05-19', '2018-05-18', '2019-05-17'] ``` :::tip APIレート制限 * 30 秒以内に最大 60 回復権因子API。 ::: --- # 決算日前後の価格変動を取得 `get_financials_earnings_price_move(code, period_count=None)` * **説明** 決算日前後の価格変動を取得 * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|銘柄コード period_count|int|決算期間数 (デフォルト 10、範囲 [1, 50]) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、取引日ごとに展開した明細データを返します
str ret != RET_OK の場合、エラーの説明を返します
* 各行に決算メタ情報と当日の相場データが含まれます： フィールド|型|説明 :-|:-|:- fiscal_year|int|会計年度 (例：2024) financial_type|[F10Type](./quote.md#337)|決算種別 (0=不明、1=Q1、2=Q2、3=Q3、4=Q4、7=通年、9=四半期など) period_text|str|決算期間 (例："2024/Q3"、"2024/FY") pub_trading_day_str|str|決算発表日対応取引日 (形式：yyyy-MM-dd；対応市場タイムゾーン) pub_type|[EarningsPubTimeType](./quote.md#4355)|決算発表時間種別 (0=不明、1=寄り前、2=引け後、3=立会中) price_info_index|int|決算発表日のitemList内インデックス (0始まり；-1はデータなし) day_offset|int|決算発表日からのオフセット日数 (負=発表前、0=発表当日、正=発表後) trading_day_str|str|取引日 (形式：yyyy-MM-dd；対応市場タイムゾーン) close_price|float|終値 open_price|float|始値 highest_price|float|高値 lowest_price|float|安値 last_close_price|float|前日終値 option_iv|float|インプライドボラティリティ (パーセント前の値、例：12.34は12.34%を意味する) option_hv|float|ヒストリカルボラティリティ (パーセント前の値、例：12.34は12.34%を意味する) * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_financials_earnings_price_move("HK.00700", period_count=2) if ret == RET_OK: print(data) print(data['period_text'][0]) else: print('error:', data) quote_ctx.close() ``` * **Output** ```python fiscal_year financial_type ... option_iv option_hv 0 2026 1 ... 31.829 32.220 1 2026 1 ... 33.173 33.720 2 2026 1 ... 32.963 30.355 3 2026 1 ... NaN NaN 4 2025 4 ... 35.804 37.891 5 2025 4 ... 35.845 37.478 6 2025 4 ... 38.504 37.580 7 2025 4 ... 35.518 38.175 8 2025 4 ... 34.739 37.446 9 2025 4 ... 34.248 37.558 10 2025 4 ... 31.682 44.855 11 2025 4 ... 30.907 43.536 12 2025 4 ... 34.614 43.426 13 2025 4 ... 33.617 44.177 14 2025 4 ... 34.503 42.810 [15 rows x 17 columns] 2026/Q1 ``` :::tip 制限事項 * 30秒間に最大30リクエスト。 * 香港株・米国株・シンガポール株・日本株・マレーシア株・A株（普通株）のみ対応。 ::: --- # 決算日前後の株価履歴を取得 `get_financials_earnings_price_history(code)` * **説明** 決算日前後の株価履歴を取得 * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|銘柄コード * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、取引日ごとに展開した株価履歴データを返します
str ret != RET_OK の場合、エラーの説明を返します
* 各行に決算メタ情報と当日の株価データが含まれます： フィールド|型|説明 :-|:-|:- fiscal_year|int|会計年度 (例：2024) financial_type|[F10Type](./quote.md#337)|決算種別 (0=不明、1=Q1、2=Q2、3=Q3、4=Q4、7=通年、9=四半期など) period_text|str|決算期間 (例："2024/Q3"、"2024/FY") is_current|bool|現在時刻がこの決算ウィンドウ期間内かどうか pub_trading_day|int|決算発表対応取引日タイムスタンプ（秒） pub_trading_day_str|str|決算発表対応取引日 (形式：yyyy-MM-dd；対応市場タイムゾーン) pub_time|int|決算実際発表時刻タイムスタンプ（秒、時分秒含む） pub_time_str|str|決算発表日時 (形式：yyyy-MM-dd HH:mm:ss；対応市場タイムゾーン) pub_type|[EarningsPubTimeType](./quote.md#4355)|決算発表時間種別 (0=不明、1=寄り前、2=引け後、3=立会中) predict_vola_ratio_newest|float|最新予測変動比率 (パーセント前の値、例：12.34は12.34%を意味する) predict_vola_ratio_highest|float|最高予測変動比率 (パーセント前の値、例：12.34は12.34%を意味する) predict_vola_val_newest|float|最新予測変動金額 predict_vola_val_highest|float|最高予測変動金額 option_iv_crush|float|オプションIVクラッシュ (パーセント前の値、例：12.34は12.34%を意味する) option_strike_date_iv_crush|float|行使日オプションIVクラッシュ (パーセント前の値、例：12.34は12.34%を意味する) trading_day|int|取引日タイムスタンプ（秒） trading_day_str|str|取引日 (形式：yyyy-MM-dd；対応市場タイムゾーン) close_price|float|終値 open_price|float|始値 highest_price|float|高値 lowest_price|float|安値 last_close_price|float|前日終値 volume|float|出来高（株） schedule_delta|int|決算発表日からの取引日オフセット (負=発表前、0=発表当日、正=発表後) schedule_close_price|float|該当オフセット日の終値 * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_financials_earnings_price_history("HK.00700") if ret == RET_OK: print(data) print(data['period_text'][0]) else: print('error:', data) quote_ctx.close() ``` * **Output** ```python fiscal_year financial_type ... schedule_delta schedule_close_price 0 2026 1 ... -15 504.000000 1 2026 1 ... -14 495.200000 2 2026 1 ... -13 493.400000 3 2026 1 ... -12 478.600000 4 2026 1 ... -11 473.800000 .. ... ... ... ... ... 579 2021 2 ... 10 445.420633 580 2021 2 ... 11 438.045790 581 2021 2 ... 12 453.717332 582 2021 2 ... 13 463.396813 583 2021 2 ... 14 471.693512 [584 rows x 25 columns] 2026/Q1 ``` :::tip 接口制限 * 30秒あたり最大30リクエスト。 * 香港株・米国株・シンガポール株・日本株・マレーシア株・A株（普通株）のみ対応。 ::: --- # 財務報告書を取得 `get_financials_statements(code, statement_type=None, financial_type=None, currency_code=None, next_key=None, num=None)` * **説明** 指定銘柄の財務報告書（損益計算書/貸借対照表/キャッシュフロー計算書/主要指標）を取得します。ページングに対応しています * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|銘柄コード statement_type|[FinancialStatementsType](./quote.md#6214)|財務報告書種別 (0=不明、1=損益計算書(Income)(デフォルト)、2=貸借対照表(BalanceSheet)、3=キャッシュフロー(CashFlow)、4=主要指標(MainIndex)) financial_type|[F10Type](./quote.md#337)|財報種別 (0=全て、1=Q1、2=Q2、3=Q3、4=Q4、5=上半期(Q1+Q2)、6=9ヶ月(Q1+Q2+Q3)、7=通年、9=単四半期組合せ、10=単四半期+通年(デフォルト)、11=累計四半期) currency_code|str|通貨コード (ISO 4217、例: CNY、USD、HKD、SGD、JPY、CAD、AUD；未入力の場合は原通貨データを返します) next_key|str|ページングキー (初回は不要、続きのページは前回返却の next_key を指定；"-1" はデータなし) num|int|1ページあたりの件数 (デフォルト 10、範囲 1~50) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data dict ret == RET_OK の場合、財務報告書データの辞書を返します
str ret != RET_OK の場合、エラーの説明を返します
* 返却辞書に含まれるフィールド： フィールド|型|説明 :-|:-|:- structure_list|list|フィールド構造リスト report_list|list|財務報告書リスト next_key|str|ページングキー ("-1" はデータなし) * structure_list の各エントリに含まれるフィールド： フィールド|型|説明 :-|:-|:- field_id|int|財務フィールド ID display_name|str|フィールド表示名 (例：「売上収益」；現在の言語) * report_list の各エントリに含まれるフィールド： フィールド|型|説明 :-|:-|:- date_time|int|財報締め日タイムスタンプ（秒） date_time_str|str|財報締め日文字列 (形式：YYYY-MM-DD；対応市場タイムゾーン) fiscal_year|int|会計年度 (例：2024) financial_type|[F10Type](./quote.md#337)|財報種別 (0=不明、次のリクエストにそのまま渡す) period_text|str|財報期間 (例："2024/Q3"、"2024/FY") item_list|list|財務データ項目リスト currency_info|str|通貨表示名 (例："人民元"、"米ドル") accounting_standards|str|会計基準 (例："国際会計基準") auditor_report|str|監査意見 (例："無限定適正意見") currency_code|str|通貨コード (ISO 4217、例："CNY"、"USD") * item_list の各エントリに含まれるフィールド： フィールド|型|説明 :-|:-|:- field_id|int|財務フィールド ID data|float|財務数値 yoy|float|前年比 (%記号前の値、例：13.86 は 13.86%；前年比データなしの場合はフィールドなし) qoq|float|前四半期比 (%記号前の値、例：1.23 は 1.23%；前四半期比データなしの場合はフィールドなし) display_name|str|フィールド表示名 (structure_list の対応エントリの display_name と一致) * **Example** ```python import pandas as pd from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_financials_statements("HK.00700") if ret == RET_OK: df = pd.DataFrame(data['report_list'][0]['item_list']) print(df) else: print('error:', data) quote_ctx.close() ``` * **Output** ```python field_id display_name data yoy 0 5001 Total Revenue 7.517660e+11 13.859603 1 5002 Operating Revenue 7.517660e+11 13.859603 2 5005 Cost of Revenue -3.291730e+11 -5.839665 3 5008 Cost of Goods Sold -3.291730e+11 -5.839665 4 5010 Gross Profit 4.225930e+11 21.001529 5 5013 Operating Expense -1.778540e+11 -19.245855 6 5015 Selling Expenses -4.172700e+10 -14.672419 7 5016 Administrative Expenses -1.361270e+11 -20.721703 8 5032 Special Items of Operating Income -3.177000e+09 -139.702574 9 5034 Operating Profit 2.415620e+11 16.080327 10 5035 Financing Income 1.690900e+10 5.654836 11 5036 Financing Cost -1.513000e+10 -26.283282 12 5037 Share of Profits of Associates 2.374000e+10 -5.703845 13 5040 Pretax Profit 2.772490e+11 14.810030 14 5041 Special Items of Pretax Income 1.016800e+10 142.846907 15 5043 Tax -4.744800e+10 -5.397841 16 5045 Net Profit 2.298010e+11 16.966717 17 5046 Profit from Continuing Operations 2.298010e+11 16.966717 18 5050 Minority Interests 4.959000e+09 107.142857 19 5051 Net Income to Parent Company 2.248420e+11 15.854343 20 5052 Net Income to Common Stockholders 2.248420e+11 15.854343 21 5054 Basic EPS 2.474900e+01 18.201356 22 5055 Diluted EPS 2.415300e+01 17.900029 ``` :::tip 接口制限 * 30秒あたり最大30リクエスト。 * 株式および投資信託に対応。 ::: --- # 主営構成を取得 `get_financials_revenue_breakdown(code, date=None, financial_type=None, currency_code=None)` * **説明** 指定銘柄の主営構成データを取得します。製品、業界、地域、事業などの多次元で内訳を確認できます * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|銘柄コード date|int|フィルタータイムスタンプ (秒；返却の screen_date_list から date 値を取得して過去データを照会；未入力または 0 で最新期を返す) financial_type|[F10Type](./quote.md#337)|財報種別 (0=全て、1=Q1、2=Q2、3=Q3、4=Q4、5=上半期、6=9ヶ月、7=通年、9=単四半期組合せ；デフォルト 0=全て) currency_code|str|通貨コード (ISO 4217、例: CNY、USD、HKD、SGD、JPY、CAD、AUD；未入力の場合は原通貨データを返します) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data dict ret == RET_OK の場合、主営構成データの辞書を返します
str ret != RET_OK の場合、エラーの説明を返します
* 返却辞書に含まれるフィールド： フィールド|型|説明 :-|:-|:- period|str|財報期間 (例："2025/FY"、"2024/H1") breakdown_list|list|次元別主営構成リスト (各エントリに type と item_list を含む) currency_code|str|通貨コード (ISO 4217) screen_date_list|list|選択可能な過去日付リスト (date と financial_type がともに未入力の場合のみ返却) * breakdown_list の各エントリに含まれるフィールド： フィールド|型|説明 :-|:-|:- type|[RevenueBreakdownType](./quote.md#8430)|次元種別 (1=製品(Product)、2=業界(Industry)、4=地域(Region)、8=事業(Business)) item_list|list|この次元の主営構成項目リスト (各エントリに name、main_oper_income、ratio を含む) * item_list の各エントリに含まれるフィールド： フィールド|型|説明 :-|:-|:- name|str|項目名 main_oper_income|float|営業収益 ratio|float|占比 (百分号前の値、例えば 12.34 は 12.34% を意味する) * screen_date_list の各エントリに含まれるフィールド： フィールド|型|説明 :-|:-|:- date|int|フィルタータイムスタンプ (秒；このリスト内の値をそのまま渡す) period_text|str|財報期間 (例："2025/FY") financial_type|[F10Type](./quote.md#337)|財報種別 * **Example** ```python import pandas as pd from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_financials_revenue_breakdown("HK.00700") if ret == RET_OK: df = pd.DataFrame(data['breakdown_list'][0]['item_list']) print(df) else: print('error:', data) quote_ctx.close() ``` * **Output** ```python name main_oper_income ratio 0 Value-added services 3.692810e+11 49.1218 1 Financial technology and corporate services 2.294350e+11 30.5194 2 Marketing service 1.449730e+11 19.2843 3 Other 8.077000e+09 1.0744 ``` :::tip インターフェース制限 * 30秒以内に最大30回リクエスト可能。 * 株式およびファンドに対応。 ::: --- # アナリスト評価コンセンサスの取得 `get_research_analyst_consensus(code)` * **説明** 指定銘柄の過去3ヶ月間のアナリスト総合評価、目標株価レンジ、各評価区分の割合を取得します * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|銘柄コード * **戻り値**
パラメータ 型 説明
ret RET_CODE API 呼び出し結果
data dict ret == RET_OK の場合、アナリスト評価データの辞書を返す
str ret != RET_OK の場合、エラーの説明を返す
* 返される辞書には以下のフィールドが含まれます： フィールド|型|説明 :-|:-|:- highest|float|目標株価（最高値） average|float|目標株価（平均値） lowest|float|目標株価（最低値） rating|[ResearchRatingType](./quote.md#8544)|総合評価 (過去3ヶ月のアナリスト総合評価 0=Unknown、1=Sell、2=Underperform、3=Hold、4=Buy、5=StrongBuy 米国株は Sell(1)/Hold(3)/Buy(4) のみ；非米国市場は Underperform(2)/StrongBuy(5) もサポート) total|int|アナリスト総数 (過去3ヶ月に評価を提出したアナリストの総数) update_time|int|更新タイムスタンプ（秒、評価データの更新時刻） update_time_str|str|更新日付 (YYYY-MM-DD 形式、市場のタイムゾーン) buy|float|Buy 評価割合 (パーセント記号前の値（例：12.34 は 12.34% を意味する）) hold|float|Hold 評価割合 (パーセント記号前の値（例：12.34 は 12.34% を意味する）) sell|float|Sell 評価割合 (パーセント記号前の値（例：12.34 は 12.34% を意味する）) strong_buy|float|Strong Buy 割合 (パーセント記号前の値（例：12.34 は 12.34% を意味する）；非米国市場のみ) underperform|float|Underperform 割合 (パーセント記号前の値（例：12.34 は 12.34% を意味する）；非米国市場のみ) * **Example** ```python import json from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_research_analyst_consensus("HK.00700") if ret == RET_OK: print(json.dumps(data, indent=2, ensure_ascii=False)) else: print('error:', data) quote_ctx.close() ``` * **Output** ```python { "highest": 820.0, "average": 716.0, "lowest": 579.51, "rating": 5, "total": 44, "update_time": 1778469178, "update_time_str": "2026-05-11", "buy": 22.727, "hold": 0.0, "sell": 0.0, "strong_buy": 77.273, "underperform": 0.0 } ``` :::tip API 制限 * 30秒以内に最大30リクエスト。 * 普通株式および REIT をサポート。 ::: --- # 評価サマリーの取得 `get_research_rating_summary(code, rating_dimension_type=None, uid=None, num=None, next_key=None)` * **説明** 指定銘柄の機関または分析師の評価サマリーリスト、または指定機関/分析師の評価詳細をページング対応で取得します * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|銘柄コード rating_dimension_type|[ResearchRatingDimensionType](./quote.md#9096)|評価ディメンション (0=Unknown、1=Institution（機関）、2=Analyst（分析師）；デフォルトは機関) uid|str|機関または分析師の UID (空=当銘柄の評価サマリーリストを取得 非空=指定 uid の評価詳細を取得（分析師 uid の場合は rating_dimension_type=2 と併用）) num|int|1ページあたりの返却数 (デフォルト 10、範囲 1~20) next_key|str|ページングキー (初回は空；続きを取得する際は前回返却の next_key を指定；"-1" はデータなし) * **戻り値**
パラメータ 型 説明
ret RET_CODE API 呼び出し結果
data dict ret == RET_OK の場合、評価サマリーデータの辞書を返す
str ret != RET_OK の場合、エラーの説明を返す
* 返される辞書には以下のフィールドが含まれます： フィールド|型|説明 :-|:-|:- inst_rating_summary_list|list|機関評価サマリーリスト (uid が空かつ rating_dimension_type=1 の場合に設定 各項目に institution_info と rating_item_list を含む) analyst_rating_summary_list|list|分析師評価サマリーリスト (uid が空かつ rating_dimension_type=2 の場合に設定 各項目に analyst_info と rating_item_list を含む) inst_rating_detail|dict|機関評価詳細 (uid が非空かつ rating_dimension_type=1 の場合に設定 institution_info、analyst_info_list、rating_item_list を含む) analyst_rating_detail|dict|分析師評価詳細 (uid が非空かつ rating_dimension_type=2 の場合に設定 analyst_info と rating_item_list を含む) next_key|str|ページングキー ("-1" はデータなし) * inst_rating_summary_list の各項目フィールド（機関評価サマリー行）： フィールド|型|説明 :-|:-|:- institution_info|dict|機関情報、下表参照 rating_item_list|list|評価記録リスト、下表参照 * institution_info フィールド（InstInfo）： フィールド|型|説明 :-|:-|:- institution_uid|str|機関の一意識別子 institution_picture_url|str|機関画像 URL institution_name|str|機関名 update_time|int|更新タイムスタンプ（秒、市場タイムゾーン） update_time_str|str|更新日付 (形式 YYYY-MM-DD、市場タイムゾーン) institution_source_name|str|機関ソース名 institution_en_name|str|機関英語名 * analyst_info フィールド（AnalystInfo）： フィールド|型|説明 :-|:-|:- analyst_uid|str|分析師の一意識別子 analyst_name|str|分析師名 analyst_picture_url|str|分析師アバター URL num_of_stars|float|スター評価 (0.0~5.0、例: 3.50 は 3.5 スター) success_rate|float|成功率 (パーセント記号前の値、例: 12.34 は 12.34%) excess_return|float|超過収益 (パーセント記号前の値、例: 12.34 は 12.34%) stock_success_rate|float|個別銘柄成功率 (パーセント記号前の値、例: 12.34 は 12.34%) stock_avg_return|float|個別銘柄平均収益 (パーセント記号前の値、例: 12.34 は 12.34%) institution_info|dict|所属機関情報、institution_info フィールド表参照 update_time|int|更新タイムスタンプ（秒、市場タイムゾーン） update_time_str|str|更新日付 (形式 YYYY-MM-DD、市場タイムゾーン) * rating_item_list の各項目フィールド（RatingItem）： フィールド|型|説明 :-|:-|:- analyst_uid|str|分析師の一意識別子 institution_uid|str|機関の一意識別子 rating|[ResearchRatingType](./quote.md#8544)|評価 (0=Unknown、1=Sell、2=Underperform、3=Hold、4=Buy、5=StrongBuy 本 API は Sell(1)/Hold(3)/Buy(4) のみ返却、値が大きいほど評価が高い) target_price|float|目標株価 recommendation_date|int|評価日タイムスタンプ（秒、市場タイムゾーン） recommendation_date_str|str|評価日付 (形式 YYYY-MM-DD、市場タイムゾーン) rating_url|str|評価ソース URL update_time|int|更新タイムスタンプ（秒、市場タイムゾーン） update_time_str|str|更新日付 (形式 YYYY-MM-DD、市場タイムゾーン) * **Example** ```python from moomoo import * import pandas as pd quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_research_rating_summary("US.AAPL", rating_dimension_type=1) if ret == RET_OK: rows = [] for row in data.get('inst_rating_summary_list', []): info = row.get('institution_info', {}) rows.append({ 'institution_name': info.get('institution_name', ''), 'institution_en_name': info.get('institution_en_name', ''), 'institution_uid': info.get('institution_uid', ''), 'institution_source_name': info.get('institution_source_name', ''), 'update_time_str': info.get('update_time_str', ''), }) df = pd.DataFrame(rows) print(df.to_string(index=False)) else: print('error:', data) quote_ctx.close() ``` * **Output** ```python institution_name institution_en_name institution_uid institution_source_name update_time_str Wedbush Wedbush 8c9ae25a-07e2-4d52-a511-b0dd115a5224 Wedbush 2024-03-01 Evercore Evercore a746f081-c12a-4d6d-8067-f4b6634de478 Evercore ISI 2024-03-21 UBS UBS 1d3bfc25-1dda-48fd-bd9f-d4de47e68def UBS 2024-03-01 Goldman Sachs Goldman Sachs d0e296b4-c2e4-4fad-837c-cd79aaed2e8e Goldman Sachs 2024-03-01 Bernstein Bernstein 16358c98-ccc1-4d08-a875-2c727b7b8d70 Bernstein 2024-03-01 DBS DBS 44dec2a6-aca9-4b52-9fed-4bbf78749783 DBS 2024-03-01 BofA Securities BofA Securities 7890753d-5482-4311-a7af-8d5feed39f3e Bank of America Securities 2024-03-01 Phillip Securities Phillip Securities a294f0ca-10c0-4884-86a7-359995505e70 Phillip Securities 2024-09-09 J.P. Morgan J.P. Morgan f5ec822c-d561-4db3-a09d-a1e71a9a832f J.P. Morgan 2024-03-01 Morgan Stanley Morgan Stanley 9a29ac93-221c-4c1a-ba1a-bbbbf57a5ca6 Morgan Stanley 2024-03-01 ``` :::tip API 制限 * 30秒以内に最大30回リクエスト可能です。 * 米国株の普通株および REIT に対応しています。 ::: --- # モーニングスター調査レポートの取得 `get_research_morningstar_report(code)` * **説明** 指定銘柄のモーニングスター調査レポートを取得します。スター評価、公正価値、経済的優位性（モート）、不確実性、財務健全性、資本配分、強気/弱気の根拠、アナリスト見解などを含みます * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|銘柄コード * **戻り値**
パラメータ 型 説明
ret RET_CODE API 呼び出し結果
data dict ret == RET_OK の場合、モーニングスター調査レポートデータの辞書を返す
str ret != RET_OK の場合、エラーの説明を返す
* 返される辞書には以下のフィールドが含まれます： フィールド|型|説明 :-|:-|:- rating_type|[MorningstarRatingType](./quote.md#4107)|評価タイプ (0=Unknown、1=Quantitative（定量的評価、システムモデルによる）、2=Qualitative（定性的評価、アナリストによる手動評価）) star_rating|int|モーニングスタースター評価 (値 1~5 スター) star_update_time|int|スター評価更新タイムスタンプ（秒、市場タイムゾーン） star_update_time_str|str|スター評価更新日付 (形式 YYYY-MM-DD、市場タイムゾーン) fair_value|float|公正価値 fair_value_content|dict|公正価値分析、StringWithUpdateTime フィールド表参照 economic_moat_label|str|経済的優位性評価 (例: Wide、Narrow、None) economic_moat_content|dict|経済的優位性分析、StringWithUpdateTime フィールド表参照 uncertainty_label|str|不確実性評価 (例: Low、Medium、High、Very High、Extreme) uncertainty_content|dict|不確実性分析、StringWithUpdateTime フィールド表参照 financial_health_label|str|財務健全性評価 financial_health_content|dict|財務健全性分析、StringWithUpdateTime フィールド表参照 analyst_report_by_line|list|アナリスト署名リスト (例: ["William Kerwin, CFA"]) analyst_report_update_time|int|アナリストレポート更新タイムスタンプ（秒、市場タイムゾーン） analyst_report_update_time_str|str|アナリストレポート更新日付 (形式 YYYY-MM-DD、市場タイムゾーン) bull_say|list|強気の根拠リスト、各項目は StringWithUpdateTime フィールド表参照 bear_say|list|弱気の根拠リスト、各項目は StringWithUpdateTime フィールド表参照 capital_allocation_label|str|資本配分評価 capital_allocation_content|dict|資本配分分析、StringWithUpdateTime フィールド表参照 analyst_note_title|dict|アナリストノートのタイトル、StringWithUpdateTime フィールド表参照 analyst_note_content|dict|アナリストノートの内容、StringWithUpdateTime フィールド表参照 investment_thesis_content|dict|投資論点、StringWithUpdateTime フィールド表参照 fundamentals_content|dict|ファンダメンタルズレポート、StringWithUpdateTime フィールド表参照 valuation_content|dict|バリュエーションレポート、StringWithUpdateTime フィールド表参照 pdf_url|str|PDF レポートダウンロード URL * StringWithUpdateTime フィールド（ネストされたテキスト構造）： フィールド|型|説明 :-|:-|:- context|str|テキスト内容 update_time|int|更新タイムスタンプ（秒、市場タイムゾーン） update_time_str|str|更新日付 (形式 YYYY-MM-DD、市場タイムゾーン) * **Example** ```python import json from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_research_morningstar_report("HK.00700") if ret == RET_OK: print(json.dumps(data, indent=2, ensure_ascii=False)) else: print('error:', data) quote_ctx.close() ``` * **Output** ```python { "rating_type": 2, "star_rating": 4, "star_update_time": 1778257800, "star_update_time_str": "2026-05-09", "fair_value": 800.0, "fair_value_content": { "context": "Our fair value estimate for Tencent is HKD 800 per share. About 85% of our valuation comes from Tencent’s core business, while ... "update_time": 1755138060, "update_time_str": "2025-08-14" }, "economic_moat_label": "Wide", "economic_moat_content": { "context": "Tencent's wide moat is primarily based on network effects around its massive user base. In addition, Tencent possesses ... "update_time": 1766457150, "update_time_str": "2025-12-23" }, "uncertainty_label": "High", "uncertainty_content": { "context": "Our Morningstar Uncertainty Rating for Tencent is High due to regulatory risks and competitive intensity across... "update_time": 1766457180, "update_time_str": "2025-12-23" }, //... } ``` :::tip 制限事項 * 30 秒以内に最大 30 回リクエストできます。 * 普通株および REIT に対応しています。 ::: --- # バリュエーション詳細の取得 `get_valuation_detail(code, valuation_type=None, interval_type=None)` * **説明** 指定した銘柄または指数のバリュエーション詳細を取得します。バリュエーション推移、市場分布、セクター分布（個別銘柄のみ）、利益/収益成長率（個別銘柄のみ、PB では利用不可）を含みます * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|銘柄コード valuation_type|[ValuationType](./quote.md#7275)|バリュエーション種別 (0=Unknown（推奨種別を使用）、1=PE（株価収益率）、2=PB（株価純資産倍率）、3=PS（株価売上高倍率）；デフォルト None（推奨種別を使用）) interval_type|[ValuationIntervalType](./quote.md#6316)|履歴データ期間 (0=Unknown、1=Month3、2=Month6、3=Year1、4=Year3、5=Since2019、6=Year5、7=Year10、8=Year2、9=Year20、10=Year30；デフォルト None) * **戻り値**
パラメータ 型 説明
ret RET_CODE API 呼び出し結果
data dict ret == RET_OK の場合、バリュエーション詳細データの辞書を返す
str ret != RET_OK の場合、エラーの説明を返す
* 返される辞書には以下のフィールドが含まれます： フィールド|型|説明 :-|:-|:- valuation_type|[ValuationType](./quote.md#7275)|実際のバリュエーション種別 (0=Unknown、1=PE、2=PB、3=PS) last_update_time|int|最終更新タイムスタンプ（秒、市場タイムゾーン） last_update_time_str|str|最終更新日時 (形式 YYYY-MM-DD HH:MM:SS、市場タイムゾーン) trend|dict|バリュエーション推移データ、trend フィールド表参照 market_distribution|dict|市場分布データ、market_distribution フィールド表参照 plate_distribution|dict|セクター分布データ、plate_distribution フィールド表参照 (個別銘柄のみ) profit_growth_rate|dict|利益/収益成長率データ、profit_growth_rate フィールド表参照 (個別銘柄のみ；PB バリュエーション種別では利用不可) * trend フィールド（バリュエーション推移サマリー）： フィールド|型|説明 :-|:-|:- current_value|float|現在バリュエーション average_value|float|過去平均バリュエーション avg_minus_1_stddev|float|過去平均 - 1σ avg_plus_1_stddev|float|過去平均 + 1σ valuation_percentile|float|過去分位数 (百分号前の値、例：12.34 は 12.34% を意味する) forward_value|float|予測バリュエーション (PE / PS のみ) historical_items|list|過去バリュエーションリスト、各項目は historical_items フィールド表参照 * historical_items フィールド（過去バリュエーション項目）： フィールド|型|説明 :-|:-|:- value|float|バリュエーション time|int|タイムスタンプ（秒、市場タイムゾーン） time_str|str|日付 (形式 YYYY-MM-DD、市場タイムゾーン) plate_value|float|セクター平均バリュエーション * market_distribution フィールド（市場 / 構成銘柄分布）： フィールド|型|説明 :-|:-|:- sections|list|分布区間リスト（降順）、各項目は sections フィールド表参照 total|int|市場銘柄数 / 構成銘柄数 ranking|int|市場内バリュエーション順位 (指数では利用不可) average_value|float|市場平均バリュエーション (指数では利用不可) median_value|float|市場中央値バリュエーション (指数では利用不可) * sections フィールド（分布区間項目）： フィールド|型|説明 :-|:-|:- start|float|区間開始値 end|float|区間終了値 (0 は上限なしを意味する) number|int|区間内銘柄数 * plate_distribution フィールド（セクター分布、個別銘柄のみ）： フィールド|型|説明 :-|:-|:- plate|str|セクターコード plate_name|str|セクター名 plate_average_value|float|セクター平均バリュエーション plate_ranking|int|セクター内バリュエーション順位 plate_stock_item_count|int|セクター内銘柄数 stock_items|list|セクター構成銘柄バリュエーション詳細、各項目は stock_items フィールド表参照 * stock_items フィールド（セクター構成銘柄項目）： フィールド|型|説明 :-|:-|:- security|str|銘柄コード name|str|銘柄名 value|float|バリュエーション market_cap|float|時価総額 * profit_growth_rate フィールド（利益/収益成長率、個別銘柄のみ、PB 除く）： フィールド|型|説明 :-|:-|:- financial_ttm_multiple|float|TTM 成長倍率 market_cap_multiple|float|時価総額成長倍率 year_count|int|成長倍率算出に使用した年数 profit_data|list|期間別データリスト、各項目は profit_data フィールド表参照 conclusion_detailed|str|バリュエーション結論説明 * profit_data フィールド（期間別利益/収益項目）： フィールド|型|説明 :-|:-|:- financial_year|int|財務報告年 financial_quarter|int|財務報告四半期 (1=Q1、2=Q2、3=Q3、4=FY) period_str|str|財務報告期間 (例：「2024/Q3」、「2024/FY」) report_date|int|報告日タイムスタンプ（秒、市場タイムゾーン） report_date_str|str|報告日 (形式 YYYY-MM-DD、市場タイムゾーン) market_cap_multiple|float|報告日時点の時価総額倍率 (基準期間 = 1) finance_data_multiple|float|利益/収益倍率 (基準期間 = 1；valuation_type に依存) * **Example** ```python from moomoo import * import pandas as pd quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_valuation_detail("HK.00700") if ret == RET_OK: trend = data.get('trend', {}) items = trend.get('historical_items', []) df = pd.DataFrame(items) print(df.to_string(index=False)) else: print('error:', data) quote_ctx.close() ``` * **Output** ```python value time time_str plate_value 22.690 1746979200 2025-05-12 22.678 22.186 1747065600 2025-05-13 22.179 22.843 1747152000 2025-05-14 22.817 22.046 1747238400 2025-05-15 22.050 21.538 1747324800 2025-05-16 21.577 21.792 1747584000 2025-05-19 21.821 //... 18.087 1776960000 2026-04-24 18.147 17.544 1777219200 2026-04-27 17.617 17.368 1777305600 2026-04-28 17.444 17.566 1777392000 2026-04-29 17.650 17.148 1777478400 2026-04-30 17.227 17.339 1777824000 2026-05-04 17.421 17.310 1777910400 2026-05-05 17.393 16.972 1777996800 2026-05-06 17.059 17.500 1778083200 2026-05-07 17.589 17.266 1778169600 2026-05-08 17.364 17.039 1778428800 2026-05-11 17.143 ``` :::tip 制限 * 30 秒間に最大 30 リクエストまで。 * 普通株、ファンド、指数に対応しています。 * PB バリュエーション種別では利益/収益成長率モジュールは含まれません。 * 指数では順位、平均値、中央値は含まれません。 ::: --- # セクター/指数構成銘柄バリュエーションリストの取得 `get_valuation_plate_stock_list(code, valuation_type=None, next_key=None, num=None, sort_type=None, sort_id=None, filter_security=None)` * **説明** セクターまたは指数の構成銘柄バリュエーションリストを取得します。バリュエーション、予測バリュエーション、過去分位数、時価総額を含みます。指数の初回全量リクエスト時には所属セクターリストも返されます * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|セクターまたは指数コード (例：HK.LIST23363（セクター）または HK.800000（指数）；個別銘柄は非対応) valuation_type|[ValuationType](./quote.md#7275)|バリュエーション種別 (0=Unknown、1=PE（株価収益率）、2=PB（株価純資産倍率）、3=PS（株価売上高倍率）；デフォルト None（1=PE）) next_key|str|ページネーションキー (初回リクエスト時は不要；続拉時は前回返された next_key を指定；"-1" はデータなしを意味する) num|int|ページサイズ (デフォルト 10、範囲 1～50) sort_type|[SortType](./quote.md#6910)|ソート方向 (1=Desc（降順）、2=Asc（昇順）；デフォルト None（昇順）) sort_id|[SortField](./quote.md#3508)|ソート列 (51=時価総額（デフォルト）、52=バリュエーション、53=予測バリュエーション、54=過去分位数) filter_security|str|セクターフィルター (指数のみ有効；セクターで構成銘柄を絞り込み、例：HK.LIST23363；省略時はフィルターなし) * **戻り値**
パラメータ 型 説明
ret RET_CODE API 呼び出し結果
data dict ret == RET_OK の場合、構成銘柄バリュエーションデータの辞書を返す
str ret != RET_OK の場合、エラーの説明を返す
* 返される辞書には以下のフィールドが含まれます： フィールド|型|説明 :-|:-|:- count|int|構成銘柄総数 stock_list|list|構成銘柄バリュエーションリスト；各項目は stock_list フィールド表参照 next_key|str|ページネーションキー ("-1" はデータなしを意味する) plate_list|list|所属セクターリスト (指数の初回全量リクエスト時のみ返される；各項目は plate_list フィールド表参照) * stock_list フィールド（構成銘柄バリュエーション項目）： フィールド|型|説明 :-|:-|:- symbol|str|銘柄コード valuation_val|float|バリュエーション forward_value|float|予測バリュエーション (現在 PE と PS のみ対応) valuation_percentile|float|過去分位数 (百分号前の値、例：12.34 は 12.34% を意味する) market_cap|float|時価総額 name|str|銘柄名 * plate_list フィールド（指数所属セクター項目）： フィールド|型|説明 :-|:-|:- symbol|str|セクターコード name|str|セクター名 * **Example** ```python from moomoo import * import pandas as pd quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_valuation_plate_stock_list("HK.LIST23363") if ret == RET_OK: df = pd.DataFrame(data.get('stock_list', [])) print(df.to_string(index=False)) else: print('error:', data) quote_ctx.close() ``` * **Output** ```python symbol name valuation_val valuation_percentile market_cap HK.08076 SING LEE -2.300 65.337673 3.029652e+07 HK.08092 ITE HOLDINGS 19.500 98.209927 3.609481e+07 HK.08036 EBROKER GROUP -12.000 35.313263 4.428000e+07 HK.01561 PAN ASIA DATA H -23.500 1.057770 5.007634e+07 HK.08071 CH NETCOMTECH -13.000 31.489015 6.091863e+07 HK.00248 HKC INT'L HOLD -2.056 19.446705 6.771489e+07 HK.01613 SYNERTONE -2.796 72.660700 8.841764e+07 HK.08062 EFT SOLUTIONS -93.333 0.244101 1.344000e+08 HK.01949 PLATT NERA -5.147 36.523929 1.344000e+08 HK.01206 TECHNOVATOR -0.314 41.171684 1.720823e+08 ``` :::tip API 制限 * 30 秒以内に最大 30 回リクエスト可能。 * セクターと指数をサポート；個別銘柄は非対応。 * 指数の初回全量リクエスト時には所属セクターリスト（plate_list）も返されます。 ::: --- # 配当情報の取得 `get_corporate_actions_dividends(code)` * **説明** 銘柄の配当履歴を取得します * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|銘柄コード (例：HK.00700；株式およびファンドに対応) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data dict ret == RET_OK の場合、配当データの辞書を返します
str ret != RET_OK の場合、エラーの説明を返します
* 返される辞書には以下のフィールドが含まれます： フィールド|型|説明 :-|:-|:- dividend_list|list|配当リスト (公告日の降順で並んでいます；各項目のフィールドは dividend_list フィールド表を参照) * dividend_list フィールド（配当エントリ）： フィールド|型|説明 :-|:-|:- pub_date|str|公告日 (形式：YYYY/MM/DD、対応市場のタイムゾーン) statement|str|分配方案 (例：「末期配当 HKD 5.3」) process|str|イベント状況 (例：「実施済み」/「予定」；香港株とA株の普通株と信託のみ値あり) record_date|str|基準日 (形式：YYYY/MM/DD、対応市場のタイムゾーン。ETFにはこのデータなし) ex_date|str|権利落ち日 (形式：YYYY/MM/DD、対応市場のタイムゾーン) dividend_payable_date|str|配当支払日 (形式：YYYY/MM/DD、対応市場のタイムゾーン) fiscal_year|str|会計年度 (例：「2026」；ETFのみ) * **Example** ```python from moomoo import * import pandas as pd quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_corporate_actions_dividends("HK.00700") if ret == RET_OK: df = pd.DataFrame(data.get('dividend_list', [])) print(df.to_string(index=False)) else: print('error:', data) quote_ctx.close() ``` * **Output** ```python pub_date statement process record_date ex_date dividend_payable_date 03/18/2026 Cash Dividend: 5.30000 HKD Per Share Plan 05/18/2026 05/15/2026 06/01/2026 03/19/2025 Cash Dividend: 4.50000 HKD Per Share Implementation 05/19/2025 05/16/2025 05/30/2025 03/20/2024 Cash Dividend: 3.40000 HKD Per Share Implementation 05/20/2024 05/17/2024 05/31/2024 03/22/2023 Cash Dividend: 2.40000 HKD Per Share Implementation 05/22/2023 05/19/2023 06/05/2023 11/16/2022 Distribution in Specie: 1.00000 MEITUAN-W Share for Every 10.00000 Shares Held Implementation 01/06/2023 01/05/2023 03/24/2023 03/23/2022 Cash Dividend: 1.60000 HKD Per Share Implementation 05/23/2022 05/20/2022 06/06/2022 12/23/2021 Distribution in Specie: 1.00000 JD-SW Share for Every 21.00000 Shares Held Implementation 01/21/2022 01/20/2022 03/25/2022 03/24/2021 Cash Dividend: 1.60000 HKD Per Share Implementation 05/25/2021 05/24/2021 06/07/2021 03/18/2020 Cash Dividend: 1.20000 HKD Per Share Implementation 05/18/2020 05/15/2020 05/29/2020 03/21/2019 Cash Dividend: 1.00000 HKD Per Share Implementation 05/20/2019 05/17/2019 05/31/2019 12/03/2018 Distribution in Specie: 1.00000 TME-SW Share for Every 3900.00000 Shares Held Implementation 01/02/2019 12/28/2018 02/20/2019 03/21/2018 Cash Dividend: 0.88000 HKD Per Share Implementation 05/21/2018 05/18/2018 06/01/2018 06/30/2017 Rights Issue: 1.00000 CHINA LIT Share for Every 1256.00000 Shares Held Implementation 10/19/2017 10/18/2017 11/07/2017 03/22/2017 Cash Dividend: 0.61000 HKD Per Share Implementation 05/22/2017 05/19/2017 06/02/2017 03/17/2016 Cash Dividend: 0.47000 HKD Per Share Implementation 05/23/2016 05/20/2016 06/02/2016 03/18/2015 Cash Dividend: 0.36000 HKD Per Share Implementation 05/18/2015 05/15/2015 05/29/2015 03/19/2014 Cash Dividend: 0.24000 HKD Per Share Implementation 05/19/2014 05/16/2014 05/30/2014 03/20/2013 Cash Dividend: 1.00000 HKD Per Share Implementation 05/21/2013 05/20/2013 05/30/2013 03/14/2012 Cash Dividend: 0.75000 HKD Per Share Implementation 05/21/2012 05/18/2012 05/30/2012 03/16/2011 Cash Dividend: 0.55000 HKD Per Share Implementation 05/04/2011 05/03/2011 05/25/2011 03/17/2010 Cash Dividend: 0.40000 HKD Per Share Implementation 05/06/2010 05/05/2010 05/26/2010 03/18/2009 Cash Dividend: 0.25000 HKD Per Share,Special Dividend: 0.10000 HKD Per Share Implementation 05/07/2009 05/06/2009 05/27/2009 03/19/2008 Cash Dividend: 0.16000 HKD Per Share Implementation 05/07/2008 05/06/2008 05/28/2008 03/21/2007 Cash Dividend: 0.12000 HKD Per Share Implementation 05/10/2007 05/09/2007 05/30/2007 03/22/2006 Cash Dividend: 0.08000 HKD Per Share Implementation 05/16/2006 05/15/2006 06/07/2006 03/17/2005 Cash Dividend: 0.07000 HKD Per Share Implementation 04/20/2005 04/19/2005 05/17/2005 ``` :::tip API制限 * 30秒以内に最大30回リクエスト可能。 * 株式およびファンドに対応。 ::: --- # 自社株買い情報の取得 `get_corporate_actions_buybacks(code, next_key=None, num=None)` * **説明** 銘柄の自社株買い履歴を取得します（香港株・A株対応、ページング対応） * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|銘柄コード (例：HK.00700；香港株、A株の正株およびファンドに対応) next_key|str|ページングキー (初回リクエスト時は空；前回レスポンスの next_key を渡すと続きを取得；"-1" はデータなし) num|int|ページサイズ (1ページあたりの件数、デフォルト10、範囲1~50) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data dict ret == RET_OK の場合、自社株買いデータの辞書を返します
str ret != RET_OK の場合、エラーの説明を返します
* 返される辞書には以下のフィールドが含まれます： フィールド|型|説明 :-|:-|:- next_key|str|ページングキー ("-1" はデータなし；次のリクエストの next_key に渡すと続きを取得) hk_buy_back_list|pd.DataFrame|香港株自社株買いリスト (各項目のフィールドは hk_buy_back_list フィールド表を参照；A株の場合は空) a_buy_back_list|pd.DataFrame|A株自社株買いリスト (各項目のフィールドは a_buy_back_list フィールド表を参照；香港株の場合は空) * hk_buy_back_list フィールド（香港株自社株買いエントリ）： フィールド|型|説明 :-|:-|:- publ_date|int|公告日タイムスタンプ (Unixタイムスタンプ（秒）、対応市場のタイムゾーン) publ_date_str|str|公告日 (形式：YYYY-MM-DD、対応市場のタイムゾーン) end_date|int|買付終了日タイムスタンプ (Unixタイムスタンプ（秒）、対応市場のタイムゾーン) end_date_str|str|買い付け終了日 (形式：YYYY-MM-DD、対応市場のタイムゾーン) buy_back_money|float|買付金額 buy_back_sum|int|買付株数 (単位：株) percentage|float|発行済株式数に対する割合 (百分号前の値、例：12.34 は 12.34% を意味します) high_price|float|最高買付価格 low_price|float|最低買付価格 cumulative_sum|int|今回累計買付株数 (単位：株) cumulative_percentage|float|今回累計買付割合 (百分号前の値、例：12.34 は 12.34% を意味します) share_type|str|株式種別 * a_buy_back_list フィールド（A株自社株買いエントリ）： フィールド|型|説明 :-|:-|:- change_reg_date|int|工商変更登記日タイムスタンプ (Unixタイムスタンプ（秒）、対応市場のタイムゾーン) change_reg_date_str|str|工商変更登記日 (形式：YYYY-MM-DD、対応市場のタイムゾーン) change_date|int|株式変更日タイムスタンプ (Unixタイムスタンプ（秒）、対応市場のタイムゾーン) change_date_str|str|株式変更日 (形式：YYYY-MM-DD、対応市場のタイムゾーン) event_proce_desc|str|イベント進捗説明 advance_date|int|提案公告日タイムスタンプ (Unixタイムスタンプ（秒）、対応市場のタイムゾーン) advance_date_str|str|提案公告日 (形式：YYYY-MM-DD、対応市場のタイムゾーン) meet_pass_date|int|株主総会承認日タイムスタンプ (Unixタイムスタンプ（秒）、対応市場のタイムゾーン) meet_pass_date_str|str|株主総会承認日 (形式：YYYY-MM-DD、対応市場のタイムゾーン) start_date|int|買付開始日タイムスタンプ (Unixタイムスタンプ（秒）、対応市場のタイムゾーン) start_date_str|str|買付開始日 (形式：YYYY-MM-DD、対応市場のタイムゾーン) end_date|int|買付終了日タイムスタンプ (Unixタイムスタンプ（秒）、対応市場のタイムゾーン) end_date_str|str|買付終了日 (形式：YYYY-MM-DD、対応市場のタイムゾーン) pay_date|int|支払日タイムスタンプ (Unixタイムスタンプ（秒）、対応市場のタイムゾーン) pay_date_str|str|支払日 (形式：YYYY-MM-DD、対応市場のタイムゾーン) seller|str|売却者 (買い戻される株式の保有者) buy_back_mode|str|買付方法 share_type|str|株式種別 buy_back_sum|int|買付株数 (単位：株) buy_back_money|float|買付金額 percentage|float|発行済株式数に対する割合 (百分号前の値、例：12.34 は 12.34% を意味します) value_floor|float|計画買付金額下限 value_ceiling|float|計画買付金額上限 price_floor|float|買付価格下限 price_ceiling|float|買付価格上限 volume_floor|float|計画買付株数下限 volume_ceiling|float|計画買付株数上限 * **Example** ```python from moomoo import * import pandas as pd quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_corporate_actions_buybacks("HK.00700", num=3) if ret == RET_OK: df = pd.DataFrame(data.get('hk_buy_back_list', [])) print(df.to_string(index=False)) else: print('error:', data) quote_ctx.close() ``` * **Output** ```python publ_date publ_date_str end_date end_date_str buy_back_money buy_back_sum percentage high_price low_price cumulative_sum cumulative_percentage share_type 1775664000 2026-04-09 1775664000 2026-04-09 1000880717.6 1964000 0.021373 514.5 503.0 119812000 1.30386 Ordinary shares 1775577600 2026-04-08 1775577600 2026-04-08 1000761103.7 1979000 0.021537 510.0 501.0 117848000 1.28249 Ordinary shares 1775059200 2026-04-02 1775059200 2026-04-02 300715258.5 615000 0.006693 496.0 485.2 115869000 1.26095 Ordinary shares ``` :::tip API制限 * 30秒以内に最大30回リクエスト可能。 * 香港株、A株の正株およびファンドに対応。 ::: --- # 株式分割情報の取得 `get_corporate_actions_stock_splits(code, next_key=None, num=None)` * **説明** 銘柄の株式分割・併合履歴を取得します（香港株は追加フィールドあり、ページング対応） * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|銘柄コード (例：US.AAPL；香港株、米国株、日本株、シンガポール株、マレーシア株の正株およびファンドに対応) next_key|str|ページングキー (初回リクエスト時は空；前回レスポンスの next_key を渡すと続きを取得；"-1" はデータなし) num|int|ページサイズ (1ページあたりの件数、デフォルト10、範囲1~50) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data dict ret == RET_OK の場合、株式分割データの辞書を返します
str ret != RET_OK の場合、エラーの説明を返します
* 返される辞書には以下のフィールドが含まれます： フィールド|型|説明 :-|:-|:- next_key|str|ページングキー ("-1" はデータなし；次のリクエストの next_key に渡すと続きを取得) split_list|list|株式分割リスト (各項目のフィールドは split_list フィールド表を参照) * split_list フィールド（株式分割エントリ）： フィールド|型|説明 :-|:-|:- dir_deci_pub_date|int|公告日タイムスタンプ (Unixタイムスタンプ（秒）、対応市場のタイムゾーン) dir_deci_pub_date_str|str|公告日 (形式：YYYY-MM-DD、対応市場のタイムゾーン) reform_type|str|再編方式 rate|str|比率 ex_date|int|権利落ち日タイムスタンプ (香港株のみ；Unixタイムスタンプ（秒）、対応市場のタイムゾーン) ex_date_str|str|権利落ち日 (香港株のみ；形式：YYYY-MM-DD、対応市場のタイムゾーン) sm_deci_date|int|決議日タイムスタンプ (香港株のみ；Unixタイムスタンプ（秒）、対応市場のタイムゾーン) sm_deci_date_str|str|決議日 (香港株のみ；形式：YYYY-MM-DD、対応市場のタイムゾーン) temp_trade_begin_date|int|仮取引開始日タイムスタンプ (香港株のみ；Unixタイムスタンプ（秒）、対応市場のタイムゾーン) temp_trade_begin_date_str|str|仮取引開始日 (香港株のみ；形式：YYYY-MM-DD、対応市場のタイムゾーン) simul_trade_begin_date|int|並行取引開始日タイムスタンプ (香港株のみ；Unixタイムスタンプ（秒）、対応市場のタイムゾーン) simul_trade_begin_date_str|str|並行取引開始日 (香港株のみ；形式：YYYY-MM-DD、対応市場のタイムゾーン) simul_trade_end_date|int|並行取引終了日タイムスタンプ (香港株のみ；Unixタイムスタンプ（秒）、対応市場のタイムゾーン) simul_trade_end_date_str|str|並行取引終了日 (香港株のみ；形式：YYYY-MM-DD、対応市場のタイムゾーン) event_status|str|イベント進捗 (香港株のみ；例：方案実施) new_par_value|float|新額面価格 (香港株のみ) temp_share_code|str|仮証券コード (香港株のみ；例：02988) temp_share_abbr_name|str|仮証券略称 (香港株のみ；例：テンセント・ホールディングス) new_trade_unit|int|新売買単位 (香港株のみ；例：100) shares_after_effect|float|発効後株数 (香港株のみ；単位：株) * **Example** ```python from moomoo import * import pandas as pd quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_corporate_actions_stock_splits("HK.00700", num=3) if ret == RET_OK: df = pd.DataFrame(data.get('split_list', [])) print(df.to_string(index=False)) else: print('error:', data) quote_ctx.close() ``` * **Output** ```python dir_deci_pub_date dir_deci_pub_date_str reform_type rate ... temp_share_abbr_name new_trade_unit shares_after_effect 1395158400 2014-03-19 Split 1->5 ... Tencent 100 9319999970.0 ``` :::tip インターフェース制限 * 30秒以内に最大30回リクエスト可能です。 * 香港株、米国株、日本株、シンガポール株、マレーシア株の正株およびファンドに対応しています。 ::: --- # 株主持株概要の取得 `get_shareholders_overview(code, period_id=None)` * **説明** 銘柄の株主持株概要を取得します。主要株主と保有者タイプの2グループのデータを同時に返します * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|銘柄コード (例：HK.00700；香港株、米国株、シンガポール株、日本株、マレーシア株の正株およびファンドに対応) period_id|int|報告期 ID (0 または未指定の場合は最新データを返し、利用可能な報告期リストも返す；報告期 ID は holding_period リストから取得可能) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data dict ret == RET_OK の場合、株主持株概要データの辞書を返します
str ret != RET_OK の場合、エラーの説明を返します
* 返される辞書には以下のフィールドが含まれます： フィールド|型|説明 :-|:-|:- main_holder|pd.DataFrame|主要株主リスト (各項目のフィールドは main_holder フィールド表を参照) holder_type|pd.DataFrame|保有者タイプリスト (各項目のフィールドは holder_type フィールド表を参照；main_holder と同じ構造、holder_id は常に 0) holding_period|pd.DataFrame|利用可能な報告期リスト (period_id が 0 または未指定の場合のみ返す；各項目のフィールドは holding_period フィールド表を参照) * main_holder / holder_type フィールド（持株統計エントリ）： フィールド|型|説明 :-|:-|:- static_date|int|統計日タイムスタンプ (Unixタイムスタンプ（秒）、対応市場のタイムゾーン) static_date_str|str|統計日 (形式：YYYY-MM-DD、対応市場のタイムゾーン) name|str|保有者名称 (保有者またはグループの名称) holder_pct|float|保有比率 (パーセント記号の前の値、例：23.05 は 23.05% を意味する) holder_id|int|株主 ID (main_holder では値あり；holder_type では常に 0) * holding_period フィールド（利用可能な報告期エントリ）： フィールド|型|説明 :-|:-|:- period_text|str|報告期 (例："2025/Q3") period_id|int|報告期 ID (次のリクエストの period_id パラメータにそのまま渡す) * **Example** ```python from moomoo import * import pandas as pd quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_shareholders_overview("HK.00700") if ret == RET_OK: df = data.get('main_holder') if df is not None: print(df.to_string(index=False)) else: print('error:', data) quote_ctx.close() ``` * **Output** ```python static_date static_date_str name holder_pct holder_id 1778469309 2026-05-11 Prosus Ventures N.V. 23.05351 337488017.0 1778469309 2026-05-11 Huateng Ma 7.86952 10253703.0 1778469309 2026-05-11 The Vanguard 2.97766 417222.0 1778469309 2026-05-11 BlackRock 2.66990 403413.0 1778469309 2026-05-11 Norges Bank Investment Management 1.36075 27081864.0 1778469309 2026-05-11 Other 62.06866 NaN ``` :::tip レート制限 * 30秒以内に最大30回のリクエスト。 * 香港株、米国株、シンガポール株、日本株、マレーシア株の正株およびファンドに対応。 ::: --- # 株主持株変動の取得 `get_shareholders_holding_changes(code, next_key=None, num=None, sort_type=None, sort_column=None, filter_type=None)` * **説明** 指定銘柄の持株変動記録を取得します。ページネーションに対応しています * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|銘柄コード (例：HK.00700；香港株、米国株、シンガポール株、マレーシア株、日本株の正株およびファンドに対応) next_key|str|ページネーションキー (初回はなし；続きを取得する場合は前回返された next_key を渡す；"-1" はデータなしを意味する) num|int|1ページあたりの件数 (デフォルト 10、範囲 1~50) sort_type|SortType|ソート方向 (1=降順（デフォルト），2=昇順) sort_column|SortField|ソートフィールド (62=持株変動数（デフォルト），63=持株日付，64=変動比率，65=変動金額，66=持株比率) filter_type|HoldingChangesFilterType|フィルタータイプ (0=全て（デフォルト），1=増加，2=減少，3=新規参入，4=清算) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、持株変動記録の DataFrame を返します
str ret != RET_OK の場合、エラーの説明を返します
* DataFrame フィールド説明： フィールド|型|説明 :-|:-|:- period_text|str|報告期 (例："2026/Q1") name|str|株主名 holder_id|int|株主 ID (保有履歴変動明細を取得するために使用) share_change_num|int|持株変動数 (単位：株) shares_change_price|int|参考変動金額 (単位：HKD または USD（市場による）) share_ratio|float|持株比率 (パーセント記号の前の値、例：12.34 は 12.34% を意味する) holder_type|str|保有者タイプ (テキスト説明、例："伝統的投資マネージャー") holder_type_id|int|保有者タイプ ID (保有履歴変動明細を取得するために使用) holding_date_str|str|保有日付 (形式：YYYY-MM-DD、香港時区) share_ratio_change|float|持株変動比率 (パーセント記号の前の値、例：12.34 は 12.34% の変動を意味する) share_num|int|保有株数 (単位：株) next_key|str|ページネーションキー ("-1" はデータなしを意味する；次のリクエストの next_key パラメータにそのまま渡す) * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_shareholders_holding_changes("HK.00700") if ret == RET_OK: print(data[['period_text', 'name', 'share_change_num', 'share_ratio', 'share_ratio_change']].to_string(index=False)) print('next_key:', data['next_key'][0]) else: print('error:', data) quote_ctx.close() ``` * **Output** ```python period_text name share_change_num share_ratio share_ratio_change 2026/Q1 BlackRock 7971983 2.669 0.088 2026/Q1 CSOP Asset Management Limited 6691695 0.192 0.074 2026/Q1 Hang Seng Investment Management Limited 4870059 0.395 0.053 2026/Q1 GQG Partners, LLC 3289800 0.146 0.036 2026/Q1 The Vanguard 2837500 2.977 0.031 2026/Q1 Pinebridge Investments Asia Limited 2316700 0.073 0.025 2026/Q1 Capital Research 2214900 0.948 0.024 2026/Q1 Australian Super 2214046 0.116 0.024 2026/Q1 Mirae Asset Global Investments Co., Ltd 1852929 0.096 0.020 2026/Q1 Baillie Gifford 1831832 0.395 0.020 next_key: 10 ``` :::tip API制限 * 30秒以内に最大30回リクエスト可能。 * 香港株、米国株、シンガポール株、マレーシア株、日本株の正株およびファンドに対応。 ::: --- # 株主持株明細の取得 `get_shareholders_holder_detail(code, request_type=None, next_key=None, num=None, sort_column=None, sort_type=None, period_id=None, holder_id=None)` * **説明** 指定銘柄の指定保有者タイプの持株明細リストを取得します。ページネーションに対応しています * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|銘柄コード (例：US.AAPL；香港株、米国株、シンガポール株、日本株、マレーシア株の正株およびファンドに対応) request_type|[HolderDetailType](./quote.md#2465)|保有者タイプ (0=デフォルト，1000=全部，1=その他機関，2=伝統的投資マネージャー，3=ヘッジファンド，4=ベンチャー/プライベートエクイティ，5=企業年金，6=財団ファンド，7=保険会社，8=銀行/投資銀行，9=ファミリーオフィス/トラスト，10=政府系ファンド，11=REIT，12=ストラクチャードファイナンスマネージャー，13=労組年金，14=政府年金，15=基金，100=個人，200=ADS，300=上場企業，400=非上場企業，500=国有株；デフォルトはサーバー側ロジックによる) next_key|str|ページネーションキー (初回はなし；続きを取得する場合は前回返された next_key を渡す；"-1" はデータなしを意味する) num|int|1ページあたりの件数 (デフォルト 10、範囲 1~50) sort_column|[SortField](./quote.md#3508)|ソートフィールド (61=保有株数（デフォルト），62=持株変動数) sort_type|[SortType](./quote.md#6910)|ソート方向 (1=降順（デフォルト），2=昇順) period_id|int|報告期 ID (GetShareholdersOverview（3237）が返す holdingPeriodList の periodId と対応；デフォルト 0 は最新期) holder_id|int|保有者 ID フィルター (デフォルト 0 はフィルターなし；GetShareholdersOverview（3237）、GetShareholdersHoldingChanges（3238）、本プロトコル（3239）、GetInsiderHolderList（3241）、GetInsiderTradeList（3242）から取得可能) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、持株明細の DataFrame を返します
str ret != RET_OK の場合、エラーの説明を返します
* DataFrame フィールド説明： フィールド|型|説明 :-|:-|:- update_time_str|str|データ更新時刻 (形式：YYYY-MM-DD HH:MM:SS、対応市場タイムゾーン) next_key|str|ページネーションキー ("-1" はデータなしを意味する；次のリクエストの next_key パラメータにそのまま渡す) period_text|str|報告期 (例："2026/Q1") holder_id|int|保有者 ID (他の株主関連プロトコルの holder_id フィルターとして使用可能) name|str|保有者名 holder_quantity|int|保有株数合計 (単位：株) holder_quantity_change|int|持株変動数 (単位：株；正値は増加、負値は減少) holder_pct|float|持株比率 (パーセント記号の前の値、例：12.34 は 12.34% を意味する) holder_pct_change|float|持株変動比率 (パーセント記号の前の値、例：12.34 は 12.34% の変動を意味する；負値は減少) holding_date_str|str|保有日付 (形式：YYYY-MM-DD、香港時区) close_price|float|保有日付の終値 (保有日付に対応する実際の終値) price_change_pct|float|株価変動比率 (パーセント記号の前の値、例：-0.4467 は -0.4467% を意味する) source_group_name|str|データソース (持株明細の開示元、例："13F"、"13F Summary" など) * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_shareholders_holder_detail("HK.00700", request_type=1000) if ret == RET_OK: print(data[['period_text', 'name', 'holder_quantity', 'holder_pct', 'holder_pct_change']].to_string(index=False)) print('next_key:', data.attrs.get('next_key', '-1')) else: print('error:', data) quote_ctx.close() ``` * **Output** ```python period_text name holder_quantity holder_pct holder_pct_change 2026/Q1 Prosus Ventures N.V. 2079512000 23.053 -0.285 2026/Q1 Huateng Ma 709859700 7.869 0.000 2026/Q1 The Vanguard 268596433 2.977 0.031 2026/Q1 BlackRock 240834898 2.669 0.088 2026/Q1 Norges Bank Investment Management 122744699 1.360 -0.083 2026/Q1 FMR 86765121 0.961 -0.232 2026/Q1 Capital Research 85568118 0.948 0.024 2026/Q1 J.P. Morgan Asset Management, Inc. 62437911 0.692 -0.025 2026/Q1 E Fund Management Co., Ltd. 52722677 0.584 0.000 2026/Q1 Baillie Gifford 35674108 0.395 0.020 next_key: 10 ``` :::tip API制限 * 30秒以内に最大30回リクエスト可能。 * 香港株、米国株、シンガポール株、日本株、マレーシア株の正株およびファンドに対応。 * ページネーションに対応；デフォルトのページサイズは 10；ページネーションキーは文字列型。 ::: --- # 機関投資家保有株式の取得 `get_shareholders_institutional(code, next_key=None, num=None)` * **説明** 銘柄の機関投資家数および保有株式数の履歴を取得します。ページングに対応しています。 * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|銘柄コード (例：US.AAPL；香港株、米国株、シンガポール株、日本株、マレーシア株の正株およびファンドに対応) next_key|str|ページングキー (初回リクエスト時は不要；続きを取得する場合は前回のレスポンスの next_key を渡す；"-1" はデータなし) num|int|1ページあたりの件数 (デフォルト 10、範囲 1~50) * **戻り値**
パラメータ 型 説明
ret RET_CODE API 呼び出し結果
data pd.DataFrame ret == RET_OK の場合、機関投資家保有 DataFrame を返す
str ret != RET_OK の場合、エラーの説明を返す
* DataFrame フィールドの説明： フィールド|型|説明 :-|:-|:- period_text|str|報告期間 (例："2026/Q1") institution_quantity|int|機関投資家数 (単位：社) institution_quantity_change|int|機関投資家数の変化 (単位：社；正は増加、負は減少) holder_quantity|int|機関保有株式総数 (単位：株) holder_quantity_change|int|保有株式数の変化 (単位：株；正は増加、負は減少) holder_pct|float|保有比率 (パーセント記号の前の値、例：12.34 は 12.34% を意味する) holder_pct_change|float|保有比率の変化 (パーセント記号の前の値、例：12.34 は 12.34% の変化を意味する；負は減少) update_time_str|str|データ更新時刻 (形式 YYYY-MM-DD HH:MM:SS、対応する市場のタイムゾーン) next_key|str|ページングキー ("-1" はデータなし；続きを取得する際はそのまま next_key に渡す) * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_shareholders_institutional("HK.00700") if ret == RET_OK: print(data[['period_text', 'institution_quantity', 'holder_quantity', 'holder_pct']].to_string(index=False)) print('next_key:', data.attrs.get('next_key', '-1')) else: print('error:', data) quote_ctx.close() ``` * **Output** ```python period_text institution_quantity holder_quantity holder_pct 2026/Q1 863 4192178205 46.474 2025/Q4 873 4195284653 46.444 2025/Q3 854 4219387239 46.614 2025/Q2 839 4254708217 46.881 2025/Q1 809 4236696253 46.491 2024/Q4 808 4331865949 47.431 2024/Q3 803 4404605110 47.919 2024/Q2 846 4438538978 47.926 2024/Q1 824 4484844061 48.055 2023/Q4 857 4472729401 47.717 next_key: -1 ``` :::tip API 制限 * 30 秒間に最大 30 リクエスト。 * 香港株、米国株、シンガポール株、日本株、マレーシア株の正株およびファンドに対応。 * ページングに対応；デフォルト 1 ページあたり 10 件；ページングキーは文字列型。 ::: --- # インサイダー保有株式リストの取得 `get_insider_holder_list(code, next_key=None, num=None)` * **説明** 米国株のインサイダー（役員/取締役/主要株主）の保有株式リストを取得します。ページングに対応しており、初回リクエスト時にはインサイダー統計サマリーも返されます。 * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|銘柄コード (例：US.AAPL；米国株・シンガポール株の普通株およびファンドに対応) next_key|str|ページングキー (初回リクエスト時は不要；続きを取得する場合は前回のレスポンスの next_key を渡す；"-1" はデータなし) num|int|1ページあたりの件数 (デフォルト 10、範囲 1~20) * **戻り値**
パラメータ 型 説明
ret RET_CODE API 呼び出し結果
data pd.DataFrame ret == RET_OK の場合、インサイダー保有 DataFrame を返す
str ret != RET_OK の場合、エラーの説明を返す
* DataFrame フィールドの説明： フィールド|型|説明 :-|:-|:- holder_id|int|株主 ID (get_insider_trade_list および get_shareholders_holder_detail の入力として使用可能) holder_quantity|int|保有株式総数 (単位：株) holder_pct|float|保有比率 (パーセント記号の前の値、例：12.34 は 12.34% を意味する) name|str|株主名 title|str|役職 all_count|int|総件数 next_key|str|ページングキー ("-1" はデータなし；続きを取得する際はそのまま next_key に渡す) insider_total_count|int|インサイダー総人数 (初回ページ（next_key が空の場合）のみ返される) insider_bought_count|int|買い増し人数 (買い増したインサイダーの人数；初回ページのみ返される) insider_sold_count|int|売却人数 (売却したインサイダーの人数；初回ページのみ返される) * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_insider_holder_list("US.AAPL") if ret == RET_OK: print(data[['holder_id', 'name', 'title', 'holder_quantity', 'holder_pct']].to_string(index=False)) print('insider_total:', data['insider_total_count'].iloc[0]) print('next_key:', data['next_key'].iloc[0]) else: print('error:', data) quote_ctx.close() ``` * **Output** ```python holder_id name title holder_quantity holder_pct 234085 Arthur Levinson Independent Non-Executive Chairperson 4125576 0.028 169600 Timothy Cook Chief Executive Officer 3280418 0.022 626415138 Sabih Khan Officer 1105527 0.007 34123508 Katherine Adams Senior Vice President 175408 0.001 531640091 Deirdre O’Brien Senior Vice President of Retail 136810 0.000 285767 Ronald Sugar Independent Director 110566 0.000 50035778 Luca Maestri Chief Financial Officer 91304 0.000 253136 Andrea Jung Independent Director 77664 0.000 22072913 Susan Wagner Independent Director 69788 0.000 1976351584 Ben Borders Principal Accounting Officer 39987 0.000 insider_total: 17 next_key: 10 ``` :::tip API 制限 * 30 秒間に最大 30 リクエスト。 * 米国株・シンガポール株の普通株およびファンドのみ対応。 * ページングに対応；デフォルト 1 ページあたり 10 件、最大 20 件；ページングキーは文字列型。 * インサイダー統計サマリー（総人数/買い増し人数/売却人数）は初回ページ（nextKey が空の場合）のみ返される。 ::: --- # インサイダー取引の取得 `get_insider_trade_list(code, holder_id=None, num=None, next_key=None)` * **説明** 米国株のインサイダー（役員/取締役/主要株主）の取引記録リストを取得します。保有者でフィルタリングしたり、ページネーションで続きを取得することができます * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|銘柄コード (例：US.AAPL；米国株式・シンガポール株式・ファンドに対応) holder_id|int|保有者 ID (省略するとすべてのインサイダーを照会；get_insider_holder_list（3241）または本 API の返り値 holder_id から取得可) num|int|1ページの件数 (デフォルト 10、範囲 1~50) next_key|str|ページネーションキー (初回は省略；続きを取得する場合は前回返された next_key を指定；"-1" はデータなしを意味する) * **戻り値**
パラメータ 型 説明
ret RET_CODE API 呼び出し結果
data pd.DataFrame ret == RET_OK の場合、インサイダー取引の DataFrame を返す
str ret != RET_OK の場合、エラーの説明を返す
* DataFrame フィールド説明： フィールド|型|説明 :-|:-|:- trade_shares|int|取引株数 (正数は買付/取得、負数は売却) min_trade_date|int|最小取引日時タイムスタンプ (Unix タイムスタンプ（秒）、市場タイムゾーン) min_trade_date_str|str|最小取引日文字列 (形式 YYYY-MM-DD、市場タイムゾーン) max_trade_date|int|最大取引日時タイムスタンプ (Unix タイムスタンプ（秒）、市場タイムゾーン) max_trade_date_str|str|最大取引日文字列 (形式 YYYY-MM-DD、市場タイムゾーン) min_price|float|最小取引価格 max_price|float|最大取引価格 security_holder_quantity|int|取引後の保有株数 (取引後の証券保有総数；売却意向などの場合は null になることがある) is_proposed_sale_of_securities|bool|売却意向 (証券の売却意向（Form 144 申告）かどうか) holder_id|int|株主 ID name|str|株主名 title|str|株主の役職 security_description|str|証券種別説明 (例："普通株") transaction_type|str|取引種別 (例："売却"、"行使取得"、"行使売却"、"売却意向" など) source_group_name|str|データソース (例："Form 4"、"Form 144") all_count|int|総件数 next_key|str|ページネーションキー ("-1" はデータなし；続きを取得する場合はそのまま next_key に指定) * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_insider_trade_list("US.AAPL") if ret == RET_OK: print(data[['holder_id', 'name', 'title', 'transaction_type', 'trade_shares']].to_string(index=False)) else: print('error:', data) quote_ctx.close() ``` * **Output** ```python holder_id name title transaction_type trade_shares 234085 Arthur Levinson Independent Non-Executive Chairperson Open Market Disposition -250000 234085 Arthur Levinson Independent Non-Executive Chairperson Other Disposition -5000 34123508 Katherine Adams Senior Vice President Intent to Sell (Form 144) -43000 1892533533 Kevan Parekh Chief Financial Officer Automatic Disposition -1534 1892533533 Kevan Parekh Chief Financial Officer Derivative Exercise and Retained Stock 6135 1892533533 Kevan Parekh Chief Financial Officer Derivative Exercise and Sale -4793 1976351584 Ben Borders Principal Accounting Officer Derivative Exercise and Retained Stock 825 1976351584 Ben Borders Principal Accounting Officer Derivative Exercise and Sale -892 169600 Timothy Cook Chief Executive Officer Intent to Sell (Form 144) -64949 531640091 Deirdre O’Brien Senior Vice President of Retail Intent to Sell (Form 144) -30002 ``` :::tip API 制限 * 30 秒以内に最大 30 回までリクエスト可能。 * 米国株式・シンガポール株式・ファンドのみ有効。 * ページネーション対応；デフォルト 10 件/ページ、最大 50 件；ページネーションキーは文字列型。 * holderId は GetInsiderHolderList（3241）または本プロトコル（3242）の返り値から取得可能。 ::: --- # 会社概要の取得 `get_company_profile(code)` * **説明** 指定した銘柄の会社概要タグリストを取得します。テキスト、リンク、セクション見出しなどの情報が含まれます * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|銘柄コード (例：HK.00700；個別株および投資信託に対応) * **戻り値**
パラメータ 型 説明
ret RET_CODE API 呼び出し結果
data pd.DataFrame ret == RET_OK の場合、会社概要 DataFrame を返す
str ret != RET_OK の場合、エラー説明を返す
* DataFrame フィールド説明： フィールド|型|説明 :-|:-|:- name|str|タグ名 value|str|タグの内容 field_type|[CompanyProfileFieldType](./quote.md#9340)|タグ種別 (0=SourceText（テキスト），1=LinkType（リンク），2=IndependentTitle（独立セクション見出し）) * **Example** ```python from moomoo import * import pandas as pd quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_company_profile("HK.00700") if ret == RET_OK: print(data.to_string(index=False)) else: print('error:', data) quote_ctx.close() ``` * **Output** ```python field_type name value 0 Symbol 00700 0 Company Name TENCENT 0 ISIN KYG875721634 0 Listing Date Jun 16, 2004 0 Issue Price 3.70 0 Shares Offered 420.16M share(s) 0 Founded Nov 23, 1999 0 Registered Address Cayman Islands 0 Chairman huateng ma 0 Audit Institution PwC 0 Company Category Overseas registratio ... 0 Registered Office Cricket Square, ... 0 Head Office and ... 29th Floor, Tower 3,... 0 Fiscal Year Ends 12-31 0 Employees 115849 0 Market Hong Kong motherboard 0 Phone (852) 2179-5122 0 Fax (852) 2520-1148 0 Email ir@tencent.com 1 Website http://www.tencent.com 2 Business Tencent Holdings Ltd is... 2 Description Tencent leverages ... ``` :::tip API制限 * 30秒以内に最大30回のリクエストが可能です。 * 個別株および投資信託に対応しています。 ::: --- # 役員情報の取得 `get_company_executives(code)` * **説明** 指定した銘柄の取締役および役員リストを取得します。表示名、氏名、役職、就任開始日、公開日、性別、年齢、学歴、年俸などの情報が含まれます * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|銘柄コード (例：HK.00700；個別株および投資信託に対応) * **戻り値**
パラメータ 型 説明
ret RET_CODE API 呼び出し結果
data pd.DataFrame ret == RET_OK の場合、役員情報 DataFrame を返す
str ret != RET_OK の場合、エラー説明を返す
* DataFrame フィールド説明： フィールド|型|説明 :-|:-|:- display_leader_name|str|表示名 (表示専用。get_company_executive_background への入力には使用しない) leader_name|str|役員氏名 (get_company_executive_background に渡して経歴を照会可能) position_name|str|役職名 begin_date|int|就任開始日タイムスタンプ（秒） begin_date_str|str|就任開始日 (形式 YYYY-MM-DD、市場タイムゾーン) leader_gender|str|性別 (例："Male" / "Female") leader_age|str|年齢 highest_education|str|最終学歴 annual_salary|int|年俸 issue_date|int|公開日タイムスタンプ（秒） issue_date_str|str|公開日 (形式 YYYY-MM-DD、市場タイムゾーン) * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_company_executives("US.AAPL") if ret == RET_OK: print(data[['display_leader_name', 'position_name', 'begin_date_str', 'annual_salary']].to_string(index=False)) print('count:', len(data)) else: print('error:', data) quote_ctx.close() ``` * **Output** ```python display_leader_name position_name begin_date_str annual_salary Timothy D. Cook Director and Chief Executive Officer NaN 74294811.0 Sabih Khan Chief Operating Officer NaN 27031671.0 Kevan Parekh Chief Financial Officer and Senior Vice President NaN 22467309.0 Ben Borders Principal Accounting Officer and Senior Director, Corporate Accounting NaN NaN Katherine L. Adams Senior Vice President NaN 27032248.0 Deirdre O'Brien Senior Vice President, Retail and People NaN 27047633.0 Jennifer G. Newstead Senior Vice President, General Counsel and Secretary NaN NaN John Ternus Senior Vice President, Hardware Engineering NaN NaN Dr. Arthur D. Levinson, PhD Chairman of the Board NaN 557231.0 Susan L. Wagner Independent Director NaN 445373.0 Monica C. Lozano Independent Director NaN 412956.0 Andrea Jung Independent Director NaN 458020.0 Alex Gorsky Independent Director NaN 416492.0 Dr. Wanda M. Austin, PhD Independent Director NaN 412850.0 Dr. Ronald D. Sugar Independent Director NaN 471283.0 count: 15 ``` :::tip API制限 * 30秒以内に最大30回のリクエストが可能です。 * 個別株および投資信託に対応しています。 ::: --- # 役員経歴の取得 `get_company_executive_background(code, leader_name=None)` * **説明** 指定した銘柄の特定役員の経歴プロフィールを取得します * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|銘柄コード (例：HK.00700；個別株および投資信託に対応) leader_name|str|役員氏名 (get_company_executives が返す leader_name フィールドの値を使用) * **戻り値**
パラメータ 型 説明
ret RET_CODE API 呼び出し結果
data dict ret == RET_OK の場合、役員経歴情報 dict を返す
str ret != RET_OK の場合、エラー説明を返す
* 返却 dict フィールド説明： フィールド|型|説明 :-|:-|:- brief_background|str|役員経歴プロフィール * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_company_executive_background("US.AAPL", leader_name="Mr. Timothy D. Cook") if ret == RET_OK: print(data) else: print('error:', data) quote_ctx.close() ``` * **Output** ```python {'brief_background': "On April 20, 2026, Apple Inc. announced that Tim Cook will transition from his role as Chief Executive Officer to Executive Chair of Apple's Board of Directors, effective September 1, 2026. Mr. Cook, 65, has served as Apple's Chief Executive Officer since 2011, having previously served as Apple's Chief Operating Officer from October 2005. Mr. Cook joined Apple in March 1998 and served as Executive Vice President, Worldwide Sales and Operations from February 2002 to October 2005. From October 2000 to February 2002, Mr. Cook served as Senior Vice President, Worldwide Operations, Sales, Service and Support. From March 1998 to October 2000, Mr. Cook served as Senior Vice President, Worldwide Operations. Mr. Cook serves on the Board of Directors of The National Football Foundation & College Hall of Fame, Inc., the Board of Trustees of Duke University, and on the Leadership Council for the Malala Fund, an international non-profit organization that advocates for girls' education. Other Public Company Boards: Current: NIKE, Inc."} ``` :::tip API制限 * 30秒以内に最大30回のリクエストが可能です。 * 個別株および投資信託に対応しています。 ::: --- # 経営効率の取得 `get_company_operational_efficiency(code, num=10, next_key=None, currency_code=None, financial_type=0)` * **説明** 指定した銘柄の経営効率データ（従業員数、一人当たり売上高、一人当たり営業利益、一人当たり純利益など）を取得します。 * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|銘柄コード (例：HK.00700；普通株およびファンドに対応) num|int|1ページあたりの返却件数 (デフォルト 10、範囲 1~50) next_key|str|ページネーションキー (初回はなし、続きを取得する場合は前回の next_key を指定；"-1" はデータなし) currency_code|str|通貨コード (ISO 4217（例：CNY、USD、HKD、SGD、JPY、CAD、AUD）；未指定の場合はデフォルト通貨を返す) financial_type|F10Type|財務報告期間 (0-7 対応、デフォルト 0（制限なし）) * **F10Type 列挙** 値|説明 :-|:- 0|制限なし 1|Q1（第1四半期） 2|Q2（第2四半期） 3|Q3（第3四半期） 4|Q4（第4四半期） 5|Q6（半期報告） 6|Q9（第3四半期報告） 7|Annual（年次報告） * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data dict ret == RET_OK の場合、経営効率データの dict を返す
str ret != RET_OK の場合、エラー説明を返す
* dict フィールド説明： フィールド|型|説明 :-|:-|:- item_list|list|経営効率リスト、各項目は dict（フィールドは下表参照） next_key|str|ページネーションキー ("-1" はデータなし) currency_code|str|通貨コード (ISO 4217) * item_list サブフィールド： フィールド|型|説明 :-|:-|:- fiscal_year|int|会計年度 (例：2024) financial_type|[F10Type](./quote.md#337)|財務報告種別 period_text|str|報告期間 (例："2024/Q3"、"2024/FY") end_date|int|期末タイムスタンプ（秒単位 Unix タイムスタンプ） end_date_str|str|期末日付文字列 (形式 YYYY-MM-DD、市場のタイムゾーン) employee_num|int|従業員数 employee_num_yoy|float|従業員数の前年比 (%前の値、例：12.34 は 12.34% を表す) income_per_capita|float|一人当たり売上高 income_per_capita_yoy|float|一人当たり売上高の前年比 (%前の値、例：12.34 は 12.34% を表す) profit_per_capita|float|一人当たり営業利益 profit_per_capita_yoy|float|一人当たり営業利益の前年比 (%前の値、例：12.34 は 12.34% を表す) net_profit_per_capita|float|一人当たり純利益 net_profit_per_capita_yoy|float|一人当たり純利益の前年比 (%前の値、例：12.34 は 12.34% を表す) * **Example** ```python from moomoo import * import pandas as pd quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_company_operational_efficiency("HK.00700") if ret == RET_OK: df = pd.DataFrame(data.get('item_list', [])) print(df.to_string(index=False)) else: print('error:', data) quote_ctx.close() ``` * **Output** ```python fiscal_year period_text end_date end_date_str employee_num employee_num_yoy income_per_capita income_per_capita_yoy profit_per_capita profit_per_capita_yoy net_profit_per_capita net_profit_per_capita_yoy 2025 2025/FY 1767110400 2025-12-31 115849 4.7857 6489188.5126 8.6594 2085145.3184 10.7787 1983625.2362 11.6246 2024 2024/FY 1735574400 2024-12-31 110558 4.8768 5972041.8242 3.3726 1882260.8947 23.9566 1777049.1506 58.6906 2023 2023/FY 1703952000 2023-12-31 105417 -2.7841 5777199.1234 12.9662 1518483.7360 48.5723 1119819.3839 -35.6529 2022 2022/FY 1672416000 2022-12-31 108436 -3.8440 5114094.9500 2.9643 1022049.8727 -57.5666 1740279.9808 -13.8522 2021 2021/FY 1640880000 2021-12-31 112771 31.3459 4966862.0478 -11.5377 2408597.9551 12.2453 2020111.5535 8.3170 2020 2020/FY 1609344000 2020-12-31 85858 36.5317 5614666.0765 -6.4170 2145833.8186 13.6879 1864998.0199 22.3097 2019 2019/FY 1577721600 2019-12-31 62885 15.7911 5999666.0570 4.2027 1887477.1408 4.9760 1524815.1387 3.5346 2018 2018/FY 1546185600 2018-12-31 54309 21.2362 5757682.8886 8.4796 1798007.6966 -10.8064 1472757.7381 -8.9654 2017 2017/FY 1514649600 2017-12-31 44796 15.5280 5307616.7514 35.4518 2015849.6294 39.2885 1617800.6964 51.3504 2016 2016/FY 1483113600 2016-12-31 38775 26.5461 3918452.6112 16.7235 1447246.9374 9.1517 1068910.3803 12.5205 ``` :::tip 制限事項 * 30秒間に最大30回のリクエスト。 * 普通株およびファンドに対応。 ::: --- # 十大ブローカー売買データの取得 `get_top_ten_buy_sell_brokers(code, days_before=None)` * **説明** 指定した香港株の十大ネット買いおよびネット売りブローカーリストを取得します（リアルタイムまたは履歴） * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|銘柄コード (香港株（普通株およびファンド）のみ対応、例：HK.00700) days_before|int|履歴日数 (未指定または 0=リアルタイムデータ（平均価格/総出来高/総売買代金を含む）、>0=N 営業日前の履歴データ（ネット出来高とブローカー名のみ）) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、ブローカーデータの DataFrame を返す
str ret != RET_OK の場合、エラー説明を返す
* DataFrame フィールド： フィールド|型|説明 :-|:-|:- is_real_time|bool|リアルタイムデータかどうか (true=リアルタイム、false=履歴) data_time|int|データ更新タイムスタンプ（秒単位 Unix タイムスタンプ） data_time_str|str|データ更新時刻文字列 (形式 YYYY-MM-DD HH:MM:SS、市場のタイムゾーン) net_vol|int|ネット売買出来高 (ネット買いは正値、ネット売りは負値) broker_name|str|ブローカー表示名 (リアルタイムは証券会社プロファイルから取得、履歴はレスポンス名を使用) buy_sell_type|[BuySellType](./quote.md#4023)|売買種別 avg_price|float|平均取引価格 (リアルタイムデータのみ有効) total_vol|float|総取引出来高 (リアルタイムデータのみ有効) total_turnover|float|総売買代金 (リアルタイムデータのみ有効) * **BuySellType 列挙** 列挙名|値|説明 :-|:-|:- Unknown|0|不明 NetBuy|1|ネット買い NetSell|2|ネット売り * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_top_ten_buy_sell_brokers("HK.00700") if ret == RET_OK: print(data) else: print('error:', data) quote_ctx.close() ``` * **Output** ```python net_vol is_real_time buy_sell_type ... avg_price total_vol total_turnover 0 99200 True 1 ... 466.852156 398800.0 186180640.0 1 46500 True 1 ... 466.508972 61300.0 28597000.0 2 45400 True 1 ... 466.224332 67400.0 31423520.0 3 36000 True 1 ... 467.343428 240400.0 112349360.0 4 31300 True 1 ... 466.900580 155100.0 72416280.0 5 30000 True 1 ... 465.546667 30000.0 13966400.0 6 15000 True 1 ... 466.809333 15000.0 7002140.0 7 13700 True 1 ... 466.816577 55500.0 25908320.0 8 12300 True 1 ... 466.557724 12300.0 5738660.0 9 9200 True 1 ... 466.217391 9200.0 4289200.0 10 -373700 True 2 ... 467.064060 414300.0 193504640.0 11 -235100 True 2 ... 466.822072 502900.0 234764820.0 12 -168100 True 2 ... 466.281052 311900.0 145433060.0 13 -138300 True 2 ... 467.436639 547500.0 255921560.0 14 -89800 True 2 ... 466.722515 265600.0 123961500.0 15 -79400 True 2 ... 466.431910 79600.0 37127980.0 16 -69700 True 2 ... 466.950688 94500.0 44126840.0 17 -43600 True 2 ... 466.546230 61000.0 28459320.0 18 -25300 True 2 ... 466.652174 25300.0 11806300.0 19 -19500 True 2 ... 466.124484 33900.0 15801620.0 [20 rows x 9 columns] ``` :::tip 制限事項 * 30秒間に最大30回のリクエスト。 * 香港株（普通株およびファンド）のみ対応。 * `days_before=0` または未指定はリアルタイムデータ（平均価格/総出来高/総売買代金を含む）を返す、`days_before>0` はネット出来高とブローカー名のみ。 ::: --- # 日次空売り出来高の取得 `get_daily_short_volume(stock_code, next_key=None, num=None)` * **説明** 米国株または香港株の日次空売り出来高データを取得します。ページネーションをサポートしています。 * **パラメータ** パラメータ|型|説明 :-|:-|:- stock_code|str|銘柄コード (香港株・米国株の普通株およびファンドに対応。例：US.AAPL、HK.00700) next_key|str|ページネーションキー (初回は未指定、続きを取得する場合は前回返却の next_key を指定。"-1" はデータなしを意味します) num|int|1ページの件数 (デフォルト 10、範囲 1~50) * **戻り値**
パラメータ 型 説明
ret RET_CODE API 呼び出し結果
us_df pd.DataFrame 米国株の日次空売りデータ。ret != RET_OK の場合はエラー文字列
hk_df pd.DataFrame 香港株の日次空売りデータ。ret != RET_OK の場合は None
* 米国株 DataFrame（us_df）フィールド説明： フィールド|型|説明 :-|:-|:- timestamp|int|取引日タイムスタンプ（秒単位の Unix タイムスタンプ、当日 0 時） timestamp_str|str|取引日文字列 (YYYY-MM-DD 形式、市場タイムゾーン) total_shares_short|int|空売り総株数 nasdaq_shares_short|int|NASDAQ 空売り株数 nyse_shares_short|int|NYSE 空売り株数 short_percent|float|空売り比率 (パーセント記号前の値。例：12.34 は 12.34% を意味します) volume|int|出来高（株） close_price|float|終値 last_close_price|float|前回終値 daily_trade_avg_ratio|float|日次平均出来高比率 (パーセント記号前の値。例：12.34 は 12.34%；当該取引日から遡る 20 営業日平均) * 米国株 us_df.attrs 追加属性： 属性|型|説明 :-|:-|:- next_key|str|ページネーションキー ("-1" はデータなしを意味します) * 香港株 DataFrame（hk_df）フィールド説明： フィールド|型|説明 :-|:-|:- timestamp|int|取引日タイムスタンプ（秒単位の Unix タイムスタンプ、当日 0 時） timestamp_str|str|取引日文字列 (YYYY-MM-DD 形式、市場タイムゾーン) shares_traded|int|出来高（株） turnover|float|売買代金 short_sell_shares_traded|int|空売り出来高（株） short_sell_turnover|float|空売り売買代金 open_price|float|始値 close_price|float|終値 last_close_price|float|前回終値 daily_trade_avg_ratio|float|日次平均出来高比率 (パーセント記号前の値。例：12.34 は 12.34%；当該取引日から遡る 20 営業日平均) * 香港株 hk_df.attrs 追加属性： 属性|型|説明 :-|:-|:- next_key|str|ページネーションキー ("-1" はデータなしを意味します) aggregated_short|int|未決済空売り株数 (香港株のみ) aggregated_short_ratio|float|流通株比率 (パーセント記号前の値。例：12.34 は 12.34%；香港株のみ) new_time_str|str|最新データ時刻 (YYYY-MM-DD 形式、市場タイムゾーン；香港株のみ) * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, us_df, hk_df = quote_ctx.get_daily_short_volume("HK.00700") if ret == RET_OK: print(hk_df) else: print('error:', hk_df) quote_ctx.close() ``` * **Output** ```python timestamp timestamp_str ... last_close_price daily_trade_avg_ratio 0 1778169600 2026-05-08 ... 477.4 11.36 1 1778083200 2026-05-07 ... 463.0 11.80 2 1777996800 2026-05-06 ... 472.2 12.22 3 1777910400 2026-05-05 ... 473.0 12.76 4 1777824000 2026-05-04 ... 467.8 13.02 5 1777478400 2026-04-30 ... 479.2 13.09 6 1777392000 2026-04-29 ... 473.8 14.02 7 1777305600 2026-04-28 ... 478.6 14.13 8 1777219200 2026-04-27 ... 493.4 14.14 9 1776960000 2026-04-24 ... 495.2 14.18 [10 rows x 10 columns] ``` :::tip 制限事項 * 30 秒以内に最大 30 回のリクエストが可能です。 * 香港株・米国株の普通株およびファンドに対応しています。 ::: --- # 空売り残高の取得 `get_short_interest(stock_code, next_key=None, num=None)` * **説明** 指定した香港株または米国株の空売り残高の履歴を取得します（ページング対応） * **パラメータ** パラメータ|型|説明 :-|:-|:- stock_code|str|銘柄コード (香港株・米国株の個別株およびファンドに対応。例：US.AAPL、HK.00700) next_key|str|ページングキー (初回は空欄。次ページ取得時は前回返却の next_key を指定。"-1" はデータなし) num|int|1ページあたりの件数 (デフォルト 10、範囲 1~50) * **戻り値**
パラメータ 型 説明
ret RET_CODE API 呼び出し結果
us_df pd.DataFrame 米国株の空売り残高データ。ret != RET_OK の場合はエラー文字列
hk_df pd.DataFrame 香港株の空売り残高データ。ret != RET_OK の場合は None
* 米国株 DataFrame（us_df）フィールド： フィールド|型|説明 :-|:-|:- timestamp|int|取引日タイムスタンプ (Unix タイムスタンプ（秒）、当日の深夜0時) timestamp_str|str|取引日文字列 (形式 YYYY-MM-DD、市場タイムゾーン) shares_short|int|空売り株数 short_percent|float|空売り比率 (パーセント記号前の値。例：12.34 は 12.34% を意味する) avg_daily_share_volume|int|平均日次出来高 days_to_cover|float|買い戻し日数 close_price|float|終値 last_close_price|float|前回終値 * 米国株 us_df.attrs 追加属性： 属性|型|説明 :-|:-|:- next_key|str|ページングキー ("-1" はデータなし) * 香港株 DataFrame（hk_df）フィールド： フィールド|型|説明 :-|:-|:- timestamp|int|取引日タイムスタンプ (Unix タイムスタンプ（秒）、当日の深夜0時) timestamp_str|str|取引日文字列 (形式 YYYY-MM-DD、市場タイムゾーン) close_price|float|終値 last_close_price|float|前回終値 aggregated_short|int|未決済空売り株数 aggregated_short_ratio|float|流通株に占める比率 (パーセント記号前の値。例：12.34 は 12.34% を意味する) * 香港株 hk_df.attrs 追加属性： 属性|型|説明 :-|:-|:- next_key|str|ページングキー ("-1" はデータなし) * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, us_df, hk_df = quote_ctx.get_short_interest("HK.00700") if ret == RET_OK: print(hk_df) else: print('error:', hk_df) quote_ctx.close() ``` * **Output** ```python timestamp timestamp_str aggregated_short aggregated_short_ratio close_price last_close_price 0 1777478400 2026-04-30 51480638 0.56 467.8 479.2 1 1776960000 2026-04-24 51888755 0.56 493.4 495.2 2 1776355200 2026-04-17 47974208 0.52 510.5 517.0 3 1775750400 2026-04-10 48424833 0.53 504.5 508.5 4 1775059200 2026-04-02 49982828 0.54 489.2 496.6 5 1774540800 2026-03-27 52744147 0.57 493.4 495.6 6 1773936000 2026-03-20 51710854 0.56 508.0 513.0 7 1773331200 2026-03-13 48105325 0.52 547.5 546.5 8 1772726400 2026-03-06 42404275 0.46 519.0 502.0 9 1772121600 2026-02-27 36037870 0.39 518.0 512.0 ``` :::tip 利用制限 * 30 秒以内に最大 30 回までリクエスト可能。 * 香港株・米国株の個別株およびファンドに対応。 ::: --- # 取得オプション链満期日 `get_option_expiration_date(code, index_option_type=IndexOptionType.NORMAL)` * **概要** 原資産株からオプションチェーンのすべての満期日を照会します。完全なオプションチェーンを取得するには、[オプションチェーン取得](../quote/get-option-chain.md) APIと併用してください。 * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|原資産銘柄コード index_option_type|[IndexOptionType](../quote/quote.md#1635)|指数オプションタイプ (香港株指数オプションのフィルタにのみ有効。正株、ETF、米国株指数オプションではこのパラメータは無視可能) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、オプションチェーン満期日関連データ
str ret != RET_OK の場合、エラーの説明を返す
* オプションチェーン満期日データフォーマットは以下の通りです： フィールド|タイプ|説明 :-|:-|:- strike_time|str|オプション链行使日 (フォーマット：yyyy-MM-dd 香港株と A 株市場のデフォルトは北京時間、米国株市場のデフォルトは米国東部時間) option_expiry_date_distance|int|距离満期日天数 (負の数は満期済みを示します) expiration_cycle|[ExpirationCycle](./quote.md#1857)|受渡周期 (香港指数オプション、米国株指数オプションをサポート) * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_option_expiration_date(code='HK.00700') if ret == RET_OK: print(data) print(data['strike_time'].values.tolist()) # list に変換 else: print('error:', data) quote_ctx.close() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。 ``` * **Output** ```python strike_time option_expiry_date_distance expiration_cycle 0 2021-04-29 4 N/A 1 2021-05-28 33 N/A 2 2021-06-29 65 N/A 3 2021-07-29 95 N/A 4 2021-09-29 157 N/A 5 2021-12-30 249 N/A 6 2022-03-30 339 N/A ['2021-04-29', '2021-05-28', '2021-06-29', '2021-07-29', '2021-09-29', '2021-12-30', '2022-03-30'] ``` :::tip APIレート制限 * 30 秒以内に最大 60 回オプション链満期日API ::: --- # 取得オプション链 `get_option_chain(code, index_option_type=IndexOptionType.NORMAL, start=None, end=None, option_type=OptionType.ALL, option_cond_type=OptionCondType.ALL, data_filter=None)` * **概要** 原資産株からオプションチェーンを照会します。このAPIはオプションチェーンの静的情報のみを返します。気配値や板情報などの動的情報を取得するには、このAPIが返す銘柄コードを使用して、必要なタイプを自身で [登録](../quote/sub.md) してください。 * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|原資産銘柄コード index_option_type|[IndexOptionType](./quote.md#1635)|指数オプションタイプ (香港株指数オプションのフィルタにのみ有効。正株、ETF、米国株指数オプションではこのパラメータは無視可能) start|str|開始日期，この日期指満期日 (例如：“2017-08-01”) end|str|終了日付（その日を含む）。この日付は満期日を指します (例："2017-08-30") option_type|[OptionType](./quote.md#4830)|オプションコール/プットタイプ (未指定の場合、デフォルトはすべて) option_cond_type|[OptionCondType](./quote.md#4830)|オプションイン/アウトオブザマネータイプ (未指定の場合、デフォルトはすべて) data_filter|OptionDataFilter|データフィルタ条件 (未指定の場合、フィルタなし) * start と end の組み合わせは以下の通りです： Start タイプ|End タイプ|説明 :-|:-|:- str|str|start と end がそれぞれ指定された日付 None|str|start 為 end 往前 30 天 str|None|end 為 start 往后30天 None|None|start は当日、end は30日後 * OptionDataFilter フィールドは以下の通りです フィールド|タイプ|説明 :-|:-|:- implied_volatility_min|float|IV（インプライドボラティリティ）フィルタ下限 (小数点以下 0 桁まで、超過分は切り捨てられますこのフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) implied_volatility_max|float|IV（インプライドボラティリティ）フィルタ上限 (小数点以下 0 桁まで、超過分は切り捨てられますこのフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) delta_min|float|グリークス Delta フィルタ下限 (小数点以下 3 桁まで、超過分は切り捨てられます) delta_max|float|グリークス Delta フィルタ上限 (小数点以下 3 桁まで、超過分は切り捨てられます) gamma_min|float|グリークス Gamma フィルタ下限 (小数点以下 3 桁まで、超過分は切り捨てられます) gamma_max|float|グリークス Gamma フィルタ上限 (小数点以下 3 桁まで、超過分は切り捨てられます) vega_min|float|グリークス Vega フィルタ下限 (小数点以下 3 桁まで、超過分は切り捨てられます) vega_max|float|グリークス Vega フィルタ上限 (小数点以下 3 桁まで、超過分は切り捨てられます) theta_min|float|グリークス Theta フィルタ下限 (小数点以下 3 桁まで、超過分は切り捨てられます) theta_max|float|グリークス Theta フィルタ上限 (小数点以下 3 桁まで、超過分は切り捨てられます) rho_min|float|グリークス Rho フィルタ下限 (小数点以下 3 桁まで、超過分は切り捨てられます) rho_max|float|グリークス Rho フィルタ上限 (小数点以下 3 桁まで、超過分は切り捨てられます) net_open_interest_min|float|ネット未決済建玉数フィルタ下限 (小数点以下 0 桁まで、超過分は切り捨てられます) net_open_interest_max|float|ネット未決済建玉数フィルタ上限 (小数点以下 0 桁まで、超過分は切り捨てられます) open_interest_min|float|未決済建玉数フィルタ下限 (小数点以下 0 桁まで、超過分は切り捨てられます) open_interest_max|float|未決済建玉数フィルタ上限 (小数点以下 0 桁まで、超過分は切り捨てられます) vol_min|float|出来高フィルタ下限 (小数点以下 0 桁まで、超過分は切り捨てられます) vol_max|float|出来高フィルタ上限 (小数点以下 0 桁まで、超過分は切り捨てられます) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、オプション链データ
str ret != RET_OK の場合、エラーの説明を返す
* オプションチェーンデータフォーマットは以下の通りです： フィールド|タイプ|説明 :-|:-|:- code|str|銘柄コード name|str|名字 lot_size|int|1手あたりの株数。オプションの場合は1枚あたりの株数 (指数オプションにはこのフィールドはありません) stock_type|[SecurityType](./quote.md#1635)|株式タイプ option_type|[OptionType](./quote.md#4830)|オプションタイプ stock_owner|str|原資産株 strike_time|str|行使日 (フォーマット：yyyy-MM-dd 香港株と A 株市場のデフォルトは北京時間、米国株市場のデフォルトは米国東部時間) strike_price|float|行使価格 suspension|bool|かどうか売買停止 (True：売買停止中False：未売買停止) stock_id|int|株式 ID index_option_type|[IndexOptionType](./quote.md#1635)|指数オプションタイプ expiration_cycle|[ExpirationCycle](./quote.md#1725)|受渡周期 option_standard_type|[OptionStandardType](./quote.md#4830)|オプション標準タイプ option_settlement_mode|[OptionSettlementMode](./quote.md#4830)|オプション結算方式 * **Example** ```python from moomoo import * import time quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret1, data1 = quote_ctx.get_option_expiration_date(code='HK.00700') filter1 = OptionDataFilter() filter1.delta_min = 0 filter1.delta_max = 0.1 if ret1 == RET_OK: expiration_date_list = data1['strike_time'].values.tolist() for date in expiration_date_list: ret2, data2 = quote_ctx.get_option_chain(code='HK.00700', start=date, end=date, data_filter=filter1) if ret2 == RET_OK: print(data2) print(data2['code'][0]) # 最初のレコードの銘柄コードを取得 print(data2['code'].values.tolist()) # list に変換 else: print('error:', data2) time.sleep(3) else: print('error:', data1) quote_ctx.close() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。 ``` * **Output** ```python code name lot_size stock_type option_type stock_owner strike_time strike_price suspension stock_id index_option_type expiration_cycle option_standard_type option_settlement_mode 0 HK.TCH210429C350000 腾讯 210429 350.00 购 100 DRVT CALL HK.00700 2021-04-29 350.0 False 80235167 N/A WEEK STANDARD N/A 1 HK.TCH210429P350000 腾讯 210429 350.00 沽 100 DRVT PUT HK.00700 2021-04-29 350.0 False 80235247 N/A WEEK STANDARD N/A 2 HK.TCH210429C360000 腾讯 210429 360.00 购 100 DRVT CALL HK.00700 2021-04-29 360.0 False 80235163 N/A WEEK STANDARD N/A 3 HK.TCH210429P360000 腾讯 210429 360.00 沽 100 DRVT PUT HK.00700 2021-04-29 360.0 False 80235246 N/A WEEK STANDARD N/A 4 HK.TCH210429C370000 腾讯 210429 370.00 购 100 DRVT CALL HK.00700 2021-04-29 370.0 False 80235165 N/A WEEK STANDARD N/A 5 HK.TCH210429P370000 腾讯 210429 370.00 沽 100 DRVT PUT HK.00700 2021-04-29 370.0 False 80235248 N/A WEEK STANDARD N/A HK.TCH210429C350000 ['HK.TCH210429C350000', 'HK.TCH210429P350000', 'HK.TCH210429C360000', 'HK.TCH210429P360000', 'HK.TCH210429C370000', 'HK.TCH210429P370000'] ... code name lot_size stock_type option_type stock_owner strike_time strike_price suspension stock_id index_option_type expiration_cycle option_standard_type option_settlement_mode 0 HK.TCH220330C490000 腾讯 220330 490.00 购 100 DRVT CALL HK.00700 2022-03-30 490.0 False 80235143 N/A WEEK STANDARD N/A 1 HK.TCH220330P490000 腾讯 220330 490.00 沽 100 DRVT PUT HK.00700 2022-03-30 490.0 False 80235193 N/A WEEK STANDARD N/A 2 HK.TCH220330C500000 腾讯 220330 500.00 购 100 DRVT CALL HK.00700 2022-03-30 500.0 False 80233887 N/A WEEK STANDARD N/A 3 HK.TCH220330P500000 腾讯 220330 500.00 沽 100 DRVT PUT HK.00700 2022-03-30 500.0 False 80233912 N/A WEEK STANDARD N/A 4 HK.TCH220330C510000 腾讯 220330 510.00 购 100 DRVT CALL HK.00700 2022-03-30 510.0 False 80233747 N/A WEEK STANDARD N/A 5 HK.TCH220330P510000 腾讯 220330 510.00 沽 100 DRVT PUT HK.00700 2022-03-30 510.0 False 80233766 N/A WEEK STANDARD N/A HK.TCH220330C490000 ['HK.TCH220330C490000', 'HK.TCH220330P490000', 'HK.TCH220330C500000', 'HK.TCH220330P500000', 'HK.TCH220330C510000', 'HK.TCH220330P510000'] ``` :::tip APIレート制限 * 30 秒以内に最大 10 回オプション链API * 指定可能な時間範囲の上限は 30 日です ::: :::tip ご注意 * このAPIは期限切れのオプションチェーンの照会に対応していません。**終了日付** パラメータには本日または将来の日付を入力してください * Open interest (OI) データは毎日更新されます。更新タイミングは取引所により異なります。米国株オプションはプレマーケット時間帯に更新され、香港株オプションはアフターマーケットに更新されます。 ::: --- # オプション・ボラティリティ分析の取得 `get_option_volatility(code, query_time_period=None, hv_time_period=None)` * **説明** 指定したオプション・コントラクトのインプライド・ボラティリティ、ヒストリカル・ボラティリティ、ボラティリティ・プレミアムの分析データを取得する * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|オプション・コード (オプション・コントラクト・コードのみ対応、例：US.AAPL260427C270000) query_time_period|[OptionVolatilityTimePeriodType](./quote.md#5343)|クエリ時間周期 (未指定の場合は Month（月）がデフォルト) hv_time_period|int|ヒストリカル・ボラティリティ計算期間（日） (範囲 5~250、デフォルト 30) * **返り値**
パラメータ 型 説明
ret RET_CODE API 呼び出し結果
data pd.DataFrame ret == RET_OK の場合はオプション・ボラティリティ・データ
str ret != RET_OK の場合はエラー説明文字列
* DataFrame フィールド説明： フィールド|型|説明 :-|:-|:- timestamp|int|取引日タイムスタンプ（秒単位の Unix タイムスタンプ、当日の深夜0時） timestamp_str|str|取引日文字列 (形式 YYYY-MM-DD、市場タイムゾーン) implied_volatility|float|インプライド・ボラティリティ (%記号の前の値、例：25.0 は 25% を意味する) history_volatility|float|ヒストリカル・ボラティリティ (原資産のヒストリカル・ボラティリティ、%記号の前の値) volatility_premium|float|ボラティリティ・プレミアム (インプライドとヒストリカルの差；正の値はインプライドがヒストリカルより高いことを示す) average_impvol|float|インプライド・ボラティリティ平均値 (クエリ期間内のインプライド・ボラティリティの平均値、%記号の前の値) impvol_status|[OptionImpvolStatusType](./quote.md#4075)|ボラティリティ・ステータス analysis|str|分析テキスト * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, df = quote_ctx.get_option_volatility("US.AAPL281215C320000", query_time_period=2, hv_time_period=30) if ret == RET_OK: cols = ['timestamp_str', 'implied_volatility', 'history_volatility', 'volatility_premium'] print(df[cols].to_string(index=False)) else: print('error:', df) quote_ctx.close() ``` * **Output** ``` timestamp_str implied_volatility history_volatility volatility_premium 2026-04-13 27.813 18.977 8.836 2026-04-14 27.656 18.962 8.694 2026-04-15 27.726 20.782 6.944 2026-04-16 28.069 21.013 7.056 2026-04-17 27.796 22.088 5.708 2026-04-20 28.054 21.931 6.123 2026-04-21 27.897 23.194 4.703 2026-04-22 28.276 24.300 3.976 2026-04-23 27.951 24.296 3.655 2026-04-24 28.056 23.676 4.380 2026-04-27 27.917 22.985 4.932 2026-04-28 27.942 23.011 4.931 2026-04-29 28.269 23.022 5.247 2026-04-30 27.630 22.312 5.318 2026-05-01 27.576 23.741 3.835 2026-05-04 27.919 24.078 3.841 2026-05-05 27.308 24.778 2.530 2026-05-06 27.746 24.850 2.896 2026-05-07 28.198 24.886 3.312 2026-05-08 27.719 25.285 2.434 ``` :::tip API 制限 * 30 秒以内に最大 30 回のリクエスト。 * オプション・コントラクト・コードのみ対応。原株コードは不可。 ::: --- # オプション行使確率の取得 `get_option_exercise_probability(code)` * **説明** 指定したオプション契約の過去の行使確率データを取得します。日付の新しい順に並べられます。 * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|オプションコード (オプション契約コードのみ対応、例：US.AAPL260427C270000) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、行使確率データを返します
str ret != RET_OK の場合、エラー説明を返します
* DataFrameフィールド： フィールド|型|説明 :-|:-|:- timestamp|int|タイムスタンプ（秒単位のUnixタイムスタンプ） timestamp_str|str|日付文字列 (形式 YYYY-MM-DD、市場タイムゾーン) security_price|float|原資産価格 strike_probability|float|行使確率 (パーセント記号前の値、例：12.34 は 12.34% を意味する) * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, df = quote_ctx.get_option_exercise_probability("US.AAPL281215C320000") if ret == RET_OK: print(df) else: print('error:', df) quote_ctx.close() ``` * **Output** ```python timestamp timestamp_str security_price strike_probability 0 1778469319 2026-05-10 293.32 41.869 1 1778212800 2026-05-08 293.05 41.887 2 1778126400 2026-05-07 287.17 40.011 3 1778040000 2026-05-06 287.24 40.122 4 1777953600 2026-05-05 283.91 38.956 5 1777867200 2026-05-04 276.56 36.861 6 1777608000 2026-05-01 279.87 37.939 7 1777521600 2026-04-30 271.08 35.189 8 1777435200 2026-04-29 269.90 34.851 9 1777348800 2026-04-28 270.44 35.040 10 1777262400 2026-04-27 267.34 34.094 11 1777003200 2026-04-24 270.79 35.170 12 1776916800 2026-04-23 273.16 35.885 13 1776830400 2026-04-22 272.90 35.805 14 1776744000 2026-04-21 265.90 33.691 15 1776657600 2026-04-20 272.78 35.799 16 1776398400 2026-04-17 269.96 34.964 17 1776312000 2026-04-16 263.13 32.901 18 1776225600 2026-04-15 266.16 33.834 19 1776139200 2026-04-14 258.56 31.536 20 1776052800 2026-04-13 258.93 31.663 21 1775793600 2026-04-10 260.21 32.069 22 1775707200 2026-04-09 260.22 32.086 ``` :::tip API制限 * 30秒以内に最大30リクエスト。 * オプション契約コードのみ対応。原資産コードは非対応。 ::: --- # オプション戦略の取得 `get_option_strategy(code, option_strategy, expire_time, spread=None, far_expire_time=None, index_option_type=IndexOptionType.NORMAL, option_type=OptionType.ALL, strike_price=None)` * **説明** オプション戦略タイプ別にコンボレッグに対応するオプションチェーンデータを取得します。バーティカルスプレッド、ストラドル、カラー、バタフライなどの標準戦略に対応します。 * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|原資産銘柄コード (如 US.AAPL、HK.00700) option_strategy|[OptionStrategyType](./quote.md#5047)|オプション戦略タイプ expire_time|str|満期日 (形式：yyyy-MM-dd、市場タイムゾーン；カレンダースプレッド・ダイアゴナルスプレッドで必須) spread|float|スプレッド (バーティカルスプレッド、ストラングル、カラー、バタフライ、コンドル、アイアンバタフライ、アイアンコンドル、ダイアゴナルスプレッドで必須) far_expire_time|str|遠端満期日 (形式：yyyy-MM-dd；カレンダースプレッド・ダイアゴナルスプレッドで必須) index_option_type|[IndexOptionType](./quote.md#1857)|指数オプションタイプ (香港指数オプションのフィルタのみ有効) option_type|[OptionType](./quote.md#1635)|コール/プットタイプ (デフォルト：すべて) strike_price|float|行使価格 * 戦略タイプ別の必須パラメータ： * **expire_time** 必須の戦略：`CALENDAR_SPREAD`（カレンダースプレッド）、`DIAGONAL_SPREAD`（ダイアゴナルスプレッド） * **spread** 必須の戦略：`SPREAD`（バーティカルスプレッド）、`STRANGLE`（ストラングル）、`COLLAR`（カラー）、`BUTTERFLY`（バタフライ）、`CONDOR`（コンドル）、`IRON_BUTTERFLY`（アイアンバタフライ）、`IRON_CONDOR`（アイアンコンドル）、`DIAGONAL_SPREAD`（ダイアゴナルスプレッド） * **far_expire_time** 必須の戦略：`CALENDAR_SPREAD`（カレンダースプレッド）、`DIAGONAL_SPREAD`（ダイアゴナルスプレッド） * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、戦略リストデータを返します
str ret != RET_OK の場合、エラー説明を返します
* DataFrameフィールド： フィールド|型|説明 :-|:-|:- code|str|戦略識別コード name|str|戦略名 option_strategy|str|オプション戦略タイプ (如 STRADDLE) stock_owner|str|原資産銘柄 legs|list|コンボレッグリスト (要素は OptionStrategyLeg) * OptionStrategyLegフィールド： フィールド|型|説明 :-|:-|:- code|str|オプション契約コード action|str|売買方向 (BUY / SELL) quantity|float|数量 * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret,data = quote_ctx.get_option_strategy(code='HK.00700', option_strategy=OptionStrategyType.STRADDLE) if ret == RET_OK: print(data) print(data['legs'][0]) else: print('error:', data) quote_ctx.close() # 接続上限を避けるため、終了後は接続を閉じてください ``` * **Output** ```python code name option_strategy stock_owner legs 0 TCH260522C/P330 テンセント ストラドル STRADDLE HK.00700 [OptionStrategyLeg(code=HK.TCH260522P330000, action=BUY, quantity=1.0), OptionStrategyLeg(code=HK.TCH260522C330000, action=BUY, quantity=1.0)] 1 TCH260522C/P340 テンセント ストラドル STRADDLE HK.00700 [OptionStrategyLeg(code=HK.TCH260522P340000, a... 2 TCH260522C/P350 テンセント ストラドル STRADDLE HK.00700 [OptionStrategyLeg(code=HK.TCH260522P350000, a... ... 26 TCH260522C/P590 テンセント ストラドル STRADDLE HK.00700 [OptionStrategyLeg(code=HK.TCH260522P590000, a... [OptionStrategyLeg(code=HK.TCH260522P330000, action=BUY, quantity=1.0), OptionStrategyLeg(code=HK.TCH260522C330000, action=BUY, quantity=1.0)] ``` :::tip API制限 * 30秒あたり最大30回までリクエスト可能。 ::: --- # 有効スプレッドの取得 `get_option_strategy_spread(code, option_strategy, expire_time, far_expire_time=None, index_option_type=IndexOptionType.NORMAL)` * **説明** 指定したオプション戦略について、現在の原資産・満期日条件下で利用可能な有効スプレッド一覧を取得します。 * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|原資産銘柄コード (如 US.AAPL、HK.00700) option_strategy|[OptionStrategyType](./quote.md#5047)|オプション戦略タイプ expire_time|str|満期日 (形式：yyyy-MM-dd、市場タイムゾーン) far_expire_time|str|遠端満期日 (DiagonalSpread 等で必須；形式：yyyy-MM-dd) index_option_type|[IndexOptionType](./quote.md#1857)|指数オプションタイプ (香港指数オプションのフィルタのみ有効) * option_strategy は Spread、Strangle、Collar、Butterfly、Condor、IronButterfly、IronCondor、DiagonalSpread のみ対応。 * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、有効スプレッド一覧を返します
str ret != RET_OK の場合、エラー説明を返します
* DataFrameフィールド： フィールド|型|説明 :-|:-|:- spread|float|有効スプレッド * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret,data = quote_ctx.get_option_strategy_spread(code='HK.00700', option_strategy=OptionStrategyType.STRANGLE) if ret == RET_OK: print(data) else: print('error:', data) quote_ctx.close() # 接続上限を避けるため、終了後は接続を閉じてください ``` * **Output** ```python spread 0 10.0 1 20.0 2 30.0 3 40.0 4 50.0 5 60.0 6 70.0 7 80.0 8 90.0 9 100.0 10 110.0 11 120.0 12 130.0 13 140.0 14 150.0 15 160.0 16 170.0 17 180.0 18 190.0 19 200.0 20 210.0 21 220.0 22 230.0 23 240.0 24 250.0 25 260.0 ``` :::tip API制限 * 30秒あたり最大30回までリクエスト可能。 ::: --- # オプション損益分析 `get_option_strategy_analysis(combo_leg_list)` * **説明** カスタムまたはマルチレッグのオプションコンボの損益分析を行い、損益曲線および関連分析データを返します。 * **パラメータ** パラメータ|型|説明 :-|:-|:- combo_leg_list|list|コンボレッグリスト (要素は OptionStrategyLeg；構造は [get_option_strategy](./get-option-strategy.md) を参照) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、オプション損益分析結果を返します
str ret != RET_OK の場合、エラー説明を返します
* DataFrameフィールド： フィールド|型|説明 :-|:-|:- code|str|戦略識別コード name|str|戦略名 option_strategy|str|オプション戦略タイプ bid1|float|コンボ買気配 ask1|float|コンボ売気配 max_profit|float|最大利益 max_loss|float|最大損失 breakeven_points|list|損益分岐点 prob_of_profit|float|利益確率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) delta|float|Delta theta|float|Theta * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_option_strategy(code='HK.00700', option_strategy=OptionStrategyType.STRADDLE) if ret == RET_OK: index=0 print(data['legs'][index]) ret2,data2 = quote_ctx.get_option_strategy_analysis(data['legs'][index]) if ret2 == RET_OK: print(data2) else: print("get_analysis,error:",data2) else: print('error:', data) quote_ctx.close() # 接続上限を避けるため、終了後は接続を閉じてください ``` * **Output** ```python [OptionStrategyLeg(code=HK.TCH260522P330000, action=BUY, quantity=1.0), OptionStrategyLeg(code=HK.TCH260522C330000, action=BUY, quantity=1.0)] code name option_strategy bid1 ask1 max_profit max_loss breakeven_points prob_of_profit delta theta 0 TCH260522C/P330 テンセント ストラドル STRADDLE 0.0 130.44 1.000000e+15 -13044.0 [199.56, 460.44] 0.315492 0.974369 -0.785757 ``` :::tip API制限 * オプション購読枠を消費しません。 * 30秒あたり最大30回までリクエスト可能。 ::: --- # オプションスナップショットの取得 `get_option_quote(combo_leg_list)` * **説明** コンボレッグリストからオプションスナップショットを取得します。マルチレッグ戦略の一括見積もりに適しています。 * **パラメータ** パラメータ|型|説明 :-|:-|:- combo_leg_list|list|コンボレッグリスト (要素は OptionStrategyLeg；構造は [get_option_strategy](./get-option-strategy.md) を参照) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、オプションスナップショットデータを返します
str ret != RET_OK の場合、エラー説明を返します
* DataFrameフィールド： フィールド|型|説明 :-|:-|:- price|float|コンボ価格 change_val|float|値幅 change_rate|float|騰落率 volume|str|出来高 turnover|str|売買代金 high_price|str|高値 low_price|str|安値 mid_price|str|仲値 open_price|str|始値 last_close_price|float|前日終値 open_interest|str|建玉 premium|str|プレミアム implied_volatility|str|インプライド・ボラティリティ delta|float|Delta gamma|float|Gamma vega|float|Vega theta|float|Theta rho|float|Rho option_type|str|オプションタイプ expire_time|str|満期日 strike_price|str|行使価格 contract_size|float|契約規模 contract_multiplier|float|契約乗数 exercise_type|str|行使方式 days_to_expiry|int|満期までの日数 net_open_interest|str|ネット建玉 contract_value|str|契約価値 equal_underlying|str|同等原資産 index_option_type|str|指数オプションタイプ intrinsic_value|float|内在価値 time_value|float|時間価値 breakeven_point|list|損益分岐点 dist_to_breakeven|list|損益分岐点までの距離 prob_of_profit|float|利益確率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) seller_roi|str|売り手ROI (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) mark_price|float|マーク価格 leverage_ratio|str|レバレッジ比率 effective_gearing|str|実効ギアリング * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_option_strategy(code='HK.00700', option_strategy=OptionStrategyType.STRADDLE) if ret == RET_OK: index=0 print(data['legs'][index]) ret2,data2 = quote_ctx.get_option_quote(data['legs'][index]) if ret2 == RET_OK: print(data2) else: print("get_analysis,error:",data2) else: print('error:', data) quote_ctx.close() # 接続上限を避けるため、終了後は接続を閉じてください ``` * **Output** ```python [OptionStrategyLeg(code=HK.TCH260522P330000, action=BUY, quantity=1.0), OptionStrategyLeg(code=HK.TCH260522C330000, action=BUY, quantity=1.0)] price change_val change_rate volume turnover high_price low_price mid_price open_price last_close_price open_interest premium implied_volatility delta gamma vega theta rho option_type expire_time strike_price contract_size contract_multiplier exercise_type days_to_expiry net_open_interest contract_value equal_underlying index_option_type intrinsic_value time_value breakeven_point dist_to_breakeven prob_of_profit seller_roi mark_price leverage_ratio effective_gearing 0 131.65 0.0 0.0 N/A N/A N/A N/A N/A N/A 131.65 N/A N/A N/A 0.974369 0.000797 0.019825 -0.785757 0.016246 N/A 2026-05-22 N/A 100.0 100.0 N/A 2 N/A N/A N/A N/A 125.2 6.45 [199.56, 460.44] [255.64, -5.240000000000009] 0.315418 N/A 130.4 N/A N/A ``` :::tip API制限 * 30秒あたり最大120回までリクエスト可能。 ::: --- # オプションスクリーニング `get_option_screen(request)` * **説明** オプションスクリーニング。原資産属性（underlying）とオプション属性（option）を組み合わせてフィルタリングします。同一グループ内で原資産属性（underlying）とオプション属性（option）を同時にフィルタリングすることはできないため、SDK は必要に応じて自動的に新しいフィルタグループを開きます。デフォルトでは各フィルタ条件が AND で連結（新グループを開く）され、同じ indicator_type で `or_with_previous=True` を明示的に指定した場合のみ前条件と OR（同一グループ）になります。 * **パラメータ** パラメータ|タイプ|説明 :-|:-|:- request|OptionScreenRequest|オプションスクリーニングリクエストオブジェクト、構築時に market_categories 必須 * OptionScreenRequest フィールド： フィールド|タイプ|説明 :-|:-|:- market_categories|list[int]|オプション市場カテゴリリスト (要素は OptMarketCategory から取得：US_STOCK=0、US_INDEX=1、US_FUTURE=2、HK_STOCK=3、HK_INDEX=4、JP_STOCK=5、JP_INDEX=6。US_FUTURE / JP_STOCK / JP_INDEX は今後サポート予定、現在は結果が空となる) page_from|int|ページング開始位置 (デフォルトは 0) page_count|int|1 ページあたりの最大返却件数 (デフォルトは 200) * フィルタ条件 builder メソッド（デフォルトで呼び出すごとに新しいフィルタグループが自動的に開かれ、前条件と AND；同じ indicator_type かつ `or_with_previous=True` の場合のみ前条件と OR で同一グループに追加。同一グループ内で原資産属性（underlying）とオプション属性（option）を同時にフィルタリングすることはできません）： メソッド|説明 :-|:- add_underlying_filter(indicator_type, values=None, lower=None, upper=None, plate_list=None, parent_plate_id=None, or_with_previous=False)|原資産属性フィルタ (indicator_type は [OptUnderlyingIndicator](./quote.md#6584) から取得。STOCK_LIST には証券コード文字列をそのまま渡す（例："US.AAPL"、"HK.00700"）。IV / HV / IV_RANK / IV_PERCENTILE 等のパーセンテージ系指標は**小数**で渡す（30% は 0.3）。PLATE(103) を渡すとエラーが発生する、当面使用しないこと) add_option_filter(indicator_type, values=None, lower=None, upper=None, or_with_previous=False)|オプション属性フィルタ (indicator_type は [OptIndicator](./quote.md#6840) から取得。DELTA / GAMMA / VEGA / THETA / RHO や確率系指標（ITM_PROBABILITY 等）は 0~1 の小数で渡す。PREMIUM(2021) は sort / retrieve のみサポート、filter として使用するとエラーが発生する；BUY_BREAK_EVEN_POINT(3023) は廃止済み、新しいコードでは BUY_TO_BEP(3011) を使用) new_filter_group()|手動で新しいフィルタグループを開始 (グループ間 AND、グループ内 OR) add_sort(indicator_type, desc=False)|ソート (desc=True で降順、デフォルト昇順) add_option_retrieve(indicator_type)|追加で返すオプションフィールドを宣言 (呼び出さない場合はデフォルトの基本フィールドを返す) add_underlying_retrieve(indicator_type)|返す原資産フィールドを宣言 (呼び出した場合のみ結果中の underlying dict が埋まる) * **戻り値**
パラメータ タイプ 説明
ret RET_CODE API 呼び出し結果
data tuple ret == RET_OK のとき、(last_page, all_count, DataFrame) を返す
str ret != RET_OK のとき、エラー記述を返す
* 戻り値 DataFrame フィールド： フィールド|タイプ|説明 :-|:-|:- code|str|オプションコード option_name|str|オプション名称 strike_price|float|権利行使価格 strike_date|str|権利行使日 option_type|int|コール/プット (1=CALL、2=PUT) exercise_type|int|権利行使方式 (1=アメリカン、2=ヨーロピアン) expiration_type|int|満期タイプ (1=週、2=月、3=四半期) in_the_money|bool|イン・ザ・マネーか否か left_day|int|残日数 price|float|オプション価格 mid_price|float|仲値 bid_price|float|買い気配値 ask_price|float|売り気配値 bid_ask_spread|float|ビッド・アスクスプレッド bid_volume|int|買い気配数量 ask_volume|int|売り気配数量 bid_ask_volume_ratio|float|買い/売り数量比 change_ratio|float|変化率 volume|int|出来高 turnover|float|売買代金 open_interest|int|未決済建玉数（建玉） open_interest_market_cap|float|建玉時価総額 vol_oi_ratio|float|出来高/建玉 premium|float|プレミアム implied_volatility|float|インプライド・ボラティリティ history_volatility|float|ヒストリカル・ボラティリティ iv_hv_ratio|float|IV/HV delta|float|ギリシャ文字 Delta gamma|float|ギリシャ文字 Gamma vega|float|ギリシャ文字 Vega theta|float|ギリシャ文字 Theta rho|float|ギリシャ文字 Rho leverage_ratio|float|レバレッジ比率 effective_gearing|float|実効レバレッジ itm_probability|float|イン・ザ・マネー確率 buy_to_bep|float|買いから損益分岐点までの比率 sell_to_bep|float|売りから損益分岐点までの比率 buy_profit_probability|float|買い利益確率 sell_profit_probability|float|売り利益確率 intrinsic_value_per|float|本質的価値割合 time_value_per|float|時間的価値割合 itm_degree|float|イン・ザ・マネー度合い otm_degree|float|アウト・オブ・ザ・マネー度合い otm_probability|float|アウト・オブ・ザ・マネー確率 sell_annualized_return|float|売り年率収益率 interval_return|float|売り区間収益率 underlying|dict|原資産情報（add_underlying_retrieve を呼び出した場合のみ返却） (dict には stock_id / iv / hv / iv_rank / iv_percentile / market_cap / price / change_ratio が含まれる) * **Example** ```python from moomoo import ( OpenQuoteContext, RET_OK, OptionScreenRequest, OptMarketCategory, OptIndicator, OptUnderlyingIndicator, ) quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) # 例 1：米国株原資産 IV>30% + アット・ザ・マネー付近の CALL req = OptionScreenRequest(market_categories=[OptMarketCategory.US_STOCK]) req.add_underlying_filter(OptUnderlyingIndicator.IV, lower=0.3) # 原資産 IV ≥ 30%（小数） req.add_option_filter(OptIndicator.OPTION_TYPE, values=[1]) # CALL req.add_option_filter(OptIndicator.DELTA, lower=0.3, upper=0.7) # Delta 0.3~0.7 req.add_option_filter(OptIndicator.LEFT_DAY, lower=7, upper=60) # 残り 7~60 日 req.add_sort(OptIndicator.VOLUME, desc=True) # 出来高降順 req.add_option_retrieve(OptIndicator.DELTA) req.add_option_retrieve(OptIndicator.VOLUME) req.page_count = 30 ret, data = quote_ctx.get_option_screen(req) if ret == RET_OK: last_page, all_count, df = data print(df[['code', 'option_name', 'delta', 'volume']].head(10)) else: print('error: ', data) # 例 2：香港株で指定原資産のオプションをフィルタ + 原資産情報も取得 # 注：STOCK_LIST には証券コード文字列をそのまま渡す（例："HK.00700"、"US.AAPL"） req = OptionScreenRequest(market_categories=[OptMarketCategory.HK_STOCK]) req.add_underlying_filter(OptUnderlyingIndicator.STOCK_LIST, values=["HK.00700"]) # 原資産=テンセント req.add_option_filter(OptIndicator.OPTION_TYPE, values=[1]) # CALL req.add_option_filter(OptIndicator.OPTION_TYPE, values=[2], or_with_previous=True) # 前条件と OR：CALL + PUT req.add_underlying_retrieve(OptUnderlyingIndicator.IV) req.add_underlying_retrieve(OptUnderlyingIndicator.MARKET_CAP) req.add_sort(OptIndicator.OPEN_INTEREST, desc=True) # 建玉降順 req.page_count = 50 ret, data = quote_ctx.get_option_screen(req) if ret == RET_OK: last_page, all_count, df = data print(df[['code', 'option_name', 'option_type', 'open_interest', 'underlying']].head(10)) else: print('error: ', data) quote_ctx.close() ``` * **Output** ```python # 例 1： code option_name delta volume 0 US.GT260717C7000 GT 260717 7.00C 0.33809 38831 1 US.INTC260717C150000 INTC 260717 150.00C 0.30582 19548 2 US.MU260626C1050000 MU 260626 1050.00C 0.43334 18949 3 US.TSLA260710C400000 TSLA 260710 400.00C 0.58114 16002 4 US.CRWV260717C120000 CRWV 260717 120.00C 0.30415 15932 5 US.COMP260717C9000 COMP 260717 9.00C 0.47409 15645 6 US.SLV260717C65500 SLV 260717 65.50C 0.35809 13291 7 US.TSLA260710C410000 TSLA 260710 410.00C 0.50861 13010 8 US.SPCE260717C5000 SPCE 260717 5.00C 0.41268 12701 9 US.HOOD260717C100000 HOOD 260717 100.00C 0.41248 12572 # 例 2： code option_name option_type open_interest underlying 0 HK.TCH260730C610000 腾讯 260730 610.00 购 1 70474 {'stock_id': 54047868453564, 'iv': 0.36337, 'h... 1 HK.TCH260629C500000 腾讯 260629 500.00 购 1 56334 {'stock_id': 54047868453564, 'iv': 0.36406, 'h... 2 HK.TCH260929C550000 腾讯 260929 550.00 购 1 46470 {'stock_id': 54047868453564, 'iv': 0.36406, 'h... 3 HK.TCH260730C520000 腾讯 260730 520.00 购 1 44071 {'stock_id': 54047868453564, 'iv': 0.36406, 'h... 4 HK.TCH260929C650000 腾讯 260929 650.00 购 1 38316 {'stock_id': 54047868453564, 'iv': 0.36406, 'h... 5 HK.TCH260629C530000 腾讯 260629 530.00 购 1 34532 {'stock_id': 54047868453564, 'iv': 0.36406, 'h... 6 HK.TCH260629C540000 腾讯 260629 540.00 购 1 34085 {'stock_id': 54047868453564, 'iv': 0.36406, 'h... 7 HK.TCH270330P230000 腾讯 270330 230.00 沽 2 30586 {'stock_id': 54047868453564, 'iv': 0.36337, 'h... 8 HK.TCH270330C230000 腾讯 270330 230.00 购 1 30000 {'stock_id': 54047868453564, 'iv': 0.36337, 'h... 9 HK.TCH260629C600000 腾讯 260629 600.00 购 1 27394 {'stock_id': 54047868453564, 'iv': 0.36406, 'h... ``` * **フィールド別例（カテゴリ別）** > 以下の例はすべて US_STOCK 市場を対象とします：まず `req = OptionScreenRequest(market_categories=[OptMarketCategory.US_STOCK])`、 > 続けて各セクションのフィルタ / 取得 / ソート条件を重ね、最後に `quote_ctx.get_option_screen(req)` で `(last_page, all_count, df)` を取得します。 > 実測の `head` は返却された DataFrame からそのまま取得し、原資産属性のサンプルにある `underlying.` 列は `add_underlying_retrieve(...)` で展開されたものです。 #### 原資産属性 OptUnderlyingIndicator `add_underlying_filter(indicator_type, lower, upper, values, ...)` で渡す。IV/HV/IV_RANK 等のパーセンテージ系指標は **小数で渡し**（30% は 0.3）、`underlying` dict に値を表示するには `add_underlying_retrieve(...)` が必要 ##### `IV`（id=203 · interval · OptUnderlyingIndicator） 原資産インプライドボラティリティ 単位：% ；SDK は小数で直接渡す（30% は 0.3）。underlying dict に値を表示するには add_underlying_retrieve が必要 ```python req.add_underlying_filter(OptUnderlyingIndicator.IV, lower=0.3) req.add_underlying_retrieve(OptUnderlyingIndicator.IV) req.add_sort(OptIndicator.VOLUME, desc=True) ``` 実測返却（US_STOCK · all_count=1456207、ヒット 10 行、head 先頭 5）： ``` code option_name volume underlying.iv US.NVDA260612C205000 NVDA 260612 205.00C 226041 0.45135 US.NVDA260612P200000 NVDA 260612 200.00P 184565 0.45135 US.NVDA260612C202500 NVDA 260612 202.50C 163991 0.45135 US.NVDA260612C210000 NVDA 260612 210.00C 147236 0.45135 US.NVDA260612C207500 NVDA 260612 207.50C 143944 0.45135 ``` ##### `HV`（id=204 · interval · OptUnderlyingIndicator） 原資産ヒストリカルボラティリティ 単位：% ；SDK は小数で直接渡す ```python req.add_underlying_filter(OptUnderlyingIndicator.HV, lower=0.3) req.add_underlying_retrieve(OptUnderlyingIndicator.HV) req.add_sort(OptIndicator.VOLUME, desc=True) ``` 実測返却（US_STOCK · all_count=1336194、ヒット 10 行、head 先頭 5）： ``` code option_name volume underlying.hv US.NVDA260612C205000 NVDA 260612 205.00C 226041 0.46845 US.NVDA260612P200000 NVDA 260612 200.00P 184565 0.46845 US.NVDA260612C202500 NVDA 260612 202.50C 163991 0.46845 US.NVDA260612C210000 NVDA 260612 210.00C 147236 0.46845 US.NVDA260612C207500 NVDA 260612 207.50C 143944 0.46845 ``` ##### `IV_RANK`（id=205 · interval · OptUnderlyingIndicator） 原資産 IV ランク 0~100；現在の IV が過去レンジ内に占める相対位置 ```python req.add_underlying_filter(OptUnderlyingIndicator.IV_RANK, lower=50.0) req.add_underlying_retrieve(OptUnderlyingIndicator.IV_RANK) req.add_sort(OptIndicator.VOLUME, desc=True) ``` 実測返却（US_STOCK · all_count=0、ヒット 0 行）：データなし。理由：OpenD サンプリングにデータなし。lower 閾値を下げて再試行可 ##### `MARKET_CAP`（id=401 · interval · OptUnderlyingIndicator） 原資産時価総額 単位：通貨建て；SDK は元の値を直接渡す（百億は 10_000_000_000 と書く） ```python req.add_underlying_filter(OptUnderlyingIndicator.MARKET_CAP, lower=100_000_000_000.0) req.add_underlying_retrieve(OptUnderlyingIndicator.MARKET_CAP) req.add_sort(OptIndicator.VOLUME, desc=True) ``` 実測返却（US_STOCK · all_count=357921、ヒット 10 行、head 先頭 5）： ``` code option_name volume underlying.market_cap US.NVDA260612C205000 NVDA 260612 205.00C 226041 4957854000000.0 US.NVDA260612P200000 NVDA 260612 200.00P 184565 4957854000000.0 US.NVDA260612C202500 NVDA 260612 202.50C 163991 4957854000000.0 US.NVDA260612C210000 NVDA 260612 210.00C 147236 4957854000000.0 US.NVDA260612C207500 NVDA 260612 207.50C 143944 4957854000000.0 ``` ##### `STOCK_PRICE`（id=402 · interval · OptUnderlyingIndicator） 原資産価格 単位：通貨建て；SDK は元の価格をそのまま渡す ```python req.add_underlying_filter(OptUnderlyingIndicator.STOCK_PRICE, lower=50.0, upper=500.0) req.add_underlying_retrieve(OptUnderlyingIndicator.STOCK_PRICE) req.add_sort(OptIndicator.VOLUME, desc=True) ``` 実測返却（US_STOCK · all_count=1055665、ヒット 10 行、head 先頭 5）： ``` code option_name volume underlying.price US.NVDA260612C205000 NVDA 260612 205.00C 226041 204.87 US.NVDA260612P200000 NVDA 260612 200.00P 184565 204.87 US.NVDA260612C202500 NVDA 260612 202.50C 163991 204.87 US.NVDA260612C210000 NVDA 260612 210.00C 147236 204.87 US.NVDA260612C207500 NVDA 260612 207.50C 143944 204.87 ``` #### オプション属性 OptIndicator `add_option_filter(indicator_type, lower, upper, values, ...)` で渡す。Greeks（DELTA/GAMMA/THETA/VEGA/RHO）および各種確率（ITM_PROBABILITY 等）は **0~1 の小数** で渡す ##### `STRIKE_PRICE`（id=1001 · interval · OptIndicator） 権利行使価格 単位：通貨建て；SDK は元の価格をそのまま渡す ```python req.add_option_filter(OptIndicator.STRIKE_PRICE, lower=50.0, upper=100.0) req.add_sort(OptIndicator.VOLUME, desc=True) ``` 実測返却（US_STOCK · all_count=400354、ヒット 10 行、head 先頭 5）： ``` code option_name strike_price volume US.HYG260717P75000 HYG 260717 75.00P 75.0 72679 US.BAC260618C55000 BAC 260618 55.00C 55.0 55636 US.TQQQ260612P72000 TQQQ 260612 72.00P 72.0 43326 US.IEF260618C95000 IEF 260618 95.00C 95.0 42077 US.HYG260918P75000 HYG 260918 75.00P 75.0 42012 ``` ##### `LEFT_DAY`（id=1002 · interval · OptIndicator） 残存日数 単位：日；整数。近月は通常 < 30 ```python req.add_option_filter(OptIndicator.LEFT_DAY, lower=7, upper=60) req.add_sort(OptIndicator.VOLUME, desc=True) ``` 実測返却（US_STOCK · all_count=553649、ヒット 10 行、head 先頭 5）： ``` code option_name left_day volume US.HYG260717P75000 HYG 260717 75.00P 35 72679 US.POET260717P17000 POET 260717 17.00P 35 60754 US.HYG260717P78000 HYG 260717 78.00P 35 40594 US.HYG260717P79000 HYG 260717 79.00P 35 34919 US.IEF260717P93000 IEF 260717 93.00P 35 34807 ``` ##### `OPTION_TYPE`（id=1003 · values · OptIndicator） コール/プット区分 列挙値：1=CALL、2=PUT；values に列挙値の配列を渡す ```python req.add_option_filter(OptIndicator.OPTION_TYPE, values=[1]) # CALL req.add_sort(OptIndicator.VOLUME, desc=True) ``` 実測返却（US_STOCK · all_count=972181、ヒット 10 行、head 先頭 5）： ``` code option_name option_type volume US.NVDA260612C205000 NVDA 260612 205.00C 1 226041 US.NVDA260612C202500 NVDA 260612 202.50C 1 163991 US.NVDA260612C210000 NVDA 260612 210.00C 1 147236 US.NVDA260612C207500 NVDA 260612 207.50C 1 143944 US.SPY260612C740000 SPY 260612 740.00C 1 114906 ``` ##### `IN_THE_MONEY`（id=2001 · values · OptIndicator） インザマネーかどうか 列挙値：1=ITM、0=OTM ```python req.add_option_filter(OptIndicator.IN_THE_MONEY, values=[1]) # 仅价内 req.add_sort(OptIndicator.VOLUME, desc=True) ``` 実測返却（US_STOCK · all_count=972389、ヒット 10 行、head 先頭 5）： ``` code option_name in_the_money volume US.NVDA260612C202500 NVDA 260612 202.50C 1 163991 US.AAPL260612C295000 AAPL 260612 295.00C 1 87879 US.SPY260612C735000 SPY 260612 735.00C 1 77126 US.TSLA260612C390000 TSLA 260612 390.00C 1 70408 US.SPY260612C730000 SPY 260612 730.00C 1 62881 ``` ##### `PRICE`（id=2002 · interval · OptIndicator） オプション価格 単位：通貨建て；SDK は元の価格をそのまま渡す ```python req.add_option_filter(OptIndicator.PRICE, lower=1.0, upper=10.0) req.add_sort(OptIndicator.VOLUME, desc=True) ``` 実測返却（US_STOCK · all_count=644732、ヒット 10 行、head 先頭 5）： ``` code option_name price volume US.NVDA260612C205000 NVDA 260612 205.00C 2.0 226041 US.NVDA260612C202500 NVDA 260612 202.50C 3.55 163991 US.NVDA260612C207500 NVDA 260612 207.50C 1.04 143944 US.SPY260612C740000 SPY 260612 740.00C 2.97 114906 US.TSLA260612C400000 TSLA 260612 400.00C 6.45 93756 ``` ##### `VOLUME`（id=2011 · interval · OptIndicator） 出来高 単位：枚 ```python req.add_option_filter(OptIndicator.VOLUME, lower=1000) req.add_sort(OptIndicator.VOLUME, desc=True) ``` 実測返却（US_STOCK · all_count=8010、ヒット 10 行、head 先頭 5）： ``` code option_name volume US.NVDA260612C205000 NVDA 260612 205.00C 226041 US.NVDA260612P200000 NVDA 260612 200.00P 184565 US.NVDA260612C202500 NVDA 260612 202.50C 163991 US.NVDA260612C210000 NVDA 260612 210.00C 147236 US.NVDA260612C207500 NVDA 260612 207.50C 143944 ``` ##### `OPEN_INTEREST`（id=2013 · interval · OptIndicator） 未決済建玉数 単位：枚 ```python req.add_option_filter(OptIndicator.OPEN_INTEREST, lower=1000) req.add_sort(OptIndicator.OPEN_INTEREST, desc=True) ``` 実測返却（US_STOCK · all_count=92911、ヒット 10 行、head 先頭 5）： ``` code option_name open_interest US.HYG260618P79000 HYG 260618 79.00P 451310 US.BKLN260717P20000 BKLN 260717 20.00P 406177 US.HYG261120C81000 HYG 261120 81.00C 386200 US.HYG260618P77000 HYG 260618 77.00P 332022 US.HYG260618P75000 HYG 260618 75.00P 324096 ``` ##### `IMPLIED_VOLATILITY`（id=3001 · interval · OptIndicator） インプライドボラティリティ 単位：% ；SDK は小数で直接渡す（50% は 0.5） ```python req.add_option_filter(OptIndicator.IMPLIED_VOLATILITY, lower=0.3) req.add_sort(OptIndicator.VOLUME, desc=True) ``` 実測返却（US_STOCK · all_count=1480382、ヒット 10 行、head 先頭 5）： ``` code option_name implied_volatility volume US.NVDA260612C205000 NVDA 260612 205.00C 0.70232 226041 US.NVDA260612P200000 NVDA 260612 200.00P 0.77927 184565 US.NVDA260612C202500 NVDA 260612 202.50C 0.72661 163991 US.NVDA260612C210000 NVDA 260612 210.00C 0.76536 147236 US.NVDA260612C207500 NVDA 260612 207.50C 0.72576 143944 ``` ##### `DELTA`（id=3004 · interval · OptIndicator） Greeks Delta CALL∈[0,1]、PUT∈[-1,0]；SDK は小数で直接渡す ```python req.add_option_filter(OptIndicator.DELTA, lower=0.3, upper=0.7) req.add_sort(OptIndicator.VOLUME, desc=True) ``` 実測返却（US_STOCK · all_count=219233、ヒット 10 行、head 先頭 5）： ``` code option_name delta volume US.NVDA260612C205000 NVDA 260612 205.00C 0.49538 226041 US.NVDA260612C202500 NVDA 260612 202.50C 0.68114 163991 US.NVDA260612C207500 NVDA 260612 207.50C 0.31335 143944 US.SPY260612C740000 SPY 260612 740.00C 0.45037 114906 US.TSLA260612C400000 TSLA 260612 400.00C 0.48887 93756 ``` ##### `GAMMA`（id=3005 · interval · OptIndicator） Greeks Gamma ≥0；SDK は小数で直接渡す ```python req.add_option_filter(OptIndicator.GAMMA, lower=0.01) req.add_sort(OptIndicator.VOLUME, desc=True) ``` 実測返却（US_STOCK · all_count=810281、ヒット 10 行、head 先頭 5）： ``` code option_name gamma volume US.NVDA260612C205000 NVDA 260612 205.00C 0.07901 226041 US.NVDA260612P200000 NVDA 260612 200.00P 0.0477 184565 US.NVDA260612C202500 NVDA 260612 202.50C 0.06835 163991 US.NVDA260612C210000 NVDA 260612 210.00C 0.0481 147236 US.NVDA260612C207500 NVDA 260612 207.50C 0.06793 143944 ``` ##### `THETA`（id=3007 · interval · OptIndicator） Greeks Theta 通常 ≤0（タイムディケイ）、SDK は小数で直接渡す ```python req.add_option_filter(OptIndicator.THETA, upper=-0.01) req.add_sort(OptIndicator.VOLUME, desc=True) ``` 実測返却（US_STOCK · all_count=1238755、ヒット 10 行、head 先頭 5）： ``` code option_name theta volume US.NVDA260612C205000 NVDA 260612 205.00C -2.30979 226041 US.NVDA260612P200000 NVDA 260612 200.00P -1.67055 184565 US.NVDA260612C202500 NVDA 260612 202.50C -2.13163 163991 US.NVDA260612C210000 NVDA 260612 210.00C -1.62903 147236 US.NVDA260612C207500 NVDA 260612 207.50C -2.10361 143944 ``` ##### `ITM_PROBABILITY`（id=3019 · interval · OptIndicator） ITM 確率 0~1 の小数；SDK はそのまま渡す ```python req.add_option_filter(OptIndicator.ITM_PROBABILITY, lower=0.3, upper=0.7) req.add_sort(OptIndicator.VOLUME, desc=True) ``` 実測返却（US_STOCK · all_count=417899、ヒット 10 行、head 先頭 5）： ``` code option_name itm_probability volume US.NVDA260612C205000 NVDA 260612 205.00C 0.48389 226041 US.SPY260612C740000 SPY 260612 740.00C 0.36646 114906 US.TSLA260612C400000 TSLA 260612 400.00C 0.46733 93756 US.AAPL260612C295000 AAPL 260612 295.00C 0.57372 87879 US.SPY260612C735000 SPY 260612 735.00C 0.66411 77126 ``` :::tip APIレート制限 * 30秒以内にオプションスクリーニング API を最大10回までリクエスト可能です ::: --- # オプション市場統計 `get_option_market_statistic(option_market, data_type, begin_time=None, end_time=None, page_req_key=None)` * **説明** オプション市場統計データ（出来高/建玉）を取得し、取引日単位でコール、プットおよび合計値を返します。ページネーション対応。 * **パラメータ** パラメータ|型|説明 :-|:-|:- option_market|[OptionMarket](./quote.md#9106)|オプション市場タイプ (US_SECURITY=米国株式オプション、US_INDEX=米国指数オプション、HK_SECURITY=香港株式オプション、HK_INDEX=香港指数オプション) data_type|[OptionStatisticDataType](./quote.md#4865)|データタイプ (VOLUME=出来高、OPEN_INTEREST=建玉) begin_time|str|開始日付、フォーマット 'YYYY-MM-DD' (未指定の場合、デフォルトで直近1年分のデータを取得) end_time|str|終了日付、フォーマット 'YYYY-MM-DD' (begin_time との期間は1年以内) page_req_key|bytes|ページングリクエストキー (初回は None、続きは前回の戻り値を渡す) * **戻り値**
パラメータ 型 説明
ret RET_CODE インターフェース呼び出し結果
data pandas.DataFrame ret == RET_OK の場合、統計データを返す
str ret != RET_OK の場合、エラー説明を返す
page_req_key bytes 次ページキー、None はデータなし
* 戻り DataFrame フィールド： フィールド|型|説明 :-|:-|:- time|str|取引日時間文字列 timestamp|float|取引日タイムスタンプ（Unix 秒） call_value|int|コールオプション合計値 put_value|int|プットオプション合計値 total_value|int|合計値（call_value + put_value） ratio|float|Put/Call 比率 (call_value が 0 の場合は N/A) * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data, page_req_key = quote_ctx.get_option_market_statistic( OptionMarket.US_SECURITY, OptionStatisticDataType.VOLUME, begin_time='2026-06-01', end_time='2026-06-15' ) if ret == RET_OK: print(data) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` time timestamp call_value put_value total_value ratio 0 2026-06-12 1.781237e+09 45658870 28723978 74382848 0.629100 1 2026-06-11 1.781150e+09 38303062 30520043 68823105 0.796804 2 2026-06-10 1.781064e+09 35371830 30180004 65551834 0.853221 3 2026-06-09 1.780978e+09 42880655 36646152 79526807 0.854608 4 2026-06-08 1.780891e+09 35442266 25811533 61253799 0.728270 5 2026-06-05 1.780632e+09 52362998 44023321 96386319 0.840733 6 2026-06-04 1.780546e+09 38082169 24572137 62654306 0.645240 7 2026-06-03 1.780459e+09 36858233 23035404 59893637 0.624973 8 2026-06-02 1.780373e+09 36822706 21026201 57848907 0.571012 9 2026-06-01 1.780286e+09 42932185 24084036 67016221 0.560979 ``` :::tip インターフェース制限 * 30秒以内に最大60回のオプション市場統計インターフェースリクエスト（ページング対応のインターフェースは初回呼び出しのみカウント） ::: --- # オプション原資産概要 `get_option_underlying_overview(code_list, index_option_type=IndexOptionType.NORMAL)` * **説明** オプション原資産の概要データを一括取得します。出来高、建玉、インプライドボラティリティ（IV）および複数期間のヒストリカルボラティリティ（HV）等のコア指標の最新スナップショットを含みます。 * **パラメータ** パラメータ|型|説明 :-|:-|:- code_list|list[str]|原資産銘柄コードリスト (例：['US.AAPL', 'US.TSLA']、最大 500 個) index_option_type|[IndexOptionType](./quote.md#1625)|指数オプションタイプ (NORMAL=通常オプション（デフォルト）、SMALL=ミニ指数オプション、ハンセン/国企指数のみ必要) * **戻り値**
パラメータ 型 説明
ret RET_CODE インターフェース呼び出し結果
data pandas.DataFrame ret == RET_OK の場合、原資産概要データを返す
str ret != RET_OK の場合、エラー説明を返す
* 戻り DataFrame フィールド： フィールド|型|説明 :-|:-|:- code|str|銘柄コード name|str|原資産名称 call_volume|int|コールオプション出来高 put_volume|int|プットオプション出来高 call_open_interest|int|コールオプション建玉（T-1 遅延） put_open_interest|int|プットオプション建玉（T-1 遅延） iv|float|インプライドボラティリティ（パーセント） iv_rank|float|IV ランクパーセンタイル（パーセント） iv_percentile|float|IV パーセンタイル（パーセント） pre_iv|float|前取引日 IV（パーセント） hv_30d|float|30日ヒストリカルボラティリティ（パーセント） hv_30d_percentile|float|30日 HV パーセンタイル hv_60d|float|60日ヒストリカルボラティリティ（パーセント） hv_60d_percentile|float|60日 HV パーセンタイル hv_90d|float|90日ヒストリカルボラティリティ（パーセント） hv_90d_percentile|float|90日 HV パーセンタイル hv_120d|float|120日ヒストリカルボラティリティ（パーセント） hv_120d_percentile|float|120日 HV パーセンタイル hv_365d|float|365日ヒストリカルボラティリティ（パーセント） hv_365d_percentile|float|365日 HV パーセンタイル * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_option_underlying_overview(['US.AAPL', 'US.TSLA', 'US.NVDA']) if ret == RET_OK: print(data) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` code name call_volume put_volume call_open_interest put_open_interest iv iv_rank iv_percentile pre_iv hv_30d hv_30d_percentile hv_60d hv_60d_percentile hv_90d hv_90d_percentile hv_120d hv_120d_percentile hv_365d hv_365d_percentile 0 US.AAPL Apple 782941 490299 3165108 2237950 25.126 37.702 19.841 25.617 23.324 59.126 24.641 65.476 23.019 46.825 23.582 47.619 22.619 8.333 1 US.TSLA Tesla 2197764 1425740 4178685 2909774 55.053 39.265 64.285 55.401 49.359 68.254 46.536 58.730 44.990 46.031 41.688 29.761 44.500 1.190 2 US.NVDA NVIDIA 1980405 1176926 9096278 7648683 41.975 27.062 42.460 45.135 45.921 96.825 42.646 99.206 39.980 92.460 38.971 81.746 34.989 17.063 ``` :::tip インターフェース制限 * 30秒以内に最大60回のオプション原資産概要インターフェースリクエスト ::: --- # オプション原資産履歴統計 `get_option_underlying_his_statistic(code, index_option_type=IndexOptionType.NORMAL, begin_time=None, end_time=None, page_req_key=None)` * **説明** オプション原資産の履歴統計データを取得します。取引日単位で該当原資産に対応するオプションの出来高、建玉および Put/Call 比率の時系列を返します。ページネーション対応。 * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|原資産銘柄コード (例：'US.AAPL') index_option_type|[IndexOptionType](./quote.md#1625)|指数オプションタイプ (NORMAL=通常オプション（デフォルト）、SMALL=ミニ指数オプション) begin_time|str|開始日付、フォーマット 'YYYY-MM-DD' (未指定の場合、デフォルトで end_time から364日前) end_time|str|終了日付、フォーマット 'YYYY-MM-DD' (begin_time との期間は最大364日) page_req_key|bytes|ページングリクエストキー (初回は None、続きは前回の戻り値を渡す) * **戻り値**
パラメータ 型 説明
ret RET_CODE インターフェース呼び出し結果
data pandas.DataFrame ret == RET_OK の場合、統計データを返す
str ret != RET_OK の場合、エラー説明を返す
page_req_key bytes 次ページキー、None はデータなし
* 戻り DataFrame フィールド： フィールド|型|説明 :-|:-|:- code|str|銘柄コード name|str|銘柄名称 time|str|取引日時間文字列 timestamp|float|取引日タイムスタンプ（Unix 秒） option_volume|int|オプション総出来高（call_volume + put_volume） call_volume|int|コールオプション出来高 put_volume|int|プットオプション出来高 put_call_volume_ratio|float|Put/Call 出来高比率 option_open_interest|int|オプション総建玉 call_open_interest|int|コールオプション建玉（T-1 遅延） put_open_interest|int|プットオプション建玉（T-1 遅延） put_call_open_interest_ratio|float|Put/Call 建玉比率 underlying_price|float|原資産価格 * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data, page_req_key = quote_ctx.get_option_underlying_his_statistic( 'US.AAPL', begin_time='2026-06-01', end_time='2026-06-15' ) if ret == RET_OK: print(data) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` code name time timestamp option_volume call_volume put_volume put_call_volume_ratio option_open_interest call_open_interest put_open_interest put_call_open_interest_ratio underlying_price 0 US.AAPL Apple 2026-06-12 1.781237e+09 1273240 782941 490299 0.626227 0 0 0 N/A 291.13 1 US.AAPL Apple 2026-06-11 1.781150e+09 950737 580535 370202 0.637691 5403058 3165108 2237950 0.707069 295.63 2 US.AAPL Apple 2026-06-10 1.781064e+09 1734799 1039630 695169 0.668670 5522747 3270454 2252293 0.688679 291.58 3 US.AAPL Apple 2026-06-09 1.780978e+09 1715749 1024046 691703 0.675461 5405022 3209586 2195436 0.684025 290.55 4 US.AAPL Apple 2026-06-08 1.780891e+09 2179789 1293656 886133 0.684983 5350402 3142828 2207574 0.702416 301.54 ... ``` :::tip インターフェース制限 * 30秒以内に最大60回のオプション原資産履歴統計インターフェースリクエスト（ページング対応のインターフェースは初回呼び出しのみカウント） ::: --- # オプション原資産履歴ボラティリティ `get_option_underlying_his_volatility(code, index_option_type=IndexOptionType.NORMAL, begin_time=None, end_time=None, page_req_key=None)` * **説明** オプション原資産のヒストリカルボラティリティデータを取得します。取引日単位で IV と HV の時系列および原資産終値を返します。ページネーション対応。 * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|原資産銘柄コード (例：'US.AAPL') index_option_type|[IndexOptionType](./quote.md#1625)|指数オプションタイプ (NORMAL=通常オプション（デフォルト）、SMALL=ミニ指数オプション) begin_time|str|開始日付、フォーマット 'YYYY-MM-DD' end_time|str|終了日付、フォーマット 'YYYY-MM-DD' page_req_key|bytes|ページングリクエストキー (初回は None、続きは前回の戻り値を渡す) :::tip 時間範囲について - `begin_time` と `end_time` の間隔は最大 **364 日** - 両方未指定：`end_time` = 当日、`begin_time` = 当日から 364 日前 - `begin_time` のみ指定：`end_time` = `begin_time` から 364 日後 - `end_time` のみ指定：`begin_time` = `end_time` から 364 日前 ::: * **戻り値**
パラメータ 型 説明
ret RET_CODE インターフェース呼び出し結果
data pandas.DataFrame ret == RET_OK の場合、ボラティリティデータを返す
str ret != RET_OK の場合、エラー説明を返す
page_req_key bytes 次ページキー、None はデータなし
* 戻り DataFrame フィールド： フィールド|型|説明 :-|:-|:- code|str|銘柄コード name|str|銘柄名称 time|str|取引日時間文字列 timestamp|float|取引日タイムスタンプ（Unix 秒） iv|float|インプライドボラティリティ（パーセント） hv|float|ヒストリカルボラティリティ（パーセント） underlying_price|float|原資産終値（当日はマーク価格） * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data, page_req_key = quote_ctx.get_option_underlying_his_volatility( 'US.AAPL', begin_time='2026-06-01', end_time='2026-06-15' ) if ret == RET_OK: print(data) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` code name time timestamp iv hv underlying_price 0 US.AAPL Apple 2026-06-12 1.781237e+09 25.126 23.324 291.13 1 US.AAPL Apple 2026-06-11 1.781150e+09 25.617 23.270 295.63 2 US.AAPL Apple 2026-06-10 1.781064e+09 27.384 22.892 291.58 3 US.AAPL Apple 2026-06-09 1.780978e+09 27.237 22.854 290.55 4 US.AAPL Apple 2026-06-08 1.780891e+09 26.368 19.028 301.54 5 US.AAPL Apple 2026-06-05 1.780632e+09 26.995 18.024 307.34 6 US.AAPL Apple 2026-06-04 1.780546e+09 25.249 17.366 311.23 7 US.AAPL Apple 2026-06-03 1.780459e+09 26.801 18.927 310.26 8 US.AAPL Apple 2026-06-02 1.780373e+09 26.258 18.415 315.20 9 US.AAPL Apple 2026-06-01 1.780286e+09 25.864 16.841 306.31 ``` :::tip インターフェース制限 * 30秒以内に最大60回のオプション原資産履歴ボラティリティインターフェースリクエスト（ページング対応のインターフェースは初回呼び出しのみカウント） ::: --- # オプション原資産ランキング `get_option_underlying_rank(option_market, sort_type, sort_direction=None, count=None, trading_date=None, filter_list=None, page=None)` * **説明** オプション人気原資産ランキングを取得します。指定された次元でオプション原資産（株式/ETF/指数）をランク付けし、多次元フィルタリングとページネーションに対応しています。 * **パラメータ** パラメータ|型|説明 :-|:-|:- option_market|[OptionMarket](./quote.md#9106)|オプション市場タイプ (US_SECURITY=米国株式オプション、US_INDEX=米国指数オプション、HK_SECURITY=香港株式オプション、HK_INDEX=香港指数オプション) sort_type|[UnderlyingRankSortType](./quote.md#2000)|ソートフィールド (VOLUME=総出来高、VOLUME_RATIO=Put/Call出来高比値、OPEN_INTEREST=総建玉、OPEN_INTEREST_RATIO=Put/Call建玉比値、PRICE=最新価格、PRICE_CHANGE=騰落率、IV=IV、IV_CHANGE=IV変化率、HV=HV、HV_CHANGE=HV変化率、IV_RANK=IV Rank、IV_PERCENTILE=IV Percentile、MARKET_CAP=時価総額) sort_direction|int|ソート方向 (0=降順（デフォルト）、1=昇順) count|int|ページあたりの数量 (範囲 [1,200]、デフォルト 200) trading_date|str|取引日 (フォーマット yyyy-MM-dd、未指定の場合は最新ランキングを返す) filter_list|list[UnderlyingRankFilter]|フィルタ条件リスト (複数条件は AND 関係) page|str|ページングカーソル (初回リクエストは None を渡す、ページングは前回返却の next_page を渡す) * **戻り値**
パラメータ 型 説明
ret RET_CODE インターフェース呼び出し結果
data pandas.DataFrame ret == RET_OK の場合、ランキングデータを返す
str ret != RET_OK の場合、エラー説明を返す
next_page str 次ページカーソル文字列、None は次ページなし
all_count int 条件に合致する総データ数
* data DataFrame フィールド： フィールド|型|説明 :-|:-|:- code|str|原資産銘柄コード name|str|原資産名称 total_volume|int|オプション総出来高 total_open_interest|int|オプション総建玉 volume_ratio|float|Put/Call 出来高比率（パーセント） open_interest_ratio|float|Put/Call 建玉比率（パーセント） iv|float|インプライドボラティリティ（パーセント） iv_rank|float|IV ランクパーセンタイル（パーセント） iv_percentile|float|IV パーセンタイル（パーセント） price|float|原資産最新価格 change_ratio|float|原資産騰落率（小数） iv_change|float|IV 変化率（パーセント） hv|float|ヒストリカルボラティリティ（パーセント） hv_change|float|HV 変化率（パーセント） market_cap|float|時価総額 trading_date|str|ランキングデータ対応取引日 trading_timestamp|float|ランキングデータ対応取引日タイムスタンプ（Unix 秒） * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data, next_page, all_count = quote_ctx.get_option_underlying_rank( option_market=OptionMarket.US_SECURITY, sort_type=UnderlyingRankSortType.VOLUME, count=5 ) if ret == RET_OK: print(data) print('all_count:', all_count) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` code name total_volume total_open_interest volume_ratio open_interest_ratio iv iv_rank iv_percentile price change_ratio iv_change hv hv_change market_cap trading_date trading_timestamp 0 US.SPY 标普500ETF-SPDR 14228830 19909256 0.97899 1.93868 17.675 27.143 61.111 741.75 0.540826 -8.261 15.031 -0.057 7.814945e+11 2026-06-12 1.781237e+09 1 US.QQQ 纳指100ETF-Invesco QQQ Trust 8239190 12964422 0.99417 1.49888 27.652 62.918 91.269 721.34 0.588465 -8.332 26.196 -0.644 4.765533e+11 2026-06-12 1.781237e+09 2 US.TSLA 特斯拉 3623504 7088459 0.64872 0.69633 55.053 39.265 64.285 406.43 1.823876 -0.629 49.359 -1.194 1.526439e+12 2026-06-12 1.781237e+09 3 US.NVDA 英伟达 3157331 16744961 0.59428 0.84085 41.975 27.062 42.460 205.19 0.156197 -7.002 45.921 -1.972 4.965598e+12 2026-06-12 1.781237e+09 4 US.IWM 罗素2000ETF-iShares 2840729 11791964 0.79034 2.78276 24.857 33.930 64.285 292.95 0.874626 -6.744 24.802 0.522 8.061984e+10 2026-06-12 1.781237e+09 all_count: 6017 ``` :::tip インターフェース制限 * 30秒以内に最大60回のオプション原資産ランキングインターフェースリクエスト（ページング対応のインターフェースは初回呼び出しのみカウント） ::: --- # オプション契約ランキング `get_option_rank(option_market, sort_type, count=None, trading_date=None, sort_direction=None, page=None, filter_list=None)` * **説明** オプション契約ランキングリストを取得します。出来高、建玉、増玉、減玉、IV、騰落率等の次元でのソートに対応。 * **パラメータ** パラメータ|型|説明 :-|:-|:- option_market|[OptionMarket](./quote.md#9106)|オプション市場タイプ (US_SECURITY=米国株式オプション、US_INDEX=米国指数オプション、HK_SECURITY=香港株式オプション、HK_INDEX=香港指数オプション) sort_type|[OptionRankType](./quote.md#8301)|ソートタイプ (VOLUME=出来高、TURNOVER=売買代金、OPEN_INTEREST=建玉、OI_INCREMENT=増玉、OI_DECREMENT=減玉、OI_MARKET_CAP_INCREMENT=増玉額、OI_MARKET_CAP_DECREMENT=減玉額、IV=インプライドボラティリティ、CHANGE_RATE=騰落率) count|int|返却数量 (範囲 [1,200]、デフォルト 200) trading_date|str|取引日 (フォーマット yyyy-MM-dd、未指定の場合は最新ランキングを返す) sort_direction|int|ソート方向 (0=降順(デフォルト)、1=昇順) page|str|ページングカーソル (初回リクエストは未指定、以降は next_page を渡す) filter_list|list[OptionRankFilter]|フィルタ条件リスト (複数条件は AND 関係) * **戻り値** パラメータ|型|説明 :-|:-|:- ret|[RET_CODE](../ftapi/common.html#7467)|インターフェース呼び出し結果 data|pandas.DataFrame|ret == RET_OK の場合、ランキングデータを返す。ret != RET_OK の場合、エラー説明文字列を返す next_page|str|次ページカーソル。データがない場合は None all_count|int|総数 * data DataFrame フィールド： フィールド|型|説明 :-|:-|:- code|str|オプション契約コード name|str|オプション名称 option_type|str|オプションタイプ (CALL、PUT) oi_increment|int|増玉 oi_decrement|int|減玉 oi_market_cap_increment|float|増玉額 oi_market_cap_decrement|float|減玉額 volume|int|出来高 turnover|float|売買代金 open_interest|int|建玉 open_interest_market_cap|float|建玉額 iv|float|インプライドボラティリティ（パーセント） option_price|float|オプション最新価格 change_ratio|float|騰落率（パーセント） mid_price|float|中間価格 bid_price|float|買い価格 bid_volume|int|買い数量 ask_price|float|売り価格 ask_volume|int|売り数量 delta|float|Delta gamma|float|Gamma theta|float|Theta vega|float|Vega rho|float|Rho trading_date|str|取引日 trading_timestamp|float|取引タイムスタンプ * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data, next_page, all_count = quote_ctx.get_option_rank( OptionMarket.US_SECURITY, OptionRankType.VOLUME, count=5 ) if ret == RET_OK: print(data) print('all_count:', all_count) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` code name option_type oi_increment oi_decrement oi_market_cap_increment oi_market_cap_decrement volume turnover open_interest open_interest_market_cap iv option_price change_ratio mid_price bid_price bid_volume ask_price ask_volume delta gamma theta vega rho trading_date trading_timestamp 0 US.SPY260612C742000 SPY 260612 742.00C CALL 1816 N/A 105328.0 N/A 730160 91928623.0 7449 432042.0 146.507 0.58 -67.688 0.580 0.56 28 0.60 1 0.43674 0.27447 -455.46028 0.00385 0.0 2026-06-12 1.781237e+09 1 US.SPY260612C745000 SPY 260612 745.00C CALL 5416 N/A 5416.0 N/A 617981 44479304.0 17013 17013.0 87.067 0.01 -98.958 0.015 0.01 708 0.02 500 0.02438 0.03501 -18.52310 0.00107 0.0 2026-06-12 1.781237e+09 2 US.SPY260612C743000 SPY 260612 743.00C CALL 5438 N/A 48942.0 N/A 606769 64419534.0 7426 66834.0 59.082 0.09 -93.898 0.095 0.09 208 0.10 118 0.13412 0.19487 -50.92453 0.00405 0.0 2026-06-12 1.781237e+09 3 US.SPY260612P740000 SPY 260612 740.00P PUT 1223 N/A 1223.0 N/A 566915 69291991.0 15291 15291.0 53.083 0.01 -99.790 0.015 0.01 447 0.02 407 -0.03761 0.08224 -16.47701 0.00153 0.0 2026-06-12 1.781237e+09 4 US.SPY260612C741000 SPY 260612 741.00C CALL 2924 N/A 423980.0 N/A 506505 88981079.0 6229 903205.0 224.448 1.45 -33.179 1.520 1.46 12 1.58 23 0.63754 0.17055 -662.49947 0.00367 0.0 2026-06-12 1.781237e+09 all_count: 1955829 ``` :::tip インターフェース制限 * 30秒以内に最大60回のオプション契約ランキングインターフェースリクエスト（ページング対応のインターフェースは初回呼び出しのみカウント） ::: --- # オプション異常取引 `get_option_event(option_market, count=None, page=None, filter_list=None, sort=None)` * **説明** オプション異常取引リストを取得します。大口約定、スイープ注文等のオプション異常取引記録を返し、原資産、契約属性、約定情報、グリークス等の多次元フィルタとソートに対応。 * **パラメータ** パラメータ|型|説明 :-|:-|:- option_market|[OptionMarket](./quote.md#9106)|オプション市場タイプ (US_SECURITY=米国株式オプション、US_INDEX=米国指数オプション、HK_SECURITY=香港株式オプション、HK_INDEX=香港指数オプション) count|int|ページあたりの数量 (範囲 [1,300]) page|str|ページングマーカー (初回は空文字列、ページングは前回返却の next_page を渡す) filter_list|list[EventFilter]|フィルタ条件リスト (複数条件は AND 関係。原資産(OWNER_LIST)、業種、オプションタイプ(CALL/PUT)、約定方向、出来高、売買代金、IV、Delta 等でフィルタ可能) sort|EventSort|ソート (デフォルトは時間降順) * **戻り値**
パラメータ 型 説明
ret RET_CODE インターフェース呼び出し結果
data dict ret == RET_OK の場合、異常取引データを返す
str ret != RET_OK の場合、エラー説明を返す
* data 辞書含有： フィールド|型|説明 :-|:-|:- event_list|pandas.DataFrame|異常取引リスト next_page|str|次ページマーカー (空文字列はこれ以上ページがないことを示す) all_count|int|総件数 update_timestamp|float|データ更新タイムスタンプ * event_list DataFrame フィールド： フィールド|型|説明 :-|:-|:- option_code|str|オプション契約コード owner_code|str|原資産銘柄コード symbol|str|原資産表示コード（例：TSLA） fill_time|str|約定時間 fill_timestamp|float|約定タイムスタンプ（Unix 秒） ticker_type|str|約定方向 (BUY/SELL/NEUTRAL) price|float|約定価格 volume|int|約定数量（枚） turnover|float|約定金額 option_type|str|オプションタイプ (CALL/PUT) strike_price|float|行使価格 strike_time|str|満期日 strike_timestamp|float|満期タイムスタンプ（Unix 秒） dte|int|満期までの日数 underlying_price|float|原資産価格 otm|float|アウトオブザマネー比率（パーセント） bid_price|float|買い1価格 ask_price|float|売り1価格 iv|float|インプライドボラティリティ（パーセント） total_volume|int|オプション当日総出来高 total_open_interest|int|オプション当日総建玉 vo_ratio|float|出来高/建玉比率（パーセント） delta|float|Delta gamma|float|Gamma vega|float|Vega theta|float|Theta rho|float|Rho sentiment|str|市場センチメント (BEARISH/BULLISH/NEUTRAL) order_type_list|list|注文タイプリスト (NORMAL/SWEEP/CROSS/FLOOR) strategy_type|str|戦略タイプ (SINGLE_LEG/MULTI_LEG) earnings_time|str|決算時間 earnings_pub_type|int|決算発表タイプ corporate_action_list|list|コーポレートアクションリスト industry_plate_list|list|業種プレートリスト concept_plate_list|list|コンセプトプレートリスト * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_option_event(OptionMarket.US_SECURITY, count=5) if ret == RET_OK: print(data['event_list']) print('all_count:', data['all_count']) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` option_code owner_code symbol fill_time fill_timestamp ticker_type price volume turnover option_type strike_price strike_time strike_timestamp dte underlying_price otm bid_price ask_price iv total_volume total_open_interest vo_ratio delta gamma vega theta rho sentiment order_type_list strategy_type earnings_time earnings_pub_type corporate_action_list industry_plate_list concept_plate_list 0 US.TLT260618C86000 US.TLT TLT 2026-06-12 16:14:00 1.781295e+09 SELL 0.280000 10000 280000.0 CALL 86.0 2026-06-18 1.781759e+09 3 85.77 0.268 0.28 0.30 8.240 70108 88849 0.78906 0.424382 0.432194 0.043077 -0.034441 0.005940 BEARISH [SWEEP, NORMAL] SINGLE_LEG N/A N/A N/A N/A N/A 1 US.TLT260618C86000 US.TLT TLT 2026-06-12 16:13:18 1.781295e+09 SELL 0.280000 7821 218988.0 CALL 86.0 2026-06-18 1.781759e+09 3 85.77 0.268 0.28 0.30 8.240 60104 88849 0.67647 0.424382 0.432194 0.043077 -0.034441 0.005940 BEARISH [SWEEP, NORMAL] SINGLE_LEG N/A N/A N/A N/A N/A 2 US.IWM260618P285000 US.IWM IWM 2026-06-12 16:07:53 1.781295e+09 SELL 1.320000 3002 396264.0 PUT 285.0 2026-06-18 1.781759e+09 3 292.96 2.717 1.32 1.35 28.323 57418 26731 2.14799 -0.214110 0.027402 0.109475 -0.256980 -0.009801 BULLISH [SWEEP, NORMAL] SINGLE_LEG N/A N/A [{'action_type': 7, 'action_time': '2026-06-15', 'action_timestamp': ...}] N/A N/A 3 US.SPY260717P706000 US.SPY SPY 2026-06-12 16:04:46 1.781295e+09 BUY 4.333523 3872 1677940.0 PUT 706.0 2026-07-17 1.784264e+09 32 741.77 4.822 4.29 4.35 19.000 22269 8169 2.72603 -0.177726 0.005982 0.596630 -0.150480 -0.113947 BEARISH [SWEEP, NORMAL] SINGLE_LEG N/A N/A N/A N/A [US.LIST2153] 4 US.SPY260717P704000 US.SPY SPY 2026-06-12 16:04:26 1.781295e+09 SELL 4.060235 6767 2747561.0 PUT 704.0 2026-07-17 1.784264e+09 32 741.77 5.091 4.05 4.10 19.214 17712 7842 2.25860 -0.167963 0.005705 0.575554 -0.147087 -0.107775 BULLISH [NORMAL] SINGLE_LEG N/A N/A N/A N/A [US.LIST2153] all_count: 164620 ``` :::tip インターフェース制限 * 30秒以内に最大60回のオプション異常取引インターフェースリクエスト（ページング対応のインターフェースは初回呼び出しのみカウント） ::: --- # 異常取引アラート照会 `get_option_event_alert(count=200, page=None)` * **説明** 設定済みのオプション異常取引アラートリストを照会します。ページネーション対応。 * **パラメータ** パラメータ|型|説明 :-|:-|:- count|int|ページあたりの数量 (範囲 [1,500]、デフォルト 200) page|str|ページングマーカー (初回は None を渡す、ページングは next_page を渡す) * **戻り値**
パラメータ 型 説明
ret RET_CODE インターフェース呼び出し結果
data dict ret == RET_OK の場合、アラートデータを返す
str ret != RET_OK の場合、エラー説明を返す
* data 辞書含有： フィールド|型|説明 :-|:-|:- alert_list|pandas.DataFrame|アラート設定リスト next_page|str|次ページマーカー（空文字列は次ページなし） all_count|int|アラート項目総数 * alert_list DataFrame 各列フィールド： フィールド|型|説明 :-|:-|:- key|int|アラート一意識別子 enable|bool|アラートスイッチ option_market|str|市場カテゴリ（[OptionMarket](./quote.md#9106) 列挙値） watchlist_group_name|str|ウォッチリストグループ名 underlying|str|指定原資産コード option_type|str|オプションタイプ（CALL/PUT） side_type_list|list|約定方向リスト（[EventTickerType](./quote.md#1576) 列挙値） order_type_list|list|注文タイプリスト（[AlertOrderType](./quote.md#1818) 列挙値） market_cap_range_min|float|原資産時価総額下限 market_cap_range_max|float|原資産時価総額上限 market_cap_min_inclusive|bool|原資産時価総額下限が閉区間かどうか market_cap_max_inclusive|bool|原資産時価総額上限が閉区間かどうか expiry_days_range_min|float|満期までの日数下限 expiry_days_range_max|float|満期までの日数上限 expiry_days_min_inclusive|bool|満期までの日数下限が閉区間かどうか expiry_days_max_inclusive|bool|満期までの日数上限が閉区間かどうか price_range_min|float|異常取引約定価格下限 price_range_max|float|異常取引約定価格上限 price_min_inclusive|bool|異常取引約定価格下限が閉区間かどうか price_max_inclusive|bool|異常取引約定価格上限が閉区間かどうか size_range_min|float|異常取引約定数量下限（枚） size_range_max|float|異常取引約定数量上限（枚） size_min_inclusive|bool|異常取引約定数量下限が閉区間かどうか size_max_inclusive|bool|異常取引約定数量上限が閉区間かどうか premium_range_min|float|異常取引約定金額下限 premium_range_max|float|異常取引約定金額上限 premium_min_inclusive|bool|異常取引約定金額下限が閉区間かどうか premium_max_inclusive|bool|異常取引約定金額上限が閉区間かどうか iv_range_min|float|インプライドボラティリティ下限（%） iv_range_max|float|インプライドボラティリティ上限（%） iv_min_inclusive|bool|インプライドボラティリティ下限が閉区間かどうか iv_max_inclusive|bool|インプライドボラティリティ上限が閉区間かどうか earnings_date_begin|str|決算日フィルタ開始日（yyyy-MM-dd） earnings_date_end|str|決算日フィルタ終了日（yyyy-MM-dd） note|str|メモ * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_option_event_alert() if ret == RET_OK: print(data['alert_list']) print('all_count:', data['all_count']) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` key enable option_market watchlist_group_name underlying option_type side_type_list order_type_list market_cap_range_min market_cap_range_max market_cap_min_inclusive market_cap_max_inclusive expiry_days_range_min expiry_days_range_max expiry_days_min_inclusive expiry_days_max_inclusive price_range_min price_range_max price_min_inclusive price_max_inclusive size_range_min size_range_max size_min_inclusive size_max_inclusive premium_range_min premium_range_max premium_min_inclusive premium_max_inclusive iv_range_min iv_range_max iv_min_inclusive iv_max_inclusive earnings_date_begin earnings_date_end note 0 14743 False US_SECURITY N/A N/A CALL N/A [SWEEP] N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A 100.0 N/A True N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A test all_count: 1 ``` :::tip インターフェース制限 * 30秒以内に最大60回の異常取引アラート照会インターフェースリクエスト（ページング対応のインターフェースは初回呼び出しのみカウント） ::: --- # 異常取引アラート設定 `set_option_event_alert(op, alert_list=None)` * **説明** オプション異常取引アラートの新規追加、修正、削除、有効化/無効化を行います。 * **パラメータ** パラメータ|型|説明 :-|:-|:- op|[AlertOpType](./quote.md#9858)|操作タイプ (ADD=新規追加、DELETE=削除、MODIFY=修正、ENABLE=有効化、DISABLE=無効化、DELETE_ALL=全削除) alert_list|OptionEventAlertItem または list[OptionEventAlertItem]|アラート条目 (新規追加時は key 不要、修正/削除時は key 必須) * OptionEventAlertItem 各フィールド： フィールド|型|説明 :-|:-|:- key|int|アラート一意識別子（修正/削除/有効化/無効化時必須） enable|bool|アラートスイッチ option_market|[OptionMarket](./quote.md#9106)|監視するオプション市場（三択一） watchlist_group_name|str|ウォッチリストグループ名（三択一） underlying|str|指定原資産コード、例: `'US.AAPL'`（三択一） option_type|OptionType|オプションタイプ（CALL/PUT） side_type_list|list[[EventTickerType](./quote.md#1576)]|約定方向リスト order_type_list|list[[AlertOrderType](./quote.md#1818)]|注文タイプリスト market_cap_range_min|float|原資産時価総額下限 market_cap_range_max|float|原資産時価総額上限 market_cap_min_inclusive|bool|原資産時価総額下限が閉区間かどうか（デフォルト True） market_cap_max_inclusive|bool|原資産時価総額上限が閉区間かどうか（デフォルト True） expiry_days_range_min|float|満期までの日数下限 expiry_days_range_max|float|満期までの日数上限 expiry_days_min_inclusive|bool|満期までの日数下限が閉区間かどうか（デフォルト True） expiry_days_max_inclusive|bool|満期までの日数上限が閉区間かどうか（デフォルト True） price_range_min|float|異常取引約定価格下限 price_range_max|float|異常取引約定価格上限 price_min_inclusive|bool|異常取引約定価格下限が閉区間かどうか（デフォルト True） price_max_inclusive|bool|異常取引約定価格上限が閉区間かどうか（デフォルト True） size_range_min|float|異常取引約定数量下限（枚） size_range_max|float|異常取引約定数量上限（枚） size_min_inclusive|bool|異常取引約定数量下限が閉区間かどうか（デフォルト True） size_max_inclusive|bool|異常取引約定数量上限が閉区間かどうか（デフォルト True） premium_range_min|float|異常取引約定金額下限 premium_range_max|float|異常取引約定金額上限 premium_min_inclusive|bool|異常取引約定金額下限が閉区間かどうか（デフォルト True） premium_max_inclusive|bool|異常取引約定金額上限が閉区間かどうか（デフォルト True） iv_range_min|float|インプライドボラティリティ下限（%） iv_range_max|float|インプライドボラティリティ上限（%） iv_min_inclusive|bool|インプライドボラティリティ下限が閉区間かどうか（デフォルト True） iv_max_inclusive|bool|インプライドボラティリティ上限が閉区間かどうか（デフォルト True） earnings_date_begin|str|決算日フィルタ開始日（yyyy-MM-dd） earnings_date_end|str|決算日フィルタ終了日（yyyy-MM-dd） note|str|メモ（最大20文字） > **監視範囲**：`option_market`、`watchlist_group_name`、`underlying` は相互排他で、新規追加時にいずれか一つを設定する必要があります。 * **戻り値**
パラメータ 型 説明
ret RET_CODE インターフェース呼び出し結果
data str ret == RET_OK の場合、空文字列を返す
str ret != RET_OK の場合、エラー説明を返す
* **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) # アラート新規追加：米株オプション市場のCALLスイープ、約定数量 > 100（開区間） item = OptionEventAlertItem( option_market=OptionMarket.US_SECURITY, option_type=OptionType.CALL, order_type_list=[AlertOrderType.SWEEP], size_range_min=100, size_min_inclusive=False, note='test' ) ret, data = quote_ctx.set_option_event_alert(AlertOpType.ADD, item) if ret == RET_OK: print('新増成功') else: print('error:', data) quote_ctx.close() ``` * **Output** ``` 新増成功 ``` :::tip インターフェース制限 * 30秒以内に最大60回の異常取引アラート設定インターフェースリクエスト ::: --- # オプション異常変動プッシュ `class OptionEventHandlerBase(RspHandlerBase)` * **説明** オプション異常変動プッシュを受信します。設定した異常変動アラートがトリガーされると、サーバーから異常変動情報がプッシュされます。事前に `set_option_event_alert` でアラート条件を設定し、handler でコールバックを登録する必要があります。ユーザーは `OptionEventHandlerBase` を継承し、`on_recv_rsp` メソッドをオーバーライドしてプッシュを受信します。 * **パラメータ** on_recv_rsp コールバックは (ret_code, content) を返します。content は dict： パラメータ|型|説明 :-|:-|:- owner_code|str|原資産コード（例: 'US.TSLA'） option_code|str|オプション契約コード（例: 'US.TSLA250620C250'） message|str|プッシュメッセージテキスト * **Example** ```python from moomoo import * class OptionEventHandler(OptionEventHandlerBase): def on_recv_rsp(self, rsp_pb): ret_code, content = super(OptionEventHandler, self).on_recv_rsp(rsp_pb) if ret_code != RET_OK: print("OptionEvent error:", content) return RET_ERROR, content print("オプション異常変動プッシュを受信:") print(" 原資産:", content['owner_code']) print(" オプション:", content['option_code']) print(" メッセージ:", content['message']) return RET_OK, content quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) # オプション異常変動プッシュハンドラーを登録 quote_ctx.set_handler(OptionEventHandler()) # set_option_event_alert でアラート条件を設定する必要があります。設定後にプッシュが有効になります item = OptionEventAlertItem( option_market=OptionMarket.US_SECURITY, option_type=OptionType.CALL, order_type_list=[AlertOrderType.SWEEP], size_range_min=100, ) ret, data = quote_ctx.set_option_event_alert(AlertOpType.ADD, item) if ret == RET_OK: print('アラート設定成功、プッシュ待機中...') else: print('設定失敗:', data) import time try: while True: time.sleep(1) except KeyboardInterrupt: pass quote_ctx.close() ``` * **Output** ``` オプション異常変動プッシュを受信: 原資産: US.TSLA オプション: US.TSLA250620C250 メッセージ: TSLA $250 Call 06/20 大口スイープ 500枚 約定価格$12.50 ``` --- # ゼロDTEオプションスクリーナー `get_option_zero_dte_screener(market, sort_type=None, is_asc=None, count=None, page=None, filter_list=None)` * **説明** ゼロDTEオプション原資産スクリーニングリストを取得します。当日満期（0DTE）オプションに対応する原資産銘柄情報を返し、ボラティリティ、オプション出来高、建玉およびオプションチェーン情報等のデータを含みます。 * **パラメータ** パラメータ|型|説明 :-|:-|:- market|[OptionMarket](./quote.md#9106)|オプション市場タイプ (US_SECURITY=米国株式オプション、US_INDEX=米国指数オプション（米国市場のみ対応）) sort_type|[ZeroDteSortType](./quote.md#2185)|ソートタイプ (VOLUME=オプション出来高、IV=インプライドボラティリティ、CHANGE_RATIO=騰落率、OPEN_INTEREST=建玉、MARKET_CAP=時価総額) is_asc|bool|昇順かどうか (デフォルト False（降順）) count|int|ページあたりの数量 (範囲 [1,500]、デフォルト 50) page|str|ページングカーソル (初回は空または未指定、ページングは next_page を渡す) filter_list|list[ZeroDteFilter]|フィルタ条件リスト (複数条件は AND 関係。OWNER_LIST、HAS_EARNINGS_THIS_WEEK、VOLUME、OPEN_INTEREST、IV、HV、IV_RANK、IV_PERCENTILE、PRICE、CHANGE_RATIO に対応) * **戻り値**
パラメータ 型 説明
ret RET_CODE インターフェース呼び出し結果
data dict ret == RET_OK の場合、辞書を返す。item_list（DataFrame）、next_page（str/None）、update_timestamp（float）を含む
str ret != RET_OK の場合、エラー説明を返す
* 戻り DataFrame フィールド： フィールド|型|説明 :-|:-|:- owner|str|原資産銘柄コード name|str|原資産名称 price|float|原資産現在価格 change_ratio|float|騰落率（パーセント） market_cap|float|時価総額 iv|float|インプライドボラティリティ（パーセント） iv_rank|float|IV ランク（パーセント） iv_percentile|float|IV パーセンタイル（パーセント） hv|float|ヒストリカルボラティリティ（パーセント） volume|int|オプション出来高 open_interest|int|オプション建玉 last_trading_time|int|最終取引タイムスタンプ（Unix 秒） earnings_timestamp|int|決算日タイムスタンプ（秒） earnings_time|str|決算日時間文字列 earnings_pub_type|str|決算発表タイプ（BEFORE/AFTER） chain_info|dict|オプションチェーン情報 (get_option_zero_dte_contract 呼び出し用) * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_option_zero_dte_screener( market=OptionMarket.US_SECURITY, sort_type=ZeroDteSortType.VOLUME, is_asc=False, count=5 ) if ret == RET_OK: print(data['item_list']) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` owner name price change_ratio market_cap iv iv_rank iv_percentile hv volume open_interest last_trading_time earnings_timestamp earnings_time earnings_pub_type chain_info 0 US.SPY 标普500ETF-SPDR 741.75 0.540 7.830717e+11 17.675 27.143 61.111 15.031 14228830 19909256 1781554500 N/A N/A N/A {'strike_date_timestamp': 1781499600, 'product_code': 'SPY', 'multiplier': 100.0, ...} 1 US.QQQ 纳指100ETF-Invesco QQQ Trust 721.34 0.588 4.805349e+11 27.652 62.918 91.269 26.196 8239190 12964422 1781554500 N/A N/A N/A {'strike_date_timestamp': 1781499600, 'product_code': 'QQQ', 'multiplier': 100.0, ...} 2 US.TSLA 特斯拉 406.43 1.823 1.526439e+12 55.053 39.265 64.285 49.359 3623504 7088459 1781553600 N/A N/A N/A {'strike_date_timestamp': 1781499600, 'product_code': 'TSLA', 'multiplier': 100.0, ...} 3 US.NVDA 英伟达 205.19 0.156 4.965598e+12 41.975 27.062 42.460 45.921 3157331 16744961 1781553600 N/A N/A N/A {'strike_date_timestamp': 1781499600, 'product_code': 'NVDA', 'multiplier': 100.0, ...} 4 US.IWM 罗素2000ETF-iShares 292.95 0.874 8.143528e+10 24.857 33.930 64.285 24.802 2840729 11791964 1781554500 N/A N/A N/A {'strike_date_timestamp': 1781499600, 'product_code': 'IWM', 'multiplier': 100.0, ...} ``` :::tip インターフェース制限 * 30秒以内に最大60回のゼロDTEオプションスクリーナーインターフェースリクエスト（ページング対応のインターフェースは初回呼び出しのみカウント） ::: --- # ゼロDTEオプション契約一覧 `get_option_zero_dte_contract(owner, strike_date_timestamp, chain_info, sort_type=None, is_asc=None, filter_list=None)` * **説明** ゼロDTEオプション契約一覧を取得します。指定原資産の指定行使日における 0DTE オプション契約詳細を返し、グリークス、損益分岐点および利益確率等のデータを含みます。 * **パラメータ** パラメータ|型|説明 :-|:-|:- owner|str|原資産銘柄コード (例：'US.AAPL'、米国株式のみ対応) strike_date_timestamp|int|行使日タイムスタンプ（Unix 秒） chain_info|dict|オプションチェーン情報 (get_option_zero_dte_screener が返す chain_info) sort_type|[ZeroDteContractSortType](./quote.md#6053)|ソートタイプ (VOLUME=出来高、OPEN_INTEREST=建玉、IV=インプライドボラティリティ、DELTA=Delta) is_asc|bool|昇順かどうか (デフォルト False（降順）) filter_list|list[ZeroDteContractFilter]|フィルタ条件リスト (複数条件は AND 関係。OPTION_TYPE、VOLUME、OPEN_INTEREST、IV、DELTA、GAMMA、THETA、VEGA、RHO、PRICE、CHANGE_RATIO、BREAK_EVEN_POINT、TO_BEP、BUY_PROFIT_PROBABILITY、SELL_PROFIT_PROBABILITY に対応) * **戻り値**
パラメータ 型 説明
ret RET_CODE インターフェース呼び出し結果
data pandas.DataFrame ret == RET_OK の場合、契約一覧を返す
str ret != RET_OK の場合、エラー説明を返す
* 戻り DataFrame フィールド： フィールド|型|説明 :-|:-|:- option|str|オプション契約コード name|str|契約名称 option_type|str|オプションタイプ（CALL/PUT） option_price|float|オプション価格 change_ratio|float|騰落率（パーセント） volume|int|出来高 open_interest|int|建玉 iv|float|インプライドボラティリティ（パーセント） delta|float|Delta gamma|float|Gamma vega|float|Vega theta|float|Theta rho|float|Rho buy_break_even_point|float|買い損益分岐点 buy_to_bep|float|損益分岐点到達に必要な騰落率（パーセント） buy_profit_probability|float|買い利益確率（パーセント） sell_profit_probability|float|売り利益確率（パーセント） * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) # 第一步：获取末日期权标的列表 ret, screener_data = quote_ctx.get_option_zero_dte_screener( market=OptionMarket.US_SECURITY, sort_type=ZeroDteSortType.VOLUME, is_asc=False, count=1 ) if ret != RET_OK: print('error:', screener_data) quote_ctx.close() exit() # 第二步：取第一个标的的 chain_info，查询其合约列表 df = screener_data['item_list'] owner = df.iloc[0]['owner'] chain_info = df.iloc[0]['chain_info'] strike_date_timestamp = chain_info['strike_date_timestamp'] ret, data = quote_ctx.get_option_zero_dte_contract( owner=owner, strike_date_timestamp=strike_date_timestamp, chain_info=chain_info, sort_type=ZeroDteContractSortType.VOLUME, is_asc=False ) if ret == RET_OK: print(data) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` option name option_type option_price change_ratio volume open_interest iv delta gamma vega theta rho buy_break_even_point buy_to_bep buy_profit_probability sell_profit_probability 0 US.SPY260612C742000 SPY 260612 C742 CALL 0.58 -67.688 730160 7449 146.5 0.4367 0.2745 0.0039 -455.46 0.000 742.58 0.11 43.5 56.5 1 US.SPY260612C745000 SPY 260612 C745 CALL 0.01 -98.958 617981 17013 87.1 0.0244 0.0350 0.0011 -18.52 0.000 745.01 0.44 2.4 97.6 ... ``` :::tip インターフェース制限 * 30秒以内に最大60回のゼロDTEオプション契約一覧インターフェースリクエスト ::: --- # 決算オプションスクリーナー `get_option_earnings_screener(market, sort_type=None, is_asc=None, count=None, page=None, filter_list=None)` * **説明** 決算発表予定のオプション原資産リストを取得します。原資産のボラティリティデータ、過去の決算 IV Crush、株価変動および市場予想等の情報を返し、決算シーズンのオプション取引判断を支援します。 * **パラメータ** パラメータ|型|説明 :-|:-|:- market|[OptionMarket](./quote.md#9106)|オプション市場タイプ (US_SECURITY=米国株式オプション、HK_SECURITY=香港株式オプション) sort_type|[EarningsSortType](./quote.md#3014)|ソートタイプ (EARNINGS_DATE=決算日（デフォルト）、VOLUME=オプション出来高、IV=インプライドボラティリティ、MARKET_CAP=時価総額、CHANGE_RATIO=騰落率、PRICE=最新価格、IV_RANK=IVランク、IV_PERCENTILE=IVパーセンタイル、HV=ヒストリカルボラティリティ、OPEN_INTEREST=建玉、LAST_REPORT_IV_CRUSH=前回IV Crush、HISTORY_REPORT_IV_CRUSH=過去IV Crush、LAST_REPORT_CHG_RATIO=前回決算日騰落率、HISTORY_REPORT_CHG_RATIO=過去決算日騰落率、ESTIMATE_EPS_YOY=予測EPS前年比、ESTIMATE_REVENUE_YOY=予測売上前年比、EXPECTED_MOVE_RATIO=予測変動幅) is_asc|bool|昇順かどうか (デフォルト True) count|int|ページあたりの数量 (範囲 [1,500]、デフォルト 50) page|str|ページングカーソル (初回は空または未指定、ページングは next_page を渡す) filter_list|list[EarningsFilter]|フィルタ条件リスト (複数条件は AND 関係) * **戻り値**
パラメータ 型 説明
ret RET_CODE インターフェース呼び出し結果
data dict ret == RET_OK の場合、辞書を返す。item_list（DataFrame）、next_page（str）、update_timestamp（float）、all_count（int）を含む
str ret != RET_OK の場合、エラー説明を返す
* 戻り DataFrame フィールド： フィールド|型|説明 :-|:-|:- owner|str|原資産銘柄コード name|str|原資産名称 price|float|原資産現在価格 change_ratio|float|騰落率（小数） market_cap|float|時価総額 iv|float|インプライドボラティリティ（パーセント） iv_rank|float|IV ランク（パーセント） iv_percentile|float|IV パーセンタイル（パーセント） hv|float|ヒストリカルボラティリティ（パーセント） volume|int|オプション出来高 open_interest|int|オプション建玉 earnings_timestamp|float|決算日タイムスタンプ（Unix 秒） earnings_time|str|決算日文字列（yyyy-MM-dd） earnings_pub_type|str|決算発表タイプ（BEFORE=プレマーケット/AFTER=アフターマーケット） earnings_quarter|str|決算四半期（例：'2025Q1'） last_report_iv_crush|float|前回決算 IV Crush（パーセント） history_report_iv_crush|float|過去平均決算 IV Crush（パーセント） last_report_chg_ratio|float|前回決算後株価変動（小数） history_report_chg_ratio|float|過去平均決算後株価変動（小数） estimate_eps_yoy|float|予測 EPS 前年比成長率（パーセント） estimate_revenue_yoy|float|予測売上前年比成長率（パーセント） expected_move_ratio|float|オプション暗示予測変動幅（パーセント） * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_option_earnings_screener( market=OptionMarket.US_SECURITY, count=5 ) if ret == RET_OK: print(data['item_list']) print('all_count:', data['all_count']) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` owner name price change_ratio market_cap iv iv_rank iv_percentile hv volume open_interest earnings_timestamp earnings_time earnings_pub_type earnings_quarter last_report_iv_crush history_report_iv_crush last_report_chg_ratio history_report_chg_ratio estimate_eps_yoy estimate_revenue_yoy expected_move_ratio 0 US.CGC Canopy Growth 1.00 -0.990 4.220190e+08 204.207 36.550 88.492 39.545 8131 328382 1.781496e+09 2026-06-15 BEFORE 2026Q4 -21.308 11.782 1.851 12.761 94.055 14.340 12.500 1 US.PLAY Dave & Buster's Entertainment 12.93 -1.896 4.491805e+08 114.030 99.492 99.603 62.390 3052 44247 1.781496e+09 2026-06-15 AFTER 2027Q1 22.640 26.059 16.066 15.892 -3.758 1.881 15.409 2 US.DOMO Domo Inc 3.02 2.027 1.363547e+08 165.563 72.093 96.825 90.389 1970 29748 1.781496e+09 2026-06-15 AFTER 2027Q1 23.532 30.013 13.470 19.203 9.622 -0.451 30.629 3 US.CMTL Comverse 4.83 5.228 1.436158e+08 388.934 81.297 98.412 106.150 218 13434 1.781496e+09 2026-06-15 BEFORE 2026Q3 154.978 51.309 -24.536 16.278 -10.204 -13.078 23.809 4 US.RFIL RF Industries 18.75 0.969 2.027675e+08 100.939 11.123 54.365 83.526 215 2044 1.781496e+09 2026-06-15 AFTER 2026Q2 -14.722 6.537 12.318 12.013 200.000 3.997 15.466 all_count: 292 ``` :::tip インターフェース制限 * 30秒以内に最大60回の決算オプションスクリーナーインターフェースリクエスト（ページング対応のインターフェースは初回呼び出しのみカウント） ::: --- # オプション売り手スクリーナー `get_option_seller_screener(market, seller_type, sort_type=None, is_asc=None, filter_list=None)` * **説明** オプション売り手スクリーニングリストを取得します。売り手戦略（Cash Secured Put / Covered Call）に適したオプション契約を返し、収益率、行使確率等のデータを含みます。 * **パラメータ** パラメータ|型|説明 :-|:-|:- market|[OptionMarket](./quote.md#9106)|オプション市場タイプ (US_SECURITY=米国株式オプション、HK_SECURITY=香港株式オプション) seller_type|[SellerType](./quote.md#286)|売り手戦略タイプ (COVERED_CALL=カバードコール、CASH_SECURED_PUT=キャッシュセキュアードプット（香港市場は CASH_SECURED_PUT のみ対応）) sort_type|[SellerSortType](./quote.md#7756)|ソートタイプ (ANNUALIZED_RETURN=年率換算収益率、INTERVAL_RETURN=期間収益率、ITM_PROBABILITY=行使確率、PREMIUM=プレミアム) is_asc|bool|昇順かどうか (デフォルト False（降順）) filter_list|list[SellerFilter]|フィルタ条件リスト (複数条件は AND 関係) * **戻り値**
パラメータ 型 説明
ret RET_CODE インターフェース呼び出し結果
data pandas.DataFrame ret == RET_OK の場合、スクリーニング結果を返す
str ret != RET_OK の場合、エラー説明を返す
* 戻り DataFrame フィールド： フィールド|型|説明 :-|:-|:- option|str|オプション契約コード name|str|オプション名称 option_type|str|オプション方向 (CALL、PUT) strike_price|float|行使価格 strike_time|str|満期日時間文字列 strike_timestamp|float|満期日タイムスタンプ（Unix 秒） left_days|int|残存日数 option_price|float|オプション価格 stock_price|float|原資産株価 premium|float|プレミアム otm_degree|float|アウトオブザマネー度（%） iv|float|インプライドボラティリティ（%） interval_return|float|期間収益率（%） annualized_return|float|年率換算収益率（%） itm_probability|float|行使確率（%） striked_interval_return|float|行使時期間収益率（%） (Covered Call のみ) striked_annualized_return|float|行使時年率換算収益率（%） (Covered Call のみ) owner|str|原資産株式コード * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_option_seller_screener( market=OptionMarket.US_SECURITY, seller_type=SellerType.COVERED_CALL, sort_type=SellerSortType.ANNUALIZED_RETURN, is_asc=False ) if ret == RET_OK: print(data) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` option name option_type strike_price strike_time strike_timestamp left_days option_price stock_price premium otm_degree iv interval_return annualized_return itm_probability striked_interval_return striked_annualized_return owner 0 US.SOXL260618C235000 SOXL 260618 235.00C CALL 235.0 2026-06-18 1.781755e+09 3 21.850 234.68 2185.0 0.136 234.988 10.266 1074.855 45.724 10.416 1090.597 US.SOXL 1 US.SOXL260618C237500 SOXL 260618 237.50C CALL 237.5 2026-06-18 1.781755e+09 3 20.675 234.68 2067.5 1.201 234.423 9.660 1011.470 43.682 10.978 1149.431 US.SOXL 2 US.SOXL260618C240000 SOXL 260618 240.00C CALL 240.0 2026-06-18 1.781755e+09 3 19.250 234.68 1925.0 2.266 230.652 8.935 935.526 41.678 11.405 1194.071 US.SOXL 3 US.WDS260618C25000 WDS 260618 25.00C CALL 25.0 2026-06-18 1.781755e+09 3 1.875 23.07 187.5 8.365 292.148 8.846 928.963 11.794 17.952 1885.177 US.WDS 4 US.SOXL260618C242500 SOXL 260618 242.50C CALL 242.5 2026-06-18 1.781755e+09 3 18.350 234.68 1835.0 3.332 232.108 8.482 888.077 39.715 12.097 1266.538 US.SOXL ... ``` :::tip インターフェース制限 * 30秒以内に最大60回のオプション売り手スクリーナーインターフェースリクエスト ::: --- # ワラントのフィルタ `get_warrant(stock_owner='', req=None)` * **概要** ワラントのフィルタ（香港市場のワラント、CBBC、インラインワラントのフィルタ専用） * **パラメータ** パラメータ|型|説明 :-|:-|:- stock_owner|str|原資産の銘柄コード req|WarrantRequest|フィルタパラメータの組み合わせ * WarrantRequest タイプのフィールド説明： フィールド|タイプ|説明 :-|:-|:- begin|int|データ開始位置 num|int|リクエストデータ件数 (最大200) sort_field|[SortField](./quote.md#3508)|ソートフィールド ascend|bool|ソート方向 (True：昇順False：降順) type_list|list|ワラントタイプフィルタリスト (list内の要素タイプは [WrtType](./quote.md#3508)) issuer_list|list|発行体フィルタリスト (list内の要素タイプは [Issuer](./quote.md#1608)) maturity_time_min|str|満期日フィルタ範囲の開始時刻 maturity_time_max|str|満期日フィルタ範囲の終了時刻 ipo_period|[IpoPeriod](./quote.md#6681)|上場期間 price_type|[PriceType](./quote.md#6940)|イン・ザ・マネー/アウト・オブ・ザ・マネー (インラインワラントのインライン/アウトラインフィルタには対応していません) status|[WarrantStatus](./quote.md#5877)|ワラントステータス cur_price_min|float|最新値のフィルタ下限 (閉区間未指定の場合、下限は -∞小数点以下3桁まで、超過分は切り捨てられます) cur_price_max|float|最新値のフィルタ上限 (閉区間未指定の場合、上限は +∞小数点以下3桁まで、超過分は切り捨てられます) strike_price_min|float|行使価格のフィルタ下限 (閉区間未指定の場合、下限は -∞小数点以下3桁まで、超過分は切り捨てられます) strike_price_max|float|行使価格のフィルタ上限 (閉区間未指定の場合、上限は +∞小数点以下3桁まで、超過分は切り捨てられます) street_min|float|ストリート在庫比率のフィルタ下限 (閉区間未指定の場合、下限は -∞パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します。小数点以下3桁まで、超過分は切り捨てられます) street_max|float|ストリート在庫比率のフィルタ上限 (閉区間未指定の場合、上限は +∞パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します。小数点以下3桁まで、超過分は切り捨てられます) conversion_min|float|転換比率のフィルタ下限 (閉区間未指定の場合、下限は -∞小数点以下3桁まで、超過分は切り捨てられます) conversion_max|float|転換比率のフィルタ上限 (閉区間未指定の場合、上限は +∞小数点以下3桁まで、超過分は切り捨てられます) vol_min|int|出来高のフィルタ下限 (閉区間未指定の場合、下限は -∞) vol_max|int|出来高のフィルタ上限 (閉区間未指定の場合、上限は +∞) premium_min|float|プレミアムのフィルタ下限 (閉区間未指定の場合、下限は -∞パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します。小数点以下3桁まで、超過分は切り捨てられます) premium_max|float|プレミアムのフィルタ上限 (閉区間未指定の場合、上限は +∞パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します。小数点以下3桁まで、超過分は切り捨てられます) leverage_ratio_min|float|レバレッジ比率のフィルタ下限 (閉区間未指定の場合、下限は -∞小数点以下3桁まで、超過分は切り捨てられます) leverage_ratio_max|float|レバレッジ比率のフィルタ上限 (閉区間未指定の場合、上限は +∞) delta_min|float|デルタ値のフィルタ下限 (閉区間コール・プットのみこのフィールドでフィルタ可能未指定の場合、下限は -∞小数点以下3桁まで、超過分は切り捨てられます) delta_max|float|デルタ値のフィルタ上限 (閉区間コール・プットのみこのフィールドでフィルタ可能未指定の場合、上限は +∞小数点以下3桁まで、超過分は切り捨てられます) implied_min|float|インプライドボラティリティのフィルタ下限 (閉区間コール・プットのみこのフィールドでフィルタ可能未指定の場合、下限は -∞小数点以下3桁まで、超過分は切り捨てられます) implied_max|float|インプライドボラティリティのフィルタ上限 (閉区間コール・プットのみこのフィールドでフィルタ可能未指定の場合、上限は +∞小数点以下3桁まで、超過分は切り捨てられます) recovery_price_min|float|回収価格のフィルタ下限 (閉区間CBBCのみこのフィールドでフィルタ可能未指定の場合、下限は -∞小数点以下3桁まで、超過分は切り捨てられます) recovery_price_max|float|回収価格のフィルタ上限 (閉区間CBBCのみこのフィールドでフィルタ可能未指定の場合、上限は +∞小数点以下3桁まで、超過分は切り捨てられます) price_recovery_ratio_min|float|原資産から回収価格までの距離のフィルタ下限 (閉区間CBBCのみこのフィールドでフィルタ可能パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します未指定の場合、下限は -∞小数点以下3桁まで、超過分は切り捨てられます) price_recovery_ratio_max|float|原資産から回収価格までの距離のフィルタ上限 (閉区間CBBCのみこのフィールドでフィルタ可能パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します未指定の場合、上限は +∞小数点以下3桁まで、超過分は切り捨てられます) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data tuple ret == RET_OK の場合、ワラントデータを返します
str ret != RET_OK の場合、エラーの説明を返す
* ワラントデータの構成： フィールド|タイプ|説明 :-|:-|:- warrant_data_list|pd.DataFrame|フィルタ後のワラントデータ last_page|bool|最終ページかどうか (True：最終ページFalse：最終ページではない) all_count|int|フィルタ結果のワラント総数 - warrant_data_list が返す pd dataframe のデータフォーマット： フィールド|タイプ|説明 :-|:-|:- stock|str|ワラントコード stock_owner|str|原資産銘柄 type|[WrtType](./quote.md#3508)|ワラントタイプ issuer|[Issuer](./quote.md#1608)|発行体 maturity_time|str|満期日 (フォーマット：yyyy-MM-dd) list_time|str|上場日 (フォーマット：yyyy-MM-dd) last_trade_time|str|最終取引日 (フォーマット：yyyy-MM-dd) recovery_price|float|回収価格 (CBBCのみ対応) conversion_ratio|float|転換比率 lot_size|int|1ロットあたりの数量 strike_price|float|行使価格 last_close_price|float|前日終値 name|str|名前 cur_price|float|現在値 price_change_val|float|騰落額 status|[WarrantStatus](./quote.md#5877)|ワラントステータス bid_price|float|買値 ask_price|float|売値 bid_vol|int|買い数量 ask_vol|int|売り数量 volume|int|出来高 turnover|float|売買代金 score|float|総合スコア premium|float|プレミアム (パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します) break_even_point|float|損益分岐点 leverage|float|レバレッジ比率 (単位：倍) ipop|float|イン・ザ・マネー/アウト・オブ・ザ・マネー (パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します) price_recovery_ratio|float|原資産から回収価格までの距離 (CBBCのみ対応パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します) conversion_price|float|転換価格 street_rate|float|ストリート在庫比率 (パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します) street_vol|int|ストリート在庫数量 amplitude|float|振幅 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) issue_size|int|発行量 high_price|float|高値 low_price|float|安値 implied_volatility|float|インプライドボラティリティ (コール・プットのみ対応) delta|float|デルタ値 (コール・プットのみ対応) effective_leverage|float|実効レバレッジ upper_strike_price|float|上限価格 (インラインワラントのみ対応) lower_strike_price|float|下限価格 (インラインワラントのみ対応) inline_price_status|[PriceType](./quote.md#6940)|インライン/アウトライン (インラインワラントのみ対応) * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) req = WarrantRequest() req.sort_field = SortField.TURNOVER req.type_list = WrtType.CALL req.cur_price_min = 0.1 req.cur_price_max = 0.2 ret, ls = quote_ctx.get_warrant("HK.00700", req) if ret == RET_OK: # 先にAPIの戻り値が正常かを判定してからデータを取得 warrant_data_list, last_page, all_count = ls print(len(warrant_data_list), all_count, warrant_data_list) print(warrant_data_list['stock'][0]) # 1件目のワラントコードを取得 print(warrant_data_list['stock'].values.tolist()) # list に変換 else: print('error: ', ls) req = WarrantRequest() req.sort_field = SortField.TURNOVER req.issuer_list = ['UB','CS','BI'] ret, ls = quote_ctx.get_warrant(Market.HK, req) if ret == RET_OK: warrant_data_list, last_page, all_count = ls print(len(warrant_data_list), all_count, warrant_data_list) else: print('error: ', ls) quote_ctx.close() # 全APIの最後にcloseを追加し、接続数の枯渇を防止 ``` * **Output** ```python 2 2 stock name stock_owner type issuer maturity_time list_time last_trade_time recovery_price conversion_ratio lot_size strike_price last_close_price cur_price price_change_val change_rate status bid_price ask_price bid_vol ask_vol volume turnover score premium break_even_point leverage ipop price_recovery_ratio conversion_price street_rate street_vol amplitude issue_size high_price low_price implied_volatility delta effective_leverage list_timestamp last_trade_timestamp maturity_timestamp upper_strike_price lower_strike_price inline_price_status 0 HK.20306 腾讯麦银零乙购A.C HK.00700 CALL MB 2020-12-01 2019-06-27 2020-11-25 NaN 50.0 5000 588.88 0.188 0.188 0.000 0.000000 NORMAL 0.000 0.188 0 10000 0 0.0 0.198 2.008 598.28 62.393 -0.404 NaN 9.40 4.400 1584000 0.000 36000000 0.000 0.000 31.751 0.479 29.886 1.561565e+09 1.606234e+09 1.606752e+09 NaN NaN NaN 1 HK.16545 腾讯法兴一二购B.C HK.00700 CALL SG 2021-02-26 2020-07-14 2021-02-22 NaN 100.0 10000 700.00 0.147 0.144 -0.003 -2.040816 NORMAL 0.141 0.144 28000000 28000000 0 0.0 81.506 21.807 714.40 40.729 -16.214 NaN 14.40 1.420 2130000 0.000 150000000 0.000 0.000 40.643 0.226 9.204 1.594656e+09 1.613923e+09 1.614269e+09 NaN NaN NaN HK.20306 ['HK.20306', 'HK.16545'] 200 358 stock name stock_owner type issuer maturity_time list_time last_trade_time recovery_price conversion_ratio lot_size strike_price last_close_price cur_price price_change_val change_rate status bid_price ask_price bid_vol ask_vol volume turnover score premium break_even_point leverage ipop price_recovery_ratio conversion_price street_rate street_vol amplitude issue_size high_price low_price implied_volatility delta effective_leverage list_timestamp last_trade_timestamp maturity_timestamp upper_strike_price lower_strike_price inline_price_status 0 HK.19839 平安瑞银零乙购A.C HK.02318 CALL UB 2020-12-31 2017-12-11 2020-12-24 NaN 100.0 50000 83.88 0.057 0.046 -0.011 -19.298246 NORMAL 0.043 0.046 30000000 30000000 0 0.0 39.641 1.642 88.480 18.923 3.779 NaN 4.600 1.25 6250000 0.0 500000000 0.0 0.0 25.129 0.692 13.094 1.512922e+09 1.608739e+09 1.609344e+09 NaN NaN NaN 1 HK.20084 平安中银零乙购A.C HK.02318 CALL BI 2020-12-31 2017-12-19 2020-12-24 NaN 100.0 50000 83.88 0.059 0.050 -0.009 -15.254237 NORMAL 0.044 0.050 10000000 10000000 0 0.0 0.064 2.102 88.880 17.410 3.779 NaN 5.000 0.07 350000 0.0 500000000 0.0 0.0 29.174 0.672 11.699 1.513613e+09 1.608739e+09 1.609344e+09 NaN NaN NaN ...... 198 HK.56886 恒指瑞银三一牛F.C HK.800000 BULL UB 2023-01-30 2020-03-24 2023-01-27 21200.0 20000.0 10000 21100.00 0.230 0.232 0.002 0.869565 NORMAL 0.232 0.233 30000000 30000000 0 0.0 46.627 -2.884 25740.000 5.712 25.613 25.021179 4640.000 0.01 40000 0.0 400000000 0.0 0.0 NaN NaN 5.712 1.584979e+09 1.674749e+09 1.675008e+09 NaN NaN NaN 199 HK.56895 小米瑞银零乙牛D.C HK.01810 BULL UB 2020-12-30 2020-03-24 2020-12-29 8.0 10.0 2000 7.60 2.010 1.930 -0.080 -3.980100 NORMAL 1.910 1.930 6000000 6000000 0 0.0 0.040 0.938 26.900 1.380 250.657 233.125000 19.300 0.10 60000 0.0 60000000 0.0 0.0 NaN NaN 1.380 1.584979e+09 1.609171e+09 1.609258e+09 NaN NaN NaN ``` --- # ワラントスクリーニング V2 `get_warrant_screen(request)` * **説明** ワラントスクリーニング V2。旧 API [get_warrant](./get-warrant.md) と比較して、45 列のワラント属性を返却し、香港 / シンガポール / マレーシア市場をサポートします。総数のみ返却（only_count）にも対応。すべての数値フィールドは原始値を直接渡し、OpenD 内部で倍率変換を行います。 * **パラメータ** パラメータ|タイプ|説明 :-|:-|:- request|WarrantScreenRequest|ワラントスクリーニングリクエストオブジェクト、構築時に warrant_market 必須 * WarrantScreenRequest フィールド： フィールド|タイプ|説明 :-|:-|:- warrant_market|[WarrantMarket](./quote.md#1724)|市場 (HK=1、SG=4、MY=15) is_delay|bool|遅延相場を使用するか (デフォルトは False) only_count|bool|総数のみ返却するか（明細を返さない） (デフォルトは False；True の場合は all_count のみ埋まり、DataFrame は空) page_from|int|ページング開始位置 (デフォルトは 0) page_count|int|1 ページあたりの最大返却件数 (デフォルトは 200) * フィルタ条件 builder メソッド（呼び出すごとにフィルタ条件を 1 件追加）： メソッド|説明 :-|:- add_interval_filter(field_id, min_val=None, max_val=None, min_included=True, max_included=True)|区間フィルタ (field_id は [WarrantField](./quote.md#9880) から取得；min_val / max_val は原始値を直接渡す（OpenD が自動的に倍率変換、例えば現在値 5 元は 5.0、ストリート比率 50% は 50.0、実効レバレッジ > 3 は 3.0）。min_val / max_val はいずれも任意、両方とも未指定の場合この条件は無効（フィルタ未適用と同じ）) add_choice_filter(field_id, choices)|選択肢フィルタ (choices の要素は int 列挙または str コード可、例えば STOCK_OWNER フィールドには ["HK.00700"]、WARRANT_TYPE には [WarrantType.CALL, WarrantType.PUT] を渡せる) add_sort(field_id, desc=False)|ソート (desc=True で降順、デフォルト昇順) * よく使う WarrantField field_id（完全なリストは [WarrantField](./quote.md#9880) を参照）： field_id|意味|フィルタ方式 :-|:-|:- 4|ISSUER_ID 発行体 ID|choice 5|STOCK_OWNER 原株|choice (["HK.00700"] のような code 文字列を渡せる) 6|WARRANT_TYPE ワラントタイプ|choice (1=コール、2=プット、3=ブル証、4=ベア証、5=インライン証；詳細は [WarrantType](./quote.md#1724)) 8|CURRENT_PRICE 現在値|interval 9|STREET_RATIO ストリート比率|interval 10|VOLUME 出来高|interval 16|LEVERAGE_RATIO レバレッジ比率|interval 19|STATUS ステータス|choice (0=正常、1=取引終了、2=上場待ち；詳細は [WarrantStatus](./quote.md#1724)) 23|EFFECTIVE_LEVERAGE 実効レバレッジ|interval * **戻り値**
パラメータ タイプ 説明
ret RET_CODE API 呼び出し結果
data tuple ret == RET_OK のとき、(last_page, all_count, DataFrame) を返す
str ret != RET_OK のとき、エラー記述を返す
* 戻り値 DataFrame フィールド（計 45 列）： フィールド|タイプ|説明 :-|:-|:- issuer_id|int|発行体 ID warrant_type|int|ワラントタイプ (1=コール、2=プット、3=ブル証、4=ベア証、5=インライン証) strike_price|float|権利行使価格 maturity_date|str|満期日 last_trade_date|str|最終取引日 conversion_ratio|float|転換比率 last_close_price|float|前日終値 recovery_price|float|コールバック価格（ブル/ベア証のみ） stock_owner_price|float|原株価格 current_price|float|現在値 volume|int|出来高 turnover|float|売買代金 sell_vol|int|売り数量 buy_vol|int|買い数量 sell_price|float|売り気配値 buy_price|float|買い気配値 street_rate|float|ストリート比率 high_price|float|高値 low_price|float|安値 implied_volatility|float|インプライド・ボラティリティ（コール/プットのみ） delta|float|ヘッジ値（コール/プットのみ） status|int|ワラントステータス (0=正常、1=取引終了、2=上場待ち) street_rate_new|float|ストリート比率（新） score|float|総合スコア premium|float|プレミアム leverage|float|レバレッジ effective_leverage|float|実効レバレッジ break_even_point|float|損益分岐点 ipop|float|イン・ザ・マネー/アウト・オブ・ザ・マネー amplitude|float|振幅 fx_score|float|ソシエテ・ジェネラルスコア ipo_time|str|上場日時 street_vol|int|ストリート出来高 lot_size|int|単元株数 issue_size|int|発行量 ipo_price|float|発行価格 upper_strike_price|float|上限価格（インライン証のみ） lower_strike_price|float|下限価格（インライン証のみ） iw_price_status|int|インライン/アウトオブライン sensitivity|float|感応度 price_recovery_ratio|float|原株からコールバック価格までの距離（ブル/ベア証のみ） code|str|market プレフィックス付きワラントコード（例：HK.10001）、OpenD が銘柄を引いて補完 owner_code|str|market プレフィックス付き原株コード（例：HK.00700） name|str|ワラント名 owner_name|str|原株名 * **Example** ```python from moomoo import ( OpenQuoteContext, RET_OK, WarrantScreenRequest, WarrantMarket, WarrantField, WarrantType, ) quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) # 例 1：香港株の低価格・高レバレッジコール / プット req = WarrantScreenRequest(warrant_market=WarrantMarket.HK) req.add_choice_filter(field_id=WarrantField.WARRANT_TYPE, choices=[WarrantType.CALL, WarrantType.PUT]) # コール + プット req.add_interval_filter(field_id=WarrantField.CURRENT_PRICE, min_val=0.1, max_val=5.0) # 現在値 0.1~5 req.add_interval_filter(field_id=WarrantField.EFFECTIVE_LEVERAGE, min_val=3.0) # 実効レバレッジ > 3 req.add_interval_filter(field_id=WarrantField.STREET_RATIO, max_val=50.0) # ストリート比率 < 50% req.add_sort(field_id=WarrantField.VOLUME, desc=True) # 出来高降順 req.page_count = 20 ret, data = quote_ctx.get_warrant_screen(req) if ret == RET_OK: last_page, all_count, df = data print(df[['code', 'warrant_type', 'current_price', 'effective_leverage']].head()) else: print('error: ', data) # 例 2：条件を満たす総数のみを取得 req = WarrantScreenRequest(warrant_market=WarrantMarket.HK) req.only_count = True req.add_choice_filter(field_id=WarrantField.WARRANT_TYPE, choices=[WarrantType.CALL]) req.add_interval_filter(field_id=WarrantField.CURRENT_PRICE, min_val=1.0) ret, data = quote_ctx.get_warrant_screen(req) if ret == RET_OK: _, all_count, _ = data print(f"条件を満たすコールの総数：{all_count}") # 例 3：原株コードでフィルタ（choice に code 文字列を直接渡す） req = WarrantScreenRequest(warrant_market=WarrantMarket.HK) req.add_choice_filter(field_id=WarrantField.STOCK_OWNER, choices=["HK.00700"]) req.add_choice_filter(field_id=WarrantField.WARRANT_TYPE, choices=[WarrantType.BULL, WarrantType.BEAR]) # ブル証 + ベア証 req.add_sort(field_id=WarrantField.TURNOVER, desc=True) req.page_count = 50 ret, data = quote_ctx.get_warrant_screen(req) if ret == RET_OK: _, all_count, df = data print(f"テンセント牛熊権の総数：{all_count}") print(df[['code', 'name', 'warrant_type', 'turnover']].head()) quote_ctx.close() ``` * **Output** ```python code warrant_type current_price effective_leverage 0 HK.29080 1 0.117 7.070 1 HK.28957 1 0.110 8.021 2 HK.28545 1 0.106 6.807 3 HK.29526 1 0.118 4.337 4 HK.13637 1 0.212 5.896 条件を満たすコールの総数：197 テンセント牛熊権の総数：393 code name warrant_type turnover 0 HK.57161 腾讯法兴六乙牛X.C 3 10149350.0 1 HK.54908 腾讯法兴六乙牛R.C 3 9797800.0 2 HK.55573 腾讯华泰六十牛C.C 3 4227400.0 3 HK.53663 腾讯法兴六乙牛N.C 3 3504625.0 4 HK.68433 腾讯法兴六乙牛M.C 3 3018900.0 ``` * **フィールド別例** > 以下の例はすべて `req = WarrantScreenRequest(warrant_market=WarrantMarket.HK)` を構築済みとします； > 実測返却は OpenD HK 市場サンプルデータで、当該フィールドに対応する `all_count` と DataFrame head（数値は SDK で自動倍率変換済み）を示します。 ##### `CODE`（id=1 · choice · HK · リターン列なし） 証券コード (テキスト) 市場プレフィックス付きの code 文字列の配列を渡す（例: `"HK.57161"`）。SDK が自動でプレフィックスを取り除きます；完全一致のみヒット ```python req.add_choice_filter(WarrantField.CODE, ["HK.57161", "HK.54908", "HK.55573"]) ``` 実測返却（HK · all_count=3、ヒット 3 行）： ``` code name owner_code owner_name warrant_type current_price 0 HK.54908 腾讯法兴六乙牛R.C HK.00700 腾讯控股 3 0.066 1 HK.55573 腾讯华泰六十牛C.C HK.00700 腾讯控股 3 0.080 2 HK.57161 腾讯法兴六乙牛X.C HK.00700 腾讯控股 3 0.044 ``` ##### `NAME`（id=2 · choice/sort · HK · リターン列なし） 証券名 (テキスト) テキストフィールド、sort のみ適合；choice は名称文字列を渡す ```python req.add_sort(WarrantField.NAME, desc=False) ``` 実測返却（HK · all_count=16170、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name warrant_type current_price 0 HK.59177 阿里法巴八十熊G.P HK.09988 阿里巴巴-W 4 0.290 1 HK.65875 阿里法巴八十熊H.P HK.09988 阿里巴巴-W 4 0.024 2 HK.55774 阿里法巴八十熊I.P HK.09988 阿里巴巴-W 4 0.203 3 HK.60642 阿里法巴八五熊D.P HK.09988 阿里巴巴-W 4 0.157 4 HK.66020 阿里法巴八五熊E.P HK.09988 阿里巴巴-W 4 0.173 ``` ##### `ISSUER_ID`（id=4 · choice · HK · リターン列 `issuer_id`） 発行会社 ID HK のみフィルタ可能；SG/MY 実測 issuer_id は常に 0。完全な発行会社マッピングは上記 ISSUER_ID 表を参照 ```python req.add_choice_filter(WarrantField.ISSUER_ID, [21]) # 仅瑞通 VT 发行 req.add_sort(WarrantField.TURNOVER, desc=True) ``` 実測返却（HK · all_count=2431、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name issuer_id warrant_type current_price 0 HK.55430 恒指瑞银八十熊B.P HK.800000 恒生指数 21 4 0.053 1 HK.57466 恒指瑞银八九牛N.C HK.800000 恒生指数 21 3 0.037 2 HK.27921 恒指瑞银六九沽A.P HK.800000 恒生指数 21 2 0.050 3 HK.29814 恒指瑞银六甲购A.C HK.800000 恒生指数 21 1 0.052 4 HK.56502 恒指瑞银八九牛D.C HK.800000 恒生指数 21 3 0.054 ``` ##### `STOCK_OWNER`（id=5 · choice · HK / SG / MY · リターン列 `owner_code`） 原資産 ID code 文字列リストを直接渡せる、例 ["HK.00700"] ```python req.add_choice_filter(WarrantField.STOCK_OWNER, ["HK.00700"]) req.add_sort(WarrantField.TURNOVER, desc=True) ``` 実測返却（HK · all_count=844、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name warrant_type current_price 0 HK.29080 腾讯国君六甲购B.C HK.00700 腾讯控股 1 0.117 1 HK.27892 腾讯摩通六九购E.C HK.00700 腾讯控股 1 0.058 2 HK.27966 腾讯法兴六九购D.C HK.00700 腾讯控股 1 0.060 3 HK.28957 腾讯法兴六甲购B.C HK.00700 腾讯控股 1 0.110 4 HK.29069 腾讯摩通六甲购B.C HK.00700 腾讯控股 1 0.099 ``` ##### `WARRANT_TYPE`（id=6 · choice · HK / SG / MY · リターン列 `warrant_type`） ワラント種別 1=認購 2=認沽 3=ブル 4=ベア 5=インライン；SG 実測で 6/7、MY 実測で 8 を返す、SDK 列挙未定義 ```python req.add_choice_filter(WarrantField.WARRANT_TYPE, [WarrantType.BULL, WarrantType.BEAR]) req.add_sort(WarrantField.TURNOVER, desc=True) ``` 実測返却（HK · all_count=7923、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name warrant_type current_price 0 HK.55994 恒指摩通九三熊R.P HK.800000 恒生指数 4 0.056 1 HK.57003 恒指摩通八九牛8.C HK.800000 恒生指数 3 0.038 2 HK.57109 恒指法兴八七牛E.C HK.800000 恒生指数 3 0.037 3 HK.55641 恒指法兴八三熊P.P HK.800000 恒生指数 4 0.055 4 HK.57114 恒指法兴八九牛7.C HK.800000 恒生指数 3 0.054 ``` ##### `CONVERSION_RATIO`（id=7 · interval · HK / SG / MY · リターン列 `conversion_ratio`） 換株比率 SDK は比率そのものを渡す（換株比率 1.0 は 1.0）；プロトコルフィールド ×1000 整数化送信 ```python req.add_interval_filter(WarrantField.CONVERSION_RATIO, min_val=1.0, max_val=10.0) req.add_sort(WarrantField.CONVERSION_RATIO, desc=False) ``` 実測返却（HK · all_count=3527、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name conversion_ratio warrant_type current_price 0 HK.15938 利丰瑞信七七购A.C HK.01818 招金矿业 1.0 1 0.000 1 HK.15941 平安瑞银七甲沽B.P HK.02318 中国平安 1.0 1 0.000 2 HK.25738 首程麦银六八购A.C HK.00697 首程控股 1.0 1 0.016 3 HK.15190 中核信证六二购B HK.01816 中广核电力 1.0 1 0.000 4 HK.17771 置富麦银六八购A.C HK.00778 置富产业信托 1.0 1 0.015 ``` ##### `CURRENT_PRICE`（id=8 · interval · HK / SG / MY · リターン列 `current_price`） 現在値 単位：通貨建て；SDK は元の価格をそのまま渡す（プロトコルフィールド ×1000 整数化送信） ```python req.add_interval_filter(WarrantField.CURRENT_PRICE, min_val=0.1, max_val=0.15) req.add_sort(WarrantField.CURRENT_PRICE, desc=False) ``` 実測返却（HK · all_count=1719、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name current_price warrant_type 0 HK.65586 中移花旗六九牛C.C HK.00941 中国移动 0.1 3 1 HK.67749 阿里瑞银六六牛B.C HK.09988 阿里巴巴-W 0.1 3 2 HK.69293 港交汇丰七甲牛A.C HK.00388 香港交易所 0.1 3 3 HK.56800 恒指信证七九牛U.C HK.800000 恒生指数 0.1 3 4 HK.57184 恒指法兴八三牛A.C HK.800000 恒生指数 0.1 3 ``` ##### `STREET_RATIO`（id=9 · interval · HK / SG / MY · リターン列 `street_rate`） 街頭流通比率 単位：% ；SDK は 50.0 のように直接渡す（プロトコルフィールド ×1000 整数化送信） ```python req.add_interval_filter(WarrantField.STREET_RATIO, min_val=10.0, max_val=50.0) req.add_sort(WarrantField.STREET_RATIO, desc=False) ``` 実測返却（HK · all_count=1918、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name street_rate warrant_type current_price 0 HK.27205 腾讯瑞银八乙购A.C HK.00700 腾讯控股 10.00 1 0.233 1 HK.63380 恒指中银八三熊I.P HK.800000 恒生指数 10.00 4 0.335 2 HK.60023 恒指国君七乙牛S.C HK.800000 恒生指数 10.01 3 0.193 3 HK.21640 飞鹤华泰六七购A.C HK.06186 中国飞鹤 10.01 1 0.010 4 HK.25461 恒指瑞银六七购A.C HK.800000 恒生指数 10.01 1 0.010 ``` ##### `VOLUME`（id=10 · interval · HK / SG / MY · リターン列 `volume`） 出来高 単位：株 ```python req.add_interval_filter(WarrantField.VOLUME, min_val=1000) req.add_sort(WarrantField.VOLUME, desc=True) ``` 実測返却（HK · all_count=6092、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name volume warrant_type current_price 0 HK.55994 恒指摩通九三熊R.P HK.800000 恒生指数 20257030000 4 0.056 1 HK.55641 恒指法兴八三熊P.P HK.800000 恒生指数 18202610000 4 0.055 2 HK.57109 恒指法兴八七牛E.C HK.800000 恒生指数 17612080000 3 0.037 3 HK.57003 恒指摩通八九牛8.C HK.800000 恒生指数 16576470000 3 0.038 4 HK.55430 恒指瑞银八十熊B.P HK.800000 恒生指数 12932700000 4 0.053 ``` ##### `MATURITY_DATE`（id=11 · interval · HK / SG / MY · リターン列 `maturity_date`） 満期日 (タイムスタンプ秒) Unix 秒タイムスタンプ；返却 maturity_date も文字列型タイムスタンプ ```python import time req.add_interval_filter(WarrantField.MATURITY_DATE, min_val=int(time.time()), max_val=int(time.time()) + 365*86400) req.add_sort(WarrantField.MATURITY_DATE, desc=False) ``` 実測返却（HK · all_count=9330、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name maturity_date warrant_type current_price 0 HK.21145 金云摩利六六购A.C HK.03896 金山云 1781539200 1 0.010 1 HK.54786 百度瑞银六六牛B.C HK.09888 百度集团-SW 1781539200 3 0.305 2 HK.23342 优必中银六六购B.C HK.09880 优必选 1781539200 1 0.010 3 HK.23574 汇量华泰六六购A.C HK.01860 汇量科技 1781539200 1 0.010 4 HK.18353 美高摩通六六购A.C HK.02282 美高梅中国 1781625600 1 0.010 ``` ##### `STRIKE_PRICE`（id=12 · interval · HK / SG / MY · リターン列 `strike_price`） 権利行使価格 単位：通貨建て；SDK は元の価格をそのまま渡す（プロトコルフィールド ×1000 整数化送信） ```python req.add_interval_filter(WarrantField.STRIKE_PRICE, min_val=10.0, max_val=20.0) req.add_sort(WarrantField.STRIKE_PRICE, desc=False) ``` 実測返却（HK · all_count=990、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name strike_price warrant_type current_price 0 HK.19876 喜相华泰六八购A.C HK.02473 喜相逢集团 10.0 1 0.010 1 HK.23889 中油法巴六七购A.C HK.00857 中国石油股份 10.0 1 0.153 2 HK.11055 英港摩通六七沽A.P N/A N/A 10.0 2 0.051 3 HK.25258 中联花旗六八购A.C HK.00762 中国联通 10.0 1 0.014 4 HK.27520 新发信证七三购A.C HK.00017 新世界发展 10.0 1 0.107 ``` ##### `PREMIUM`（id=13 · interval · HK / SG / MY · リターン列 `premium`） プレミアム 単位：% ；SDK は 15.0 のように直接渡す、負値可（プロトコルフィールド ×100000 整数化送信） ```python req.add_interval_filter(WarrantField.PREMIUM, min_val=0.0, max_val=20.0) req.add_sort(WarrantField.PREMIUM, desc=False) ``` 実測返却（HK · all_count=11283、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name premium warrant_type current_price 0 HK.21137 恒大中银八七购A.C N/A N/A 0.0 1 0.000 1 HK.16449 恒生中银九乙购A.C N/A N/A 0.0 1 0.000 2 HK.16512 恒指高盛九九沽J.P HK.06688 蚂蚁集团 0.0 1 0.000 3 HK.16522 恒指瑞通九十沽A.P HK.06688 蚂蚁集团 0.0 1 0.000 4 HK.68392 招行瑞银六八牛A.C HK.03968 招商银行 0.0 3 0.238 ``` ##### `RECOVERY_PRICE`（id=14 · interval · HK / SG / MY · リターン列 `recovery_price`） 回収価格 単位：通貨建て；SDK は元の価格を渡す；ブル/ベア(3/4) のみ有効（プロトコルフィールド ×1000 整数化送信） ```python req.add_choice_filter(WarrantField.WARRANT_TYPE, [WarrantType.BULL, WarrantType.BEAR]) req.add_interval_filter(WarrantField.RECOVERY_PRICE, min_val=0.01) req.add_sort(WarrantField.RECOVERY_PRICE, desc=False) ``` 実測返却（HK · all_count=7923、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name recovery_price warrant_type current_price 0 HK.59404 商汤瑞银七八牛D.C HK.00020 商汤-W 1.00 3 0.062 1 HK.64826 商汤法兴七五牛A.C HK.00020 商汤-W 1.05 3 0.113 2 HK.59403 商汤瑞银七八牛C.C HK.00020 商汤-W 1.10 3 0.053 3 HK.64933 商汤瑞银六乙牛A.C HK.00020 商汤-W 1.20 3 0.074 4 HK.59322 商汤汇丰七一牛A HK.00020 商汤-W 1.20 3 0.000 ``` ##### `IMPLIED_VOLATILITY`（id=15 · interval · HK / SG / MY · リターン列 `implied_volatility`） インプライドボラティリティ 単位：% ；SDK は 15.0 のように直接渡す；認購認沽(1/2) のみ有効（プロトコルフィールド ×100 整数化送信） ```python req.add_interval_filter(WarrantField.IMPLIED_VOLATILITY, min_val=10.0, max_val=100.0) req.add_sort(WarrantField.IMPLIED_VOLATILITY, desc=False) ``` 実測返却（HK · all_count=5962、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name implied_volatility warrant_type current_price 0 HK.24413 中移中银六九购A.C HK.00941 中国移动 13.487 1 0.041 1 HK.25984 建行韩投八乙购A.C HK.00939 建设银行 14.638 1 0.500 2 HK.25450 中移国君六九购A.C HK.00941 中国移动 15.308 1 0.054 3 HK.24942 中移汇丰六九购A.C HK.00941 中国移动 15.776 1 0.059 4 HK.14414 建行法巴六乙购A.C HK.00939 建设银行 15.792 1 0.191 ``` ##### `LEVERAGE_RATIO`（id=16 · interval · HK / SG / MY · リターン列 `leverage`） レバレッジ比率 SDK は元の値をそのまま渡す（プロトコルフィールド ×1000 整数化送信） ```python req.add_interval_filter(WarrantField.LEVERAGE_RATIO, min_val=3.0, max_val=50.0) req.add_sort(WarrantField.LEVERAGE_RATIO, desc=True) ``` 実測返却（HK · all_count=8360、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name leverage warrant_type current_price 0 HK.29999 恒指中银六乙购C.C HK.800000 恒生指数 49.985 1 0.071 1 HK.27121 领展瑞银六九购A.C HK.00823 领展房产基金 49.972 1 0.074 2 HK.15343 百度摩通六八沽A.P HK.09888 百度集团-SW 49.869 2 0.023 3 HK.25973 远能麦银六八购A.C HK.01138 中远海能 49.852 1 0.068 4 HK.26365 远能麦银六九购A.C HK.01138 中远海能 49.852 1 0.034 ``` ##### `PRICE_RECOVERY_RATIO`（id=17 · interval · HK / SG / MY · リターン列 `price_recovery_ratio`） 原資産と回収価格の差 % 単位：% ；SDK は 15.0 のように直接渡す、負値可；ブル/ベア(3/4) のみ有効（プロトコルフィールド ×100000 整数化送信） ```python req.add_choice_filter(WarrantField.WARRANT_TYPE, [WarrantType.BULL, WarrantType.BEAR]) req.add_interval_filter(WarrantField.PRICE_RECOVERY_RATIO, min_val=-50.0, max_val=50.0) req.add_sort(WarrantField.PRICE_RECOVERY_RATIO, desc=False) ``` 実測返却（HK · all_count=7923、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name price_recovery_ratio warrant_type current_price 0 HK.54832 美团瑞银七乙熊M.P HK.03690 美团-W -0.73916 4 0.430 1 HK.53329 美团瑞银七乙熊I.P HK.03690 美团-W -0.72053 4 0.390 2 HK.54269 美团摩通七九熊F.P HK.03690 美团-W -0.72053 4 0.395 3 HK.54562 美团汇丰七乙熊D.P HK.03690 美团-W -0.71018 4 0.370 4 HK.54799 美团摩通七乙熊D.P HK.03690 美团-W -0.71018 4 0.370 ``` ##### `DELTA`（id=18 · interval · HK / SG / MY · リターン列 `delta`） ヘッジ値 SDK は元の値を渡す、範囲 [-1, 1]；認購認沽(1/2) のみ有効（プロトコルフィールド ×1000 整数化送信） ```python req.add_choice_filter(WarrantField.WARRANT_TYPE, [WarrantType.CALL, WarrantType.PUT]) req.add_interval_filter(WarrantField.DELTA, min_val=-1.0, max_val=1.0) req.add_sort(WarrantField.DELTA, desc=True) ``` 実測返却（HK · all_count=8247、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name delta warrant_type current_price 0 HK.16281 联想信证六六购A.C HK.00992 联想集团 0.999 1 1.28 1 HK.18636 中寿国君六六购A.C HK.02628 中国人寿 0.999 1 0.59 2 HK.22934 建滔华泰六八购A.C HK.00148 建滔集团 0.997 1 6.73 3 HK.19057 汇丰摩利六七购A.C HK.00005 汇丰控股 0.996 1 0.87 4 HK.19058 汇丰法兴六七购A.C HK.00005 汇丰控股 0.996 1 0.87 ``` ##### `STATUS`（id=19 · choice · HK / SG / MY · リターン列 `status`） ワラントステータス 0=正常 1=取引終了 2=上場待ち ```python req.add_choice_filter(WarrantField.STATUS, [WarrantStatus.NORMAL]) req.add_sort(WarrantField.VOLUME, desc=True) ``` 実測返却（HK · all_count=13057、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name status warrant_type current_price 0 HK.55994 恒指摩通九三熊R.P HK.800000 恒生指数 0 4 0.056 1 HK.55641 恒指法兴八三熊P.P HK.800000 恒生指数 0 4 0.055 2 HK.57109 恒指法兴八七牛E.C HK.800000 恒生指数 0 3 0.037 3 HK.57003 恒指摩通八九牛8.C HK.800000 恒生指数 0 3 0.038 4 HK.55430 恒指瑞银八十熊B.P HK.800000 恒生指数 0 4 0.053 ``` ##### `IPO_TIME`（id=20 · interval · HK / SG / MY · リターン列 `ipo_time`） 上場日時 (タイムスタンプ秒) Unix 秒タイムスタンプ ```python req.add_interval_filter(WarrantField.IPO_TIME, min_val=1700000000, max_val=2000000000) req.add_sort(WarrantField.IPO_TIME, desc=True) ``` 実測返却（HK · all_count=16122、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name ipo_time warrant_type current_price 0 HK.11203 道指摩通六乙沽B US..DJI 道琼斯指数 1781625600 2 0.0 1 HK.11204 纳指摩通六乙沽C US..NDX 纳斯达克100指数 1781625600 2 0.0 2 HK.11205 道指摩通六乙沽C US..DJI 道琼斯指数 1781625600 2 0.0 3 HK.13826 老铺摩利六乙沽A HK.06181 老铺黄金 1781625600 2 0.0 4 HK.13827 港交摩利六乙沽A HK.00388 香港交易所 1781625600 2 0.0 ``` ##### `BUY_VOL`（id=21 · interval · HK / SG / MY · リターン列 `buy_vol`） 買量 単位：株 ```python req.add_interval_filter(WarrantField.BUY_VOL, min_val=1) req.add_sort(WarrantField.BUY_VOL, desc=True) ``` 実測返却（HK · all_count=10554、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name buy_vol warrant_type current_price 0 HK.56746 恒指汇丰八甲牛V.C HK.800000 恒生指数 41410000 3 0.065 1 HK.56560 恒指摩通八三牛G.C HK.800000 恒生指数 40730000 3 0.114 2 HK.63929 恒指摩利八十牛E.C HK.800000 恒生指数 40380000 3 0.102 3 HK.64852 恒指瑞银八十牛G.C HK.800000 恒生指数 40000000 3 0.131 4 HK.29035 泡玛星展六甲沽A.P HK.09992 泡泡玛特 40000000 2 0.071 ``` ##### `SELL_VOL`（id=22 · interval · HK / SG / MY · リターン列 `sell_vol`） 売量 単位：株 ```python req.add_interval_filter(WarrantField.SELL_VOL, min_val=1) req.add_sort(WarrantField.SELL_VOL, desc=True) ``` 実測返却（HK · all_count=11581、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name sell_vol warrant_type current_price 0 HK.26774 阿里法巴六七购B.C HK.09988 阿里巴巴-W 60130000 1 0.010 1 HK.29035 泡玛星展六甲沽A.P HK.09992 泡泡玛特 37900000 2 0.071 2 HK.55588 恒指汇丰九四熊D.P HK.800000 恒生指数 34110000 4 0.055 3 HK.56458 恒指摩通八九牛4.C HK.800000 恒生指数 33830000 3 0.064 4 HK.57114 恒指法兴八九牛7.C HK.800000 恒生指数 33370000 3 0.054 ``` ##### `EFFECTIVE_LEVERAGE`（id=23 · interval · HK / SG / MY · リターン列 `effective_leverage`） 実効レバレッジ SDK は元の値を渡す（プロトコルフィールド ×1000 整数化送信） ```python req.add_interval_filter(WarrantField.EFFECTIVE_LEVERAGE, min_val=3.0, max_val=50.0) req.add_sort(WarrantField.EFFECTIVE_LEVERAGE, desc=True) ``` 実測返却（HK · all_count=5409、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name effective_leverage warrant_type current_price 0 HK.23821 建行国君六六购A.C HK.00939 建设银行 47.082 1 0.102 1 HK.25486 华地信证六六购B.C HK.01109 华润置地 45.821 1 0.010 2 HK.23727 领展信证六六购A.C HK.00823 领展房产基金 44.375 1 0.012 3 HK.23398 建行麦银六六购A.C HK.00939 建设银行 42.977 1 0.017 4 HK.23575 华地摩通六六购A.C HK.01109 华润置地 42.093 1 0.012 ``` ##### `LAST_CLOSE_PRICE`（id=24 · interval · HK / SG / MY · リターン列 `last_close_price`） 前日終値 単位：通貨建て；SDK は元の価格を渡す（プロトコルフィールド ×1000 整数化送信） ```python req.add_interval_filter(WarrantField.LAST_CLOSE_PRICE, min_val=0.1, max_val=2.0) req.add_sort(WarrantField.LAST_CLOSE_PRICE, desc=False) ``` 実測返却（HK · all_count=7028、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name last_close_price warrant_type current_price 0 HK.14210 腾讯花旗六乙沽A.P HK.00700 腾讯控股 0.1 2 0.101 1 HK.67749 阿里瑞银六六牛B.C HK.09988 阿里巴巴-W 0.1 3 0.100 2 HK.53182 平安汇丰七甲牛L.C HK.02318 中国平安 0.1 3 0.107 3 HK.69230 平安法兴七十牛U.C HK.02318 中国平安 0.1 3 0.105 4 HK.56325 恒指法兴八三牛8.C HK.800000 恒生指数 0.1 3 0.119 ``` ##### `TURNOVER`（id=25 · interval · HK / SG / MY · リターン列 `turnover`） 売買代金 単位：通貨建て ```python req.add_interval_filter(WarrantField.TURNOVER, min_val=1) req.add_sort(WarrantField.TURNOVER, desc=True) ``` 実測返却（HK · all_count=6093、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name turnover warrant_type current_price 0 HK.55994 恒指摩通九三熊R.P HK.800000 恒生指数 864568920.0 4 0.056 1 HK.57003 恒指摩通八九牛8.C HK.800000 恒生指数 852463370.0 3 0.038 2 HK.57109 恒指法兴八七牛E.C HK.800000 恒生指数 842853250.0 3 0.037 3 HK.55641 恒指法兴八三熊P.P HK.800000 恒生指数 777372600.0 4 0.055 4 HK.57114 恒指法兴八九牛7.C HK.800000 恒生指数 608277730.0 3 0.054 ``` ##### `SELL_PRICE`（id=26 · interval · HK / SG / MY · リターン列 `sell_price`） 売価 単位：通貨建て；SDK は元の価格を渡す（プロトコルフィールド ×1000 整数化送信） ```python req.add_interval_filter(WarrantField.SELL_PRICE, min_val=0.001) req.add_sort(WarrantField.SELL_PRICE, desc=False) ``` 実測返却（HK · all_count=11581、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name sell_price warrant_type current_price 0 HK.23665 S金摩通六七购A.C HK.02840 SPDR金 0.01 1 0.01 1 HK.25680 百度麦银六七购A.C HK.09888 百度集团-SW 0.01 1 0.01 2 HK.27365 中交法兴六六购A.C HK.01800 中国交通建设 0.01 1 0.01 3 HK.28314 铁塔信证六九购A.C HK.00788 中国铁塔 0.01 1 0.01 4 HK.28806 协鑫麦银六九购A.C HK.03800 协鑫科技 0.01 1 0.01 ``` ##### `BUY_PRICE`（id=27 · interval · HK / SG / MY · リターン列 `buy_price`） 買価 単位：通貨建て；SDK は元の価格を渡す（プロトコルフィールド ×1000 整数化送信） ```python req.add_interval_filter(WarrantField.BUY_PRICE, min_val=0.001) req.add_sort(WarrantField.BUY_PRICE, desc=False) ``` 実測返却（HK · all_count=10554、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name buy_price warrant_type current_price 0 HK.13598 小米摩通六乙购B.C HK.01810 小米集团-W 0.01 1 0.010 1 HK.14635 比迪星展六甲购A.C HK.01211 比亚迪股份 0.01 1 0.010 2 HK.14652 腾讯法兴六九购A.C HK.00700 腾讯控股 0.01 1 0.011 3 HK.16396 南科信证六乙购A.C HK.03033 南方恒生科技 0.01 1 0.014 4 HK.17724 泡玛汇丰六甲购A.C HK.09992 泡泡玛特 0.01 1 0.012 ``` ##### `HIGH_PRICE`（id=28 · interval · HK / SG / MY · リターン列 `high_price`） 高値 単位：通貨建て；SDK は元の価格を渡す；日中高値（プロトコルフィールド ×1000 整数化送信） ```python req.add_interval_filter(WarrantField.HIGH_PRICE, min_val=0.001) req.add_sort(WarrantField.HIGH_PRICE, desc=True) ``` 実測返却（HK · all_count=6075、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name high_price warrant_type current_price 0 HK.11115 美光法兴六甲购A.C N/A N/A 6.74 1 6.74 1 HK.24047 建板摩利六七购A.C HK.01888 建滔积层板 6.47 1 6.47 2 HK.25060 建滔华泰六八购B.C HK.00148 建滔集团 5.67 1 5.65 3 HK.16544 建板信证六十购A.C HK.01888 建滔积层板 5.57 1 5.57 4 HK.26175 建板汇丰六八购A.C HK.01888 建滔积层板 5.44 1 5.44 ``` ##### `LOW_PRICE`（id=29 · interval · HK / SG / MY · リターン列 `low_price`） 安値 単位：通貨建て；SDK は元の価格を渡す；日中安値（プロトコルフィールド ×1000 整数化送信） ```python req.add_interval_filter(WarrantField.LOW_PRICE, min_val=0.001) req.add_sort(WarrantField.LOW_PRICE, desc=False) ``` 実測返却（HK · all_count=6075、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name low_price warrant_type current_price 0 HK.28933 阿里麦银六七购A.C HK.09988 阿里巴巴-W 0.01 1 0.01 1 HK.29014 阿里法兴六六购A.C HK.09988 阿里巴巴-W 0.01 1 0.01 2 HK.13598 小米摩通六乙购B.C HK.01810 小米集团-W 0.01 1 0.01 3 HK.13662 中联麦银六九购A.C HK.00762 中国联通 0.01 1 0.01 4 HK.14148 腾讯汇丰六七购A.C HK.00700 腾讯控股 0.01 1 0.01 ``` ##### `RATIO_ITM_OTM`（id=30 · interval · HK / SG / MY · リターン列 `ipop`） ITM/OTM 比率 % 単位：% ；SDK は 15.0 のように直接渡す、負値可；返却列名は ipop（プロトコルフィールド ×100000 整数化送信） ```python req.add_interval_filter(WarrantField.RATIO_ITM_OTM, min_val=-50.0, max_val=50.0) req.add_sort(WarrantField.RATIO_ITM_OTM, desc=False) ``` 実測返却（HK · all_count=16166、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name ipop warrant_type current_price 0 HK.21173 信达海通八七购A.C HK.01359 中国信达 -41.74285 1 0.000 1 HK.21158 华泥瑞信八七购A.C HK.01313 华润建材科技 -41.68907 1 0.000 2 HK.25100 喜相摩通六六购A.C HK.02473 喜相逢集团 -37.67187 1 0.061 3 HK.25841 喜相麦银六七购A.C HK.02473 喜相逢集团 -37.64062 1 0.025 4 HK.15946 信达瑞信七六购A.C HK.01359 中国信达 -37.40952 1 0.000 ``` ##### `BREAK_EVEN_POINT`（id=31 · interval · HK / SG / MY · リターン列 `break_even_point`） 損益分岐点 % 単位：% ；SDK は 15.0 のように直接渡す（プロトコルフィールド ×100000 整数化送信） ```python req.add_interval_filter(WarrantField.BREAK_EVEN_POINT, min_val=-100.0, max_val=100.0) req.add_sort(WarrantField.BREAK_EVEN_POINT, desc=False) ``` 実測返却（HK · all_count=11618、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name break_even_point warrant_type current_price 0 HK.21137 恒大中银八七购A.C N/A N/A 0.0 1 0.000 1 HK.16449 恒生中银九乙购A.C N/A N/A 0.0 1 0.000 2 HK.49942 道指汇丰六乙熊H.P US..DJI 道琼斯指数 0.0 4 0.013 3 HK.49950 道指瑞银六乙熊L.P US..DJI 道琼斯指数 0.0 4 0.012 4 HK.29859 东风麦银六六购A.C N/A N/A 0.0 1 0.720 ``` ##### `AMPLITUDE`（id=32 · interval · HK / SG / MY · リターン列 `amplitude`） 値幅 % 単位：% ；SDK は 15.0 のように直接渡す（プロトコルフィールド ×100000 整数化送信） ```python req.add_interval_filter(WarrantField.AMPLITUDE, min_val=0.01) req.add_sort(WarrantField.AMPLITUDE, desc=True) ``` 実測返却（HK · all_count=5358、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name amplitude warrant_type current_price 0 HK.23936 舜光信证六六购A.C HK.02382 舜宇光学科技 3.80000 1 0.054 1 HK.23432 舜光摩利六六购A.C HK.02382 舜宇光学科技 3.27273 1 0.055 2 HK.24022 舜光花旗六六购A.C HK.02382 舜宇光学科技 3.00000 1 0.058 3 HK.20335 江铜摩通六六购A.C HK.00358 江西铜业股份 2.24390 1 0.181 4 HK.61517 中芯法兴六甲牛H.C HK.00981 中芯国际 2.00000 3 0.076 ``` ##### `SCORE_FAXING`（id=33 · interval · HK / SG / MY · リターン列 `fx_score`） SG 評価スコア SDK は元のスコアを渡す；返却列名は fx_score（プロトコルフィールド ×100000 整数化送信） ```python req.add_interval_filter(WarrantField.SCORE_FAXING, min_val=0.0, max_val=10.0) req.add_sort(WarrantField.SCORE_FAXING, desc=True) ``` 実測返却（HK · all_count=16170、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name fx_score warrant_type current_price 0 HK.29442 中药法巴七五购A.C HK.01177 中国生物制药 0.94860 1 0.071 1 HK.13660 建滔法兴七一购B.C HK.00148 建滔集团 0.94397 1 0.193 2 HK.29636 美图摩通六甲购A.C HK.01357 美图公司 0.93674 1 0.127 3 HK.24961 中移摩通六九购A.C HK.00941 中国移动 0.93553 1 0.070 4 HK.21241 兖矿摩通六八购A.C HK.01171 兖矿能源 0.93449 1 0.202 ``` ##### `LAST_TRADE_DATE`（id=34 · interval · HK / SG / MY · リターン列 `last_trade_date`） 最終取引日 (タイムスタンプ秒) Unix 秒タイムスタンプ；通常 MATURITY_DATE より 1 取引日早い ```python req.add_interval_filter(WarrantField.LAST_TRADE_DATE, min_val=1900000000, max_val=2200000000) req.add_sort(WarrantField.LAST_TRADE_DATE, desc=False) ``` 実測返却（HK · all_count=1、ヒット 1 行、head 先頭 5）： ``` code name owner_code owner_name last_trade_date warrant_type current_price 0 HK.29183 建行法巴零乙购A.C HK.00939 建设银行 1924272000 1 0.237 ``` ##### `STREET_VOLUME`（id=35 · interval · HK / SG / MY · リターン列 `street_vol`） 街頭流通量 単位：株；返却列名は street_vol ```python req.add_interval_filter(WarrantField.STREET_VOLUME, min_val=1) req.add_sort(WarrantField.STREET_VOLUME, desc=True) ``` 実測返却（HK · all_count=11611、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name street_vol warrant_type current_price 0 HK.14958 腾讯法兴六七购A.C HK.00700 腾讯控股 400000000 1 0.010 1 HK.14826 腾讯摩通六七购A.C HK.00700 腾讯控股 398760000 1 0.010 2 HK.25097 腾讯摩通六九购A.C HK.00700 腾讯控股 319360000 1 0.012 3 HK.13039 小米摩通六乙购A.C HK.01810 小米集团-W 306960000 1 0.017 4 HK.14148 腾讯汇丰六七购A.C HK.00700 腾讯控股 300000000 1 0.010 ``` ##### `LOT_SIZE`（id=36 · interval · HK / SG / MY · リターン列 `lot_size`） 1 単元株数 単位：株 ```python req.add_interval_filter(WarrantField.LOT_SIZE, min_val=1) req.add_sort(WarrantField.LOT_SIZE, desc=False) ``` 実測返却（HK · all_count=16170、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name lot_size warrant_type current_price 0 HK.22588 万科麦银六六购B.C HK.02202 万科企业 100 1 0.010 1 HK.24402 航赁麦银六七购A.C HK.02588 中银航空租赁 100 1 0.019 2 HK.24702 航赁华泰六七购A.C HK.02588 中银航空租赁 100 1 0.010 3 HK.27072 蔚来麦银六九沽A.P HK.09866 蔚来-SW 100 2 0.071 4 HK.19866 南科华泰六六购A.C HK.03033 南方恒生科技 200 1 0.010 ``` ##### `ISSUE_SIZE`（id=37 · interval · HK / SG / MY · リターン列 `issue_size`） 発行量 単位：株 ```python req.add_interval_filter(WarrantField.ISSUE_SIZE, min_val=1) req.add_sort(WarrantField.ISSUE_SIZE, desc=True) ``` 実測返却（HK · all_count=16170、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name issue_size warrant_type current_price 0 HK.22659 阿里韩投八乙购A.C HK.09988 阿里巴巴-W 500000000 1 0.370 1 HK.16737 宁德法兴七乙购A.C HK.03750 宁德时代 500000000 1 0.880 2 HK.13850 恒指摩通六乙沽C HK.800000 恒生指数 500000000 2 0.000 3 HK.22235 港交韩投八八购A.C HK.00388 香港交易所 480000000 1 0.325 4 HK.22254 中移韩投八八购A.C HK.00941 中国移动 480000000 1 0.162 ``` ##### `IPO_PRICE`（id=38 · interval · HK / SG / MY · リターン列 `ipo_price`） 発行価格 単位：通貨建て；SDK は元の価格を渡す（プロトコルフィールド ×1000 整数化送信） ```python req.add_interval_filter(WarrantField.IPO_PRICE, min_val=0.001) req.add_sort(WarrantField.IPO_PRICE, desc=False) ``` 実測返却（HK · all_count=0、ヒット 0 行）：データなし。理由：OpenD 実測で大多数のワラントは ipo_price が 0 を返すため、min_val=0.001 でフィルタすると該当なし ##### `LOWER_STRIKE_PRICE`（id=39 · interval · HK / SG / MY · リターン列 `lower_strike_price`） 下限価格 単位：通貨建て；SDK は元の価格を渡す；インライン(5) のみ有効（プロトコルフィールド ×1000 整数化送信） ```python req.add_choice_filter(WarrantField.WARRANT_TYPE, [WarrantType.IW]) req.add_interval_filter(WarrantField.LOWER_STRIKE_PRICE, min_val=0.001) req.add_sort(WarrantField.LOWER_STRIKE_PRICE, desc=False) ``` 実測返却（HK · all_count=0、ヒット 0 行）：データなし。理由：HK は現在界内証（IW）の上場なし、ワラントタイプ条件でヒットなし ##### `UPPER_STRIKE_PRICE`（id=40 · interval · HK / SG / MY · リターン列 `upper_strike_price`） 上限価格 単位：通貨建て；SDK は元の価格を渡す；インライン(5) のみ有効（プロトコルフィールド ×1000 整数化送信） ```python req.add_choice_filter(WarrantField.WARRANT_TYPE, [WarrantType.IW]) req.add_interval_filter(WarrantField.UPPER_STRIKE_PRICE, min_val=0.001) req.add_sort(WarrantField.UPPER_STRIKE_PRICE, desc=False) ``` 実測返却（HK · all_count=0、ヒット 0 行）：データなし。理由：HK は現在界内証（IW）の上場なし、ワラントタイプ条件でヒットなし ##### `IW_PRICE_STATUS`（id=41 · choice · HK / SG / MY · リターン列 `iw_price_status`） インライン/アウトライン 0=アウトライン 1=インライン；インライン(5) のみ非 0 を返す ```python req.add_choice_filter(WarrantField.WARRANT_TYPE, [WarrantType.IW]) ``` 実測返却（HK · all_count=0、ヒット 0 行）：データなし。理由：HK は現在界内証（IW）の上場なし、ワラントタイプ条件でヒットなし ##### `SENSITIVITY`（id=42 · interval · HK / SG / MY · リターン列 `sensitivity`） 感応度 SDK は元の値を渡す（プロトコルフィールド ×1000 整数化送信） ```python req.add_interval_filter(WarrantField.SENSITIVITY, min_val=0.001) req.add_sort(WarrantField.SENSITIVITY, desc=False) ``` 実測返却（HK · all_count=13623、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name sensitivity warrant_type current_price 0 HK.19340 腾音信证六九购A.C HK.01698 腾讯音乐-SW 0.018 1 0.010 1 HK.28495 稀宇麦银六十购B.C HK.00100 MINIMAX-W 0.019 1 0.013 2 HK.51984 美团瑞银七乙熊G.P HK.03690 美团-W 0.020 4 0.275 3 HK.52261 美团法巴七七熊K.P HK.03690 美团-W 0.020 4 0.280 4 HK.52532 美团瑞银七乙熊H.P HK.03690 美团-W 0.020 4 0.310 ``` ##### `CONVERSION_PRICE`（id=43 · interval · HK / SG / MY · リターン列なし） 換株価 返却 DataFrame に単独で公開されない；フィルタ / ソート条件として使用可 ```python req.add_interval_filter(WarrantField.CONVERSION_PRICE, min_val=0.001) req.add_sort(WarrantField.CONVERSION_PRICE, desc=False) ``` 実測返却（HK · all_count=16170、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name warrant_type current_price 0 HK.64814 平安瑞银八三牛A.C HK.02318 中国平安 3 0.0 1 HK.15946 信达瑞信七六购A.C HK.01359 中国信达 1 0.0 2 HK.24719 腾讯东亚九四沽A HK.00700 腾讯控股 2 0.0 3 HK.26168 金软瑞银九二购B HK.03888 金山软件 1 0.0 4 HK.64492 恒指汇丰八五熊G.P HK.800000 恒生指数 3 0.0 ``` ##### `CHANGE_RATE`（id=44 · interval · HK / SG / MY · リターン列なし） 騰落率 % 単位：% ；SDK は 5.0 のように直接渡す；返却 DataFrame に単独で公開されない（プロトコルフィールド ×1000 整数化送信） ```python req.add_interval_filter(WarrantField.CHANGE_RATE, min_val=-100.0, max_val=100.0) req.add_sort(WarrantField.CHANGE_RATE, desc=True) ``` 実測返却（HK · all_count=16170、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name warrant_type current_price 0 HK.25160 远能华泰六七购B.C HK.01138 中远海能 1 0.136 1 HK.23936 舜光信证六六购A.C HK.02382 舜宇光学科技 1 0.054 2 HK.25876 远能华泰六八购A.C HK.01138 中远海能 1 0.093 3 HK.23432 舜光摩利六六购A.C HK.02382 舜宇光学科技 1 0.055 4 HK.26285 远能华泰六九购B.C HK.01138 中远海能 1 0.048 ``` ##### `CHANGE_VALUE`（id=45 · interval · HK / SG / MY · リターン列なし） 騰落幅 単位：通貨建て；返却 DataFrame に単独で公開されない ```python req.add_interval_filter(WarrantField.CHANGE_VALUE, min_val=-1.0, max_val=1.0) req.add_sort(WarrantField.CHANGE_VALUE, desc=True) ``` 実測返却（HK · all_count=7641、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name warrant_type current_price 0 HK.25336 铁塔摩利六乙购A.C HK.00788 中国铁塔 1 0.017 1 HK.25366 铁塔摩通六乙购A.C HK.00788 中国铁塔 1 0.028 2 HK.26138 铁塔中银六乙购A.C HK.00788 中国铁塔 1 0.027 3 HK.26447 中铁法兴六九购A.C HK.00390 中国中铁 1 0.020 4 HK.67330 京东摩通六乙牛A.C HK.09618 京东集团-SW 3 0.216 ``` ##### `SCORE`（id=51 · interval · HK / SG / MY · リターン列 `score`） Warrant 評点 総合評点；SDK は元のスコアを渡す（プロトコルフィールド ×100000 整数化送信） ```python req.add_interval_filter(WarrantField.SCORE, min_val=0.0, max_val=10.0) req.add_sort(WarrantField.SCORE, desc=True) ``` 実測返却（HK · all_count=16170、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name score warrant_type current_price 0 HK.11048 澳港摩通六七购A.C N/A N/A 0.010 1 0.195 1 HK.11056 欧港摩通六七购A.C N/A N/A 0.009 1 0.016 2 HK.49582 标指摩通六九牛B.C US..SPX 标普500指数 0.009 3 0.193 3 HK.10087 美日摩通六六购A.C FX.USDJPY 美元/日元 0.008 1 0.073 4 HK.11047 澳港摩通六七沽A.P N/A N/A 0.008 2 0.013 ``` ##### `FILTER_NO_TRADE`（id=52 · choice · HK / SG / MY · リターン列 `current_price`） 出来高なしワラントをフィルタ スイッチフィールド：0=フィルタなし 1=出来高 0 のワラントを除外；データ列を返さない ```python req.add_choice_filter(WarrantField.FILTER_NO_TRADE, [1]) req.add_sort(WarrantField.VOLUME, desc=True) ``` 実測返却（HK · all_count=15151、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name current_price warrant_type 0 HK.55994 恒指摩通九三熊R.P HK.800000 恒生指数 0.056 4 1 HK.55641 恒指法兴八三熊P.P HK.800000 恒生指数 0.055 4 2 HK.57109 恒指法兴八七牛E.C HK.800000 恒生指数 0.037 3 3 HK.57003 恒指摩通八九牛8.C HK.800000 恒生指数 0.038 3 4 HK.55430 恒指瑞银八十熊B.P HK.800000 恒生指数 0.053 4 ``` ##### `CURRENCY_CODE`（id=53 · choice · HK / SG / MY · リターン列なし） 通貨コード 通常は市場で決定（HK=HKD、SG=SGD、MY=MYR）；返却 DataFrame に単独で公開されない ```python req.add_sort(WarrantField.TURNOVER, desc=True) ``` 実測返却（HK · all_count=16170、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name warrant_type current_price 0 HK.55994 恒指摩通九三熊R.P HK.800000 恒生指数 4 0.056 1 HK.57003 恒指摩通八九牛8.C HK.800000 恒生指数 3 0.038 2 HK.57109 恒指法兴八七牛E.C HK.800000 恒生指数 3 0.037 3 HK.55641 恒指法兴八三熊P.P HK.800000 恒生指数 4 0.055 4 HK.57114 恒指法兴八九牛7.C HK.800000 恒生指数 3 0.054 ``` ##### `STOCK_OWNER_PRICE`（id=54 · interval · HK / SG / MY · リターン列 `stock_owner_price`） 原資産価格 単位：通貨建て；SDK は元の価格を渡す；返却 stock_owner_price 列（プロトコルフィールド ×1000 整数化送信） ```python req.add_interval_filter(WarrantField.STOCK_OWNER_PRICE, min_val=0.001) req.add_sort(WarrantField.STOCK_OWNER_PRICE, desc=False) ``` 実測返却（HK · all_count=16168、ヒット 5 行、head 先頭 5）： ``` code name owner_code owner_name stock_owner_price warrant_type current_price 0 HK.16376 碧桂法巴九十购A.C HK.02007 碧桂园 0.209 1 0.000 1 HK.16468 中粮麦银九甲购A.C HK.00606 中骏商管 0.295 1 0.000 2 HK.19876 喜相华泰六八购A.C HK.02473 喜相逢集团 0.640 1 0.010 3 HK.25841 喜相麦银六七购A.C HK.02473 喜相逢集团 0.640 1 0.025 4 HK.29782 喜相华泰六六购A.C HK.02473 喜相逢集团 0.640 1 0.010 ``` :::tip APIレート制限 * 30秒以内にワラントスクリーニング API を最大60回までリクエスト可能です ::: --- # 取得ワラント和先物リスト `get_referencestock_list(code, reference_type)` * **概要** 証券の関連データを取得します（例：正株に関連するワラントの取得、先物に関連する契約の取得） * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|銘柄コード reference_type|[SecurityReferenceType](./quote.md#3395)|取得する関連データ * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、証券の関連データ
str ret != RET_OK の場合、エラーの説明を返す
* 証券の関連データフォーマットは以下の通りです： フィールド|タイプ|説明 :-|:-|:- code|str|銘柄コード lot_size|int|1手あたりの株数。先物の場合は契約乗数 stock_type|[SecurityType](./quote.md#6687)|銘柄タイプ stock_name|str|銘柄名 list_time|str|上場時間 (フォーマット：yyyy-MM-dd 香港株と A 株市場のデフォルトは北京時間、米国株市場のデフォルトは米国東部時間) wrt_valid|bool|ワラントかどうか (True の場合、以下の wrt で始まるフィールドが有効です) wrt_type|[WrtType](./quote.md#1608)|ワラントタイプ wrt_code|str|所属正株 future_valid|bool|先物かどうか (True の場合、以下の future で始まるフィールドが有効です) future_main_contract|bool|かどうか主連契約 (先物特有フィールド) future_last_trade_time|str|最后取引時間 (先物特有フィールド主連，当月，下月等无このフィールド) * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) # 正株に関連するワラントを取得 ret, data = quote_ctx.get_referencestock_list('HK.00700', SecurityReferenceType.WARRANT) if ret == RET_OK: print(data) print(data['code'][0]) # 最初のレコードの銘柄コードを取得 print(data['code'].values.tolist()) # list に変換 else: print('error:', data) print('******************************************') # 香港先物関連契約 ret, data = quote_ctx.get_referencestock_list('HK.A50main', SecurityReferenceType.FUTURE) if ret == RET_OK: print(data) print(data['code'][0]) # 最初のレコードの銘柄コードを取得 print(data['code'].values.tolist()) # list に変換 else: print('error:', data) quote_ctx.close() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。 ``` * **Output** ```python code lot_size stock_type stock_name list_time wrt_valid wrt_type wrt_code future_valid future_main_contract future_last_trade_time 0 HK.24719 1000 WARRANT 腾讯东亚九四沽A 2018-07-20 True PUT HK.00700 False NaN NaN .. ... ... ... ... ... ... ... ... ... ... ... 1617 HK.63402 10000 WARRANT 腾讯高盛一八牛Y 2020-11-26 True BULL HK.00700 False NaN NaN [1618 rows x 11 columns] HK.24719 ['HK.24719', 'HK.27886', 'HK.28621', 'HK.14339', 'HK.27952', 'HK.18693', 'HK.20306', 'HK.53635', 'HK.47269', 'HK.27227', ... ... ... ... ... ... ... ... ... 'HK.63402'] ****************************************** code lot_size stock_type stock_name list_time wrt_valid wrt_type wrt_code future_valid future_main_contract future_last_trade_time 0 HK.A50main 5000 FUTURE 安硕富时 A50 ETF主连(2012) False NaN NaN True True .. ... ... ... ... ... ... ... ... ... ... ... 5 HK.A502106 5000 FUTURE 安硕富时 A50 ETF2106 False NaN NaN True False 2021-06-29 [6 rows x 11 columns] HK.A50main ['HK.A50main', 'HK.A502011', 'HK.A502012', 'HK.A502101', 'HK.A502103', 'HK.A502106'] ``` :::tip APIレート制限 * 30 秒以内に最大 10 回の銘柄関連データ API * 正株関連ワラントの取得時は、上記の頻度制限を受けません ::: --- # 取得先物契約情報 `get_future_info(code_list)` * **概要** 先物契約情報の取得 * **パラメータ** パラメータ|型|説明 :-|:-|:- code_list|list|銘柄コードリスト (list 内の要素の型は str) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、先物契約情報データ
str ret != RET_OK の場合、エラーの説明を返す
* 先物契約情報データフォーマットは以下の通りです： フィールド|タイプ|説明 :-|:-|:- code|str|銘柄コード name|str|銘柄名 owner|str|原資産 exchange|str|取引所 type|str|契約タイプ size|float|契約サイズ size_unit|str|契約サイズ単位 price_currency|str|建値通貨 price_unit|str|建値単位 min_change|float|最小変動幅 min_change_unit|str|最小変動幅の単位 (このフィールドは廃止済みです) trade_time|str|取引時間 time_zone|str|タイムゾーン last_trade_time|str|最后取引時間 (主連、当月、翌月等の先物にはこのフィールドはありません) exchange_format_url|str|取引所仕様链接 url origin_code|str|実際契約コード * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_future_info(["HK.MPImain", "HK.HAImain"]) if ret == RET_OK: print(data) print(data['code'][0]) # 最初のレコードの銘柄コードを取得 print(data['code'].values.tolist()) # list に変換 else: print('error:', data) quote_ctx.close() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。 ``` * **Output** ```python code name owner exchange type size size_unit price_currency price_unit min_change min_change_unit trade_time time_zone last_trade_time exchange_format_url origin_code 0 HK.MPImain 內房期货主连 恒生中国内地地产指数 港交所 股指期货 50.0 指数点×港元 港元 指数点 0.50 (09:15 - 12:00), (13:00 - 16:30) CCT https://sc.hkex.com.hk/TuniS/www.hkex.com.hk/P... HK.MPI2112 1 HK.HAImain 海通证券期货主连 HK.06837 港交所 股票期货 10000.0 股 港元 每股/港元 0.01 (09:30 - 12:00), (13:00 - 16:00) CCT https://sc.hkex.com.hk/TuniS/www.hkex.com.hk/P... HK.HAI2112 HK.MPImain ['HK.MPImain', 'HK.HAImain'] ``` :::tip APIレート制限 * 30 秒以内に最大 30 回先物契約情報API * 1 回のリクエストで指定できる先物銘柄数の上限は 200 個 ::: --- # 条件スクリーニング `get_stock_filter(market, filter_list, plate_code=None, begin=0, num=200)` * **概要** 条件スクリーニング * **パラメータ** パラメータ|型|説明 :-|:-|:- market|[Market](./quote.md#7040)|市場識別子 (上海株と深セン株は区別されません。いずれを入力しても上海・深セン市場の株式が返されます) filter_list|list|フィルタ条件のリスト (下記の表を参照。リスト内の要素タイプは SimpleFilter または AccumulateFilter または FinancialFilter) plate_code|str|セクターコード begin|int|データ起始点 num|int|リクエストデータ個数 * SimpleFilter オブジェクトの関連パラメータは以下の通りです： フィールド|タイプ|説明 :-|:-|:- stock_field|[StockField](./quote.md#3508)|シンプル属性 filter_min|float|範囲下限 (閉区間未指定の場合、デフォルトは -∞) filter_max|float|範囲上限 (閉区間未指定の場合、デフォルトは +∞) is_no_filter|bool|このフィールドでフィルタが不要かどうか (True：フィルタしないFalse：フィルタする未指定の場合はデフォルトでフィルタしない) sort|[SortDir](./quote.md#4889)|ソート方向 (未指定の場合、デフォルトはソートなし) * AccumulateFilter オブジェクトの関連パラメータは以下の通りです： フィールド|タイプ|説明 :-|:-|:- stock_field|[StockField](./quote.md#4889)|累積属性 filter_min|float|範囲下限 (閉区間未指定の場合、デフォルトは -∞) filter_max|float|範囲上限 (閉区間未指定の場合、デフォルトは +∞) is_no_filter|bool|このフィールドでフィルタが不要かどうか (True：フィルタしないFalse：フィルタする未指定の場合はデフォルトでフィルタしない) sort|[SortDir](./quote.md#4889)|ソート方向 (未指定の場合、デフォルトはソートなし) days|int|フィルタ対象データの累計日数 * FinancialFilter オブジェクトの関連パラメータは以下の通りです： フィールド|タイプ|説明 :-|:-|:- stock_field|[StockField](./quote.md#3508)|財務属性 filter_min|float|範囲下限 (閉区間未指定の場合、デフォルトは -∞) filter_max|float|範囲上限 (閉区間未指定の場合、デフォルトは +∞) is_no_filter|bool|このフィールドでフィルタが不要かどうか (True：フィルタしないFalse：フィルタする未指定の場合はデフォルトでフィルタしない) sort|[SortDir](./quote.md#4889)|ソート方向 (未指定の場合、デフォルトはソートなし) quarter|[FinancialQuarter](./quote.md#4889)|決算累积時間 * CustomIndicatorFilter オブジェクトの関連パラメータは以下の通りです： フィールド|タイプ|説明 :-|:-|:- stock_field1|[StockField](./quote.md#256)|カスタムテクニカル指標属性 stock_field1_para|list|カスタムテクニカル指標属性パラメータ (指標タイプに応じてパラメータを指定：1. MA：[移動平均周期] 2.EMA：[指数移動平均周期] 3.RSI：[RSI 指標周期] 4.MACD：[短期移動平均線値, 長期移動平均線値, DIF値] 5.BOLL：[移動平均線周期, 偏差値] 6.KDJ：[RSV 周期, K 値算出周期, D 値算出周期]) relative_position|[RelativePosition](./quote.md#1487)|相対位置 stock_field2|[StockField](./quote.md#256)|カスタムテクニカル指標属性 stock_field2_para|list|カスタムテクニカル指標属性パラメータ (指標タイプに応じてパラメータを指定：1. MA：[移動平均周期] 2.EMA：[指数移動平均周期] 3.RSI：[RSI 指標周期] 4.MACD：[短期移動平均線値, 長期移動平均線値, DIF値] 5.BOLL：[移動平均線周期, 偏差値] 6.KDJ：[RSV 周期, K 値算出周期, D 値算出周期]) value|float|カスタム数値 (stock_field2 で [StockField](./quote.md#256) のカスタム数値を選択した場合、value は必須パラメータです) ktype|[KLType](./quote.md#6493)|ローソク足タイプ KLType (K_60M、K_DAY、K_WEEK、K_MON の4種類の時間周期のみサポート) consecutive_period|int|連続周期（consecutive_period）すべてが条件を満たすデータをフィルタ (入力範囲は [1,12]) is_no_filter|bool|このフィールドでフィルタが不要かどうか (True：フィルタしないFalse：フィルタする未指定の場合はデフォルトでフィルタしない) * PatternFilter オブジェクトの関連パラメータは以下の通りです： フィールド|タイプ|説明 :-|:-|:- stock_field|[StockField](./quote.md#256)|パターンテクニカル指標属性 ktype|[KLType](./quote.md#6493)|ローソク足タイプ KLType（K_60M、K_DAY、K_WEEK、K_MON の4種類の時間周期のみサポート） consecutive_period|int|連続周期（consecutive_period）すべてが条件を満たすデータをフィルタ (入力範囲は [1,12]) is_no_filter|bool|このフィールドでフィルタが不要かどうか (True：フィルタしないFalse：フィルタする未指定の場合はデフォルトでフィルタしない) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data tuple ret == RET_OK の場合、選股データ
str ret != RET_OK の場合、エラーの説明を返す
* スクリーニングデータのタプル構成は以下の通りです： フィールド|タイプ|説明 :-|:-|:- last_page|bool|かどうか最后一页 all_count|int|リスト総数量 stock_list|list|選股データ (list 内の要素の型は FilterStockData) - FilterStockData タイプのフィールドフォーマット： フィールド|タイプ|説明 :-|:-|:- stock_code|str|銘柄コード stock_name|str|株式名字 cur_price|float|最新価格 cur_price_to_highest_52weeks_ratio|float|（現在値 - 52週高値）/ 52週高値 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) cur_price_to_lowest_52weeks_ratio|float|（現在値 - 52週安値）/ 52週安値 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) high_price_to_highest_52weeks_ratio|float|（本日高値 - 52週高値）/ 52週高値 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) low_price_to_lowest_52weeks_ratio|float|（本日安値 - 52週安値）/ 52週安値 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) volume_ratio|float|出来高比率 bid_ask_ratio|float|委託比率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) lot_price|float|每手価格 market_val|float|市值 pe_annual|float|PER pe_ttm|float|PER TTM pb_rate|float|PBR change_rate_5min|float|5分間騰落率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) change_rate_begin_year|float|年初来騰落率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) ps_ttm|float|PSR TTM (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) pcf_ttm|float|株価キャッシュフロー倍率 TTM (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) total_share|float|総股数 (単位：股) float_share|float|流通股数 (単位：股) float_market_val|float|流通時価総額 (単位：元) change_rate|float|騰落率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) amplitude|float|振幅 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) volume|float|日均出来高 turnover|float|日均売買代金 turnover_rate|float|売買回転率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) net_profit|float|純利益 net_profix_growth|float|純利益成長率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) sum_of_business|float|营业收入 sum_of_business_growth|float|売上高前年比成長率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) net_profit_rate|float|純利益率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) gross_profit_rate|float|売上総利益率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) debt_asset_rate|float|負債比率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) return_on_equity_rate|float|自己資本利益率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) roic|float|投下資本利益率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) roa_ttm|float|総資産利益率 TTM (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します。年次報告のみ適用) ebit_ttm|float|EBIT TTM (単位：元。年次報告のみ適用) ebitda|float|税息折旧及摊销前利润 (単位：元) operating_margin_ttm|float|営業利益率 TTM (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します。年次報告のみ適用) ebit_margin|float|EBIT マージン (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) ebitda_margin|float|EBITDA マージン (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) financial_cost_rate|float|財務費用率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) operating_profit_ttm|float|営業利益 TTM (単位：元。年次報告のみ適用) shareholder_net_profit_ttm|float|親会社に帰属する純利益 (単位：元。年次報告のみ適用) net_profit_cash_cover_ttm|float|利益に占める現金収入割合 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します。年次報告のみ適用) current_ratio|float|流動比率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) quick_ratio|float|当座比率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) current_asset_ratio|float|流動資産比率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) current_debt_ratio|float|流動負債比率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) equity_multiplier|float|權益乘数 property_ratio|float|持分比率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) cash_and_cash_equivalents|float|现金和现金等価 (単位：元) total_asset_turnover|float|総資産回転率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) fixed_asset_turnover|float|固定資産回転率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) inventory_turnover|float|棚卸資産回転率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) operating_cash_flow_ttm|float|営業キャッシュフロー TTM (単位：元。年次報告のみ適用) accounts_receivable|float|売掛金淨额 (単位：元) ebit_growth_rate|float|EBIT 前年比成長率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) operating_profit_growth_rate|float|営業利益前年比成長率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) total_assets_growth_rate|float|総資産前年比成長率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) profit_to_shareholders_growth_rate|float|親会社帰属純利益前年比成長率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) profit_before_tax_growth_rate|float|税引前利益前年比成長率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) eps_growth_rate|float|EPS 前年比成長率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) roe_growth_rate|float|ROE 前年比成長率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) roic_growth_rate|float|ROIC 前年比成長率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) nocf_growth_rate|float|営業キャッシュフロー前年比成長率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) nocf_per_share_growth_rate|float|1株あたり営業キャッシュフロー前年比成長率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) operating_revenue_cash_cover|float|営業キャッシュ収入比率 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) operating_profit_to_total_profit|float|営業利益構成比 (このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します) basic_eps|float|基本每股收益 (単位：元) diluted_eps|float|希薄化後EPS (単位：元) nocf_per_share|float|1株当たり営業キャッシュフロー (単位：元) price|float|最新価格 ma|float|単純移動平均線 (MA パラメータに基づく具体的な数値を返します) ma5|float|5日単純移動平均線 ma10|float|10日単純移動平均線 ma20|float|20日単純移動平均線 ma30|float|30日単純移動平均線 ma60|float|60日単純移動平均線 ma120|float|120日単純移動平均線 ma250|float|250日単純移動平均線 rsi|float|RSI 値 (RSI パラメータに基づく具体的な数値を返します。RSI デフォルトパラメータは 12) ema|float|指数移動平均線 (EMA パラメータに基づく具体的な数値を返します) ema5|float|5日指数移動移動平均線 ema10|float|10日指数移動移動平均線 ema20|float|20日指数移動移動平均線 ema30|float|30日指数移動移動平均線 ema60|float|60日指数移動移動平均線 ema120|float|120日指数移動移動平均線 ema250|float|250日指数移動移動平均線 kdj_k|float|KDJ 指標の K 値 (KDJ パラメータに基づく具体的な数値を返します。KDJ デフォルトパラメータは [9,3,3]) kdj_d|float|KDJ 指標の D 値 (KDJ パラメータに基づく具体的な数値を返します。KDJ デフォルトパラメータは [9,3,3]) kdj_j|float|KDJ 指標の J 値 (KDJ パラメータに基づく具体的な数値を返します。KDJ デフォルトパラメータは [9,3,3]) macd_diff|float|MACD 指標の DIFF 値 (MACD パラメータに基づく具体的な数値を返します。MACD デフォルトパラメータは [12,26,9]) macd_dea|float|MACD 指標の DEA 値 (MACD パラメータに基づく具体的な数値を返します。MACD デフォルトパラメータは [12,26,9]) macd|float|MACD 指標の MACD 値 (MACD パラメータに基づく具体的な数値を返します。MACD デフォルトパラメータは [12,26,9]) boll_upper|float|BOLL 指標の UPPER 値 (BOLL パラメータに基づく具体的な数値を返します。BOLL デフォルトパラメータは [20,2]) boll_middler|float|BOLL 指標の MIDDLER 値 (BOLL パラメータに基づく具体的な数値を返します。BOLL デフォルトパラメータは [20,2]) boll_lower|float|BOLL 指標の LOWER 値 (BOLL パラメータに基づく具体的な数値を返します。BOLL デフォルトパラメータは [20,2]) * **Example** ```python from moomoo import * import time quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) simple_filter = SimpleFilter() simple_filter.filter_min = 2 simple_filter.filter_max = 1000 simple_filter.stock_field = StockField.CUR_PRICE simple_filter.is_no_filter = False # simple_filter.sort = SortDir.ASCEND financial_filter = FinancialFilter() financial_filter.filter_min = 0.5 financial_filter.filter_max = 50 financial_filter.stock_field = StockField.CURRENT_RATIO financial_filter.is_no_filter = False financial_filter.sort = SortDir.ASCEND financial_filter.quarter = FinancialQuarter.ANNUAL custom_filter = CustomIndicatorFilter() custom_filter.ktype = KLType.K_DAY custom_filter.stock_field1 = StockField.KDJ_K custom_filter.stock_field1_para = [10,4,4] custom_filter.stock_field2 = StockField.KDJ_K custom_filter.stock_field2_para = [9,3,3] custom_filter.relative_position = RelativePosition.MORE custom_filter.is_no_filter = False nBegin = 0 last_page = False ret_list = list() while not last_page: nBegin += len(ret_list) ret, ls = quote_ctx.get_stock_filter(market=Market.HK, filter_list=[simple_filter, financial_filter, custom_filter], begin=nBegin) # 香港市場の株式に対して簡易、財務、指標フィルタを実行 if ret == RET_OK: last_page, all_count, ret_list = ls print('all count = ', all_count) for item in ret_list: print(item.stock_code) # 取銘柄コード print(item.stock_name) # 取銘柄名 print(item[simple_filter]) # simple_filter に対応する変数値を取得 print(item[financial_filter]) # financial_filter に対応する変数値を取得 print(item[custom_filter]) # custom_filter の数値を取得 else: print('error: ', ls) time.sleep(3) # 加入時間间隔，避免触発限频 quote_ctx.close() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。 ``` * **Output** ```python 39 39 [ stock_code:HK.08103 stock_name:HMVOD视频 cur_price:2.69 current_ratio(annual):4.413 , stock_code:HK.00376 stock_name:云锋金融 cur_price:2.96 current_ratio(annual):12.585 , stock_code:HK.09995 stock_name:荣昌生物-B cur_price:92.65 current_ratio(annual):16.054 , stock_code:HK.80737 stock_name:湾区発展-R cur_price:2.8 current_ratio(annual):17.249 , stock_code:HK.00737 stock_name:湾区発展 cur_price:3.25 current_ratio(annual):17.249 , stock_code:HK.03939 stock_name:万国国际矿业 cur_price:2.22 current_ratio(annual):17.323 , stock_code:HK.01055 stock_name:中国南方航空股份 cur_price:5.17 current_ratio(annual):17.529 , stock_code:HK.02638 stock_name:港灯-SS cur_price:7.68 current_ratio(annual):21.255 , stock_code:HK.00670 stock_name:中国东方航空股份 cur_price:3.53 current_ratio(annual):25.194 , stock_code:HK.01952 stock_name:云顶新耀-B cur_price:69.5 current_ratio(annual):26.029 , stock_code:HK.00089 stock_name:大生地产 cur_price:4.22 current_ratio(annual):26.914 , stock_code:HK.00728 stock_name:中国电信 cur_price:2.81 current_ratio(annual):27.651 , stock_code:HK.01372 stock_name:比速科技 cur_price:5.1 current_ratio(annual):28.303 , stock_code:HK.00753 stock_name:中国国航 cur_price:6.38 current_ratio(annual):31.828 , stock_code:HK.01997 stock_name:九龙仓置业 cur_price:43.75 current_ratio(annual):33.239 , stock_code:HK.02158 stock_name:医渡科技 cur_price:39.0 current_ratio(annual):34.046 , stock_code:HK.02588 stock_name:中银航空租赁 cur_price:77.0 current_ratio(annual):34.531 , stock_code:HK.01330 stock_name:绿色動力环保 cur_price:3.36 current_ratio(annual):35.028 , stock_code:HK.01525 stock_name:建桥教育 cur_price:6.28 current_ratio(annual):36.989 , stock_code:HK.09908 stock_name:嘉兴燃气 cur_price:10.02 current_ratio(annual):37.848 , stock_code:HK.06078 stock_name:海吉亚医疗 cur_price:49.8 current_ratio(annual):39.0 , stock_code:HK.01071 stock_name:华电国际电力股份 cur_price:2.16 current_ratio(annual):39.507 , stock_code:HK.00357 stock_name:美兰空港 cur_price:34.15 current_ratio(annual):39.514 , stock_code:HK.00762 stock_name:中国联通 cur_price:5.15 current_ratio(annual):40.74 , stock_code:HK.01787 stock_name:山东黄金 cur_price:15.56 current_ratio(annual):41.604 , stock_code:HK.00902 stock_name:华能国际电力股份 cur_price:2.66 current_ratio(annual):42.919 , stock_code:HK.00934 stock_name:中石化冠德 cur_price:2.96 current_ratio(annual):43.361 , stock_code:HK.01117 stock_name:现代牧业 cur_price:2.3 current_ratio(annual):45.037 , stock_code:HK.00177 stock_name:江苏宁沪高速公路 cur_price:8.78 current_ratio(annual):45.93 , stock_code:HK.01379 stock_name:温岭工量刃具 cur_price:5.71 current_ratio(annual):46.774 , stock_code:HK.01876 stock_name:百威亚太 cur_price:22.5 current_ratio(annual):46.917 , stock_code:HK.01907 stock_name:中国旭阳集团 cur_price:4.38 current_ratio(annual):47.129 , stock_code:HK.02160 stock_name:心通医疗-B cur_price:15.54 current_ratio(annual):47.384 , stock_code:HK.00293 stock_name:国泰航空 cur_price:7.1 current_ratio(annual):47.983 , stock_code:HK.00694 stock_name:北京首都机场股份 cur_price:6.34 current_ratio(annual):47.985 , stock_code:HK.09922 stock_name:九毛九 cur_price:26.65 current_ratio(annual):48.278 , stock_code:HK.01083 stock_name:港华燃气 cur_price:3.39 current_ratio(annual):49.2 , stock_code:HK.00291 stock_name:华润啤酒 cur_price:58.0 current_ratio(annual):49.229 , stock_code:HK.00306 stock_name:冠忠巴士集团 cur_price:2.29 current_ratio(annual):49.769 ] HK.08103 HMVOD视频 2.69 2.69 4.413 ... HK.00306 冠忠巴士集团 2.29 2.29 49.769 ``` :::tip ご注意 * [サブセクターリスト取得関数](../quote/get-plate-list.md) でサブセクターコードを取得します。条件スクリーニングに対応するセクターは以下の通りです 1. 香港株の業種セクターとテーマセクター。 2. 米国株の業種セクター 3. A株の業種セクター、テーマセクター、地域セクター * 対応するセクター指数コード コード|説明 :-|:- HK.Motherboard|香港株メインボード HK.GEM|香港株GEM（成長企業市場） HK.BK1911|H株メインボード HK.BK1912|H株GEM（成長企業市場） US.NYSE|ニューヨーク証券取引所 US.AMEX|アメリカン証券取引所 US.NASDAQ|ナスダック SH.3000000|上海メインボード SZ.3000001|深センメインボード SZ.3000004|深セン創業板（ChiNext） ::: :::tip APIレート制限 * 30秒以内に条件スクリーニングAPIを最大10回までリクエスト可能です * 1ページあたりのフィルタ結果は最大200件です * フィルタ条件は250個以下を推奨します。超過すると「業務処理タイムアウト」が発生する場合があります * 累積属性の同一フィルタ条件数の上限は10個です * 「最新値」などの動的データをソートフィールドとして使用する場合、複数ページの取得間隔中にソート順が変わる場合があります * 異なるタイプの指標間の比較には対応していません。同じタイプの指標間でのみ比較関係を構築できます。異なるタイプの指標間の比較はエラーになります。例：MA5とMA10は比較可能。MA5とEMA10は比較不可。 * カスタム指標属性の同一タイプのフィルタ条件数の上限は10個です * 基本属性、財務属性、パターン属性では同一フィールドに対するフィルタ条件の重複指定に対応していません * 条件スクリーニングは米国株のプレマーケット・アフターマーケット・ナイトセッションに対応していません。フィルタ結果はすべて立会時間中のデータで返されます ::: --- # 銘柄スクリーニング V2 `get_stock_screen(request)` * **説明** 条件付き銘柄スクリーニング V2。旧 API [get_stock_filter](./get-stock-filter.md) と比較して、指標カバレッジがより広く（11 種類で計 244+ 個の指標）、数値はすべて原始値で渡します（OpenD が自動的に倍率変換）。単一フィールドまたは複数フィールドのソートに対応し、取得属性を明示的に宣言します。結果は `value_type` に応じて `sval` / `ival` / `aval` / `dval` に振り分けられます。 * **パラメータ** パラメータ|タイプ|説明 :-|:-|:- request|StockScreenRequest|条件付きスクリーニングリクエストオブジェクト。builder 方式で構築 * StockScreenRequest フィールド： フィールド|タイプ|説明 :-|:-|:- page_from|int|ページング開始位置 (デフォルトは 0) page_count|int|1 ページあたりの最大返却件数 (デフォルトは 200) * フィルタ条件 builder メソッド（呼び出すごとにフィルタ条件を 1 件追加。すべての数値フィールドは原始値を直接渡し、OpenD が自動的に倍率変換）： メソッド|説明 :-|:- add_simple_field(field, values)|市場 / 取引所 / 指数 / お気に入り銘柄などの列挙フィールドフィルタ (field は [SimpleField](./quote.md#1036) から取得；values は列挙値リスト（OR 関係）。ScrMarket.MY / JP / SG は今後サポート予定、現在は結果が空となる) add_plate(plate_ids, parent_plate_id=None)|プレートフィルタ (plate_ids は ["BK1001"] のような形式) add_simple_property(name, lower=None, upper=None)|シンプル相場属性区間フィルタ (name は [SimpleProperty](./quote.md#3458) から取得（現在値、時価総額、PE、出来高比率など）；lower / upper は原始値、例えば現在値 10 元は 10、時価総額 ≥ 100 億は 10_000_000_000) add_cumulative_property(name, days=1, lower=None, upper=None)|累積相場属性 (name は [CumulativeProperty](./quote.md#7431) から取得；days は累積期間。変動率系（PRICE_CHANGE_PCT 等）の値は**小数**で渡す（5% は 0.05、5.0 ではない）) add_financial_property(name, term=None, year=None, lower=None, upper=None, ...)|財務属性 (name は [FinancialProperty](./quote.md#9745) から取得；term は Term 列挙から取得（Q1=1、年報=100、最新単四半期=10 など）。Term.SURPRISE_LATEST 系列（200~204）は HK/US ともに値を返すが、現状 ANNUAL と同一値となるため使用には注意) add_indicator_positional(first_indicator_name, period_type, position, second_indicator=None, ...)|テクニカル指標の位置関係 (例えば MA5 が MA20 を上抜く。指標名/周期/位置は [Indicator / Period / Position](./quote.md#823) から取得) add_indicator_pattern(name, period_type, ...)|テクニカル指標形態（ゴールデンクロス、デッドクロス、ダイバージェンスなど） (name は [Pattern](./quote.md#823) から取得) add_featured_property(name, intervals=None, value_set=None, period=None, range_period=None, first_custom_param=None)|特色指標（チップ、ヒート、アナリスト評価、資金フローなど） add_broker_holdings(name, days=None, param=None, intervals=None)|ブローカー保有比率指標 (香港株のみ。サポート：6101 集中度 / 6103 数 / 6106 中央決済保有割合 / 6107 中央決済保有変動。非サポート：6102 保有変動、6104 ブローカーランキング、6105 ブローカー保有量。6101 / 6106 / 6107 は倍率 1000、パーセント値で渡す（例えば 20% は 20）；6103 は倍率なし。intervals は dict 配列で、キーは `filterMin` / `filterMax`。`days` パラメータは無効) add_kline_shape(name, period=None, value_set=None)|ローソク足形態（ダブルボトム、ヘッドアンドショルダーなど） (period 必須、現在は日 K(11) と 1 時間 K(21) のみサポート) add_option(name, intervals=None, param=None, period=None)|オプション指標（原株 IV、HV など） * 取得属性 builder メソッド（返す属性を宣言；宣言しないと stock_id のみ返す）： メソッド|説明 :-|:- add_retrieve_basic(name)|コード / 名称 / 業界 (name は [BasicProperty](./quote.md#55) から取得：CODE=1101、NAME=1102、INDUSTRY=1103) add_retrieve_simple(name)|シンプル相場属性 (name は [SimpleProperty](./quote.md#3458) から取得) add_retrieve_cumulative(name, days=1, period_average=None)|累積属性 (name は [CumulativeProperty](./quote.md#7431) から取得) add_retrieve_financial(name, term=None, year=None, ...)|財務属性 (name は [FinancialProperty](./quote.md#9745) から取得) add_retrieve_indicator(name, period=None, indicator_params=None)|テクニカル指標 add_retrieve_featured(name, period=None, range_period=None, first_custom_param=None)|特色属性 add_retrieve_broker(name, days=None, param=None)|ブローカー add_retrieve_option(name, param=None, period=None)|オプション属性 add_retrieve_kline_shape(name, period=None)|ローソク足形態 (period 必須、そうでないと結果が返らない；現在は日 K(11) と 1 時間 K(21) のみサポート) * ソート builder メソッド： メソッド|説明 :-|:- set_sort(direction, property_type, property_params)|単一フィールドソート (direction は ScrSortDir から：ASC=1、DESC=2、ABS_ASC=3、ABS_DESC=4。property_type は 'basic' / 'simple' / 'cumulative' / 'financial' / 'indicator' / 'featured' / 'broker' / 'option' / 'kline_shape' のいずれか) add_sort(direction, property_type, property_params)|複数フィールドソート (呼び出し順で適用；set_sort と二者択一、sortList が非空のとき優先) * **戻り値**
パラメータ タイプ 説明
ret RET_CODE API 呼び出し結果
data tuple ret == RET_OK のとき、(last_page, all_count, items) を返す
str ret != RET_OK のとき、エラー記述を返す
* 戻り値 tuple フィールド： フィールド|タイプ|説明 :-|:-|:- last_page|bool|最終ページか否か all_count|int|条件を満たす総件数 items|list[dict]|現ページの結果リスト、要素構造は `{'stock_id': int, 'results': [result, ...]}` * 単一 result の構造： フィールド|タイプ|説明 :-|:-|:- type|str|属性タイプ ('basic' / 'simple' / 'cumulative' / 'financial' / 'indicator' / 'featured' / 'broker' / 'option' / 'kline_shape') property|dict|対応する property 記述（name / days / term などを含む） value_type|int|値タイプ (1=string(sval)、2=int64(ival)、3=int64 配列(aval)、4=double(dval)。OpenD にデータがない場合は value_type のみ配信され（通常 2）、sval/ival/aval/dval は全て欠落する（例：香港株の Q2/Q3/Q4 財務データ）) sval|str|文字列値（value_type=1 のとき存在） ival|int|整数値（value_type=2 のとき存在） aval|list[int]|整数配列値（value_type=3 のとき存在） dval|float|浮動小数点値（value_type=4 のとき存在） enum_type_name|str|ival が列挙コードの場合、対応する列挙型名（例：'KlineShapeType'） enum_name|str|ival が列挙コードの場合、OpenD/SDK がデコードした列挙名（例：'DOUBLE_BOTTOMS'、'NONE'） end_time|int|決算終了タイムスタンプ (financial タイプのみ。現行 OpenD では未配信のため、実際の戻り値には通常含まれない) * **Example** ```python from moomoo import OpenQuoteContext, RET_OK, StockScreenRequest from moomoo.quote.stock_screen_const import ( ScrMarket, ScrSortDir, SimpleField, SimpleProperty, CumulativeProperty, FinancialProperty, Term, Indicator, Period, Position, Pattern, BasicProperty, KlineShapeProperty, KlineShapeType, ) quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) # 例 1：香港株の大型株 + MACD ゴールデンクロス req = StockScreenRequest() req.add_simple_field(field=SimpleField.MARKET, values=[ScrMarket.HK]) req.add_simple_property(name=SimpleProperty.PRICE, lower=10.0) # 最新値 ≥ 10 req.add_simple_property(name=SimpleProperty.MARKET_CAP, lower=10_000_000_000.0) # 時価総額 ≥ 100 億 req.add_simple_property(name=SimpleProperty.PE_TTM, lower=10.0, upper=50.0) # PER(TTM) 10~50 req.add_indicator_pattern(name=Pattern.MACD_GOLD_CROSS, period_type=Period.DAY) # MACD ゴールデンクロス # 取得フィールド req.add_retrieve_basic(name=BasicProperty.CODE) req.add_retrieve_basic(name=BasicProperty.NAME) req.add_retrieve_simple(name=SimpleProperty.PRICE) req.add_retrieve_simple(name=SimpleProperty.MARKET_CAP) req.add_retrieve_simple(name=SimpleProperty.PE_TTM) # ソート req.set_sort(direction=ScrSortDir.DESC, property_type='simple', property_params={'name': int(SimpleProperty.MARKET_CAP)}) req.page_count = 50 ret, data = quote_ctx.get_stock_screen(req) if ret == RET_OK: last_page, all_count, items = data print(f"総件数 {all_count}, 現在の返却 {len(items)} 件") for it in items[:3]: print(it['stock_id'], it['results']) else: print('error: ', data) # 例 2：財務指標 + 累積変化率 req = StockScreenRequest() req.add_simple_field(field=SimpleField.MARKET, values=[ScrMarket.HK]) req.add_cumulative_property(name=CumulativeProperty.PRICE_CHANGE_PCT, days=5, lower=-0.05, upper=0.05) # 5 日変化率 -5%~5%（小数で渡す） req.add_financial_property(name=FinancialProperty.NET_PROFIT, term=Term.ANNUAL, lower=0.0) # 年次決算純利益 > 0 req.add_retrieve_basic(name=BasicProperty.CODE) req.add_retrieve_simple(name=SimpleProperty.PRICE) req.page_count = 200 ret, data = quote_ctx.get_stock_screen(req) # 例 3：K 線パターン（W ボトム + ヘッドアンドショルダーボトム） req = StockScreenRequest() req.add_simple_field(field=SimpleField.MARKET, values=[ScrMarket.HK]) req.add_kline_shape(name=KlineShapeProperty.SHAPE_TYPE, period=Period.DAY, value_set=[KlineShapeType.DOUBLE_BOTTOMS, KlineShapeType.HEAD_SHOULDERS_BOTTOM]) req.add_retrieve_basic(name=BasicProperty.CODE) req.add_retrieve_kline_shape(name=KlineShapeProperty.SHAPE_TYPE, period=Period.DAY) ret, data = quote_ctx.get_stock_screen(req) quote_ctx.close() ``` * **Output** ```python 合計 1, 今回 1 件 54047868453564 [{'type': 'basic', 'property': {'name': 1101}, 'value_type': 1, 'sval': '00700'}, {'type': 'basic', 'property': {'name': 1102}, 'value_type': 1, 'sval': 'テンセント・ホールディングス'}, {'type': 'simple', 'property': {'name': 2201}, 'value_type': 4, 'dval': 460.0}, {'type': 'simple', 'property': {'name': 2301}, 'value_type': 4, 'dval': 4194280264040.0}, {'type': 'simple', 'property': {'name': 2303}, 'value_type': 4, 'dval': 15.75126}] ``` * **フィールド別例（カテゴリ別）** > 以下の例はすべて HK 市場を対象とします：まず `req = StockScreenRequest()`、次に `req.add_simple_field(field=SimpleField.MARKET, values=[ScrMarket.HK])`、 > 続けて各セクションのフィルタ / 取得 / ソート条件を重ね、最後に `quote_ctx.get_stock_screen(req)` で `(last_page, all_count, items)` を取得します。 > 実測の `head` は `results` 配列内の対応 property 値を展開しています（code/name は BasicProperty.CODE/NAME から、ファクター列名は SDK のフィールド名小文字）。 #### シンプル相場属性 SimpleProperty `add_simple_property(name, lower, upper)` で渡す。`lower/upper` は元の値を直接渡す（円/株/百分率 5% は 5.0） ##### `PRICE`（id=2201 · simple · SimpleProperty） 現在値 単位：通貨建て；lower/upper は元の価格をそのまま渡す、OpenD が自動倍率変換 ```python req.add_simple_property(name=SimpleProperty.PRICE, lower=10.0) req.add_retrieve_simple(name=SimpleProperty.PRICE) req.set_sort(direction=ScrSortDir.DESC, property_type='simple', property_params={'name': int(SimpleProperty.PRICE)}) ``` 実測返却（HK · all_count=485、ヒット 5 行、head 先頭 5）： ``` stock_id code name price 47704201761008 04336 应用材料-T 1620.0 87836376173009 02513 智谱 1097.0 47704201761005 04333 思科-T 750.0 86839943761574 03750 宁德时代 672.5 87840671141778 03986 兆易创新 653.5 ``` ##### `MARKET_CAP`（id=2301 · simple · SimpleProperty） 時価総額 単位：通貨建て；lower=100 億は 10_000_000_000 と記述 ```python req.add_simple_property(name=SimpleProperty.MARKET_CAP, lower=10_000_000_000.0) req.add_retrieve_simple(name=SimpleProperty.MARKET_CAP) req.set_sort(direction=ScrSortDir.DESC, property_type='simple', property_params={'name': int(SimpleProperty.MARKET_CAP)}) ``` 実測返却（HK · all_count=591、ヒット 5 行、head 先頭 5）： ``` stock_id code name market_cap 54047868453564 00700 腾讯控股 4222484299075.2 83820581829436 80700 腾讯控股-R 3641391766113.6 86839943761574 03750 宁德时代 3111406771825.0 47704201761005 04333 思科-T 2956075998750.0 57754425230710 01398 工商银行 2573253176182.58 ``` ##### `PE_TTM`（id=2303 · simple · SimpleProperty） PE(TTM) 通常の区間フィルタ；負値も可 ```python req.add_simple_property(name=SimpleProperty.PE_TTM, lower=5.0, upper=20.0) req.add_retrieve_simple(name=SimpleProperty.PE_TTM) req.set_sort(direction=ScrSortDir.ASC, property_type='simple', property_params={'name': int(SimpleProperty.PE_TTM)}) ``` 実測返却（HK · all_count=830、ヒット 5 行、head 先頭 5）： ``` stock_id code name pe_ttm 28604482191640 00280 景福集团 5.0 67345087202619 01339 中国人民保险集团 5.037 68629282424057 01273 香港信贷 5.0847 76063870813891 01731 其利工业集团 5.0877 35433480192608 00608 达利国际 5.0877 ``` ##### `VOLUME_RATIO`（id=2217 · simple · SimpleProperty） 出来高比率 当日出来高 / N 日平均出来高；> 2 で大量取引 ```python req.add_simple_property(name=SimpleProperty.VOLUME_RATIO, lower=2.0) req.add_retrieve_simple(name=SimpleProperty.VOLUME_RATIO) req.set_sort(direction=ScrSortDir.DESC, property_type='simple', property_params={'name': int(SimpleProperty.VOLUME_RATIO)}) ``` 実測返却（HK · all_count=340、ヒット 5 行、head 先頭 5）： ``` stock_id code name volume_ratio 50796578209975 00183 宏辉集团 600.0 45999099741384 01224 中渝置地 404.642 1543 01543 中盈盛达融资担保 400.714 24142011170996 00180 开达集团 314.999 5033701671181 00269 中国资源交通 200.0 ``` ##### `DIVIDEND_RATIO`（id=2305 · simple · SimpleProperty） 配当利回り 単位：% ；配当利回り ≥ 5% は 5.0 と渡す ```python req.add_simple_property(name=SimpleProperty.DIVIDEND_RATIO, lower=5.0) req.add_retrieve_simple(name=SimpleProperty.DIVIDEND_RATIO) req.set_sort(direction=ScrSortDir.DESC, property_type='simple', property_params={'name': int(SimpleProperty.DIVIDEND_RATIO)}) ``` 実測返却（HK · all_count=0、ヒット 0 行）：データなし。理由：HK の現在サンプルに配当利回り ≥ 5% の銘柄なし。lower 閾値を下げて再試行可 #### 累積相場属性 CumulativeProperty `add_cumulative_property(name, days, lower, upper)` で渡す。**百分率系（騰落率/出来高回転率）は小数で渡す**（5% は 0.05） ##### `PRICE_CHANGE_PCT`（id=3102 · cumulative · CumulativeProperty） N 日騰落率 % **百分率は小数で渡す**：5% は 0.05；`days` は N 日累計ウィンドウ ```python req.add_cumulative_property(name=CumulativeProperty.PRICE_CHANGE_PCT, days=5, lower=0.05) req.add_retrieve_cumulative(name=CumulativeProperty.PRICE_CHANGE_PCT, days=5) req.set_sort(direction=ScrSortDir.DESC, property_type='cumulative', property_params={'name': int(CumulativeProperty.PRICE_CHANGE_PCT), 'days': 5}) ``` 実測返却（HK · all_count=363、ヒット 5 行、head 先頭 5）： ``` stock_id code name change_pct_5d 88510686038921 02953 嬴集团股权 4.0 77640123811704 01912 康特隆 2.7679 47704201761005 04333 思科-T 2.2029 88467736365964 02956 中国健康科技股权 1.6667 47704201761008 04336 应用材料-T 1.4384 ``` ##### `AMPLITUDE`（id=3103 · cumulative · CumulativeProperty） N 日振幅 % PRICE_CHANGE_PCT と同じ、百分率は小数で渡す ```python req.add_cumulative_property(name=CumulativeProperty.AMPLITUDE, days=20, lower=0.1) req.add_retrieve_cumulative(name=CumulativeProperty.AMPLITUDE, days=20) req.set_sort(direction=ScrSortDir.DESC, property_type='cumulative', property_params={'name': int(CumulativeProperty.AMPLITUDE), 'days': 20}) ``` 実測返却（HK · all_count=2345、ヒット 5 行、head 先頭 5）： ``` stock_id code name amp_20d 47704201761008 04336 应用材料-T 43.3783 55671366092780 02028 映美控股 9.0893 59558311493749 00117 天利控股集团 8.0532 42623255446398 00894 万裕科技 7.59 88433376627363 02723 深演智能 6.3243 ``` ##### `AVG_VOLUME`（id=3104 · cumulative · CumulativeProperty） N 日平均出来高 単位：株；N 日出来高の算術平均 ```python req.add_cumulative_property(name=CumulativeProperty.AVG_VOLUME, days=20, lower=1_000_000) req.add_retrieve_cumulative(name=CumulativeProperty.AVG_VOLUME, days=20) req.set_sort(direction=ScrSortDir.DESC, property_type='cumulative', property_params={'name': int(CumulativeProperty.AVG_VOLUME), 'days': 20}) ``` 実測返却（HK · all_count=2295、ヒット 5 行、head 先頭 5）： ``` stock_id code name avg_vol_20d 84688165145005 02477 经纬天地 15586288027 58506044508119 02007 碧桂园 11318232417 69325067126991 02255 海昌海洋公园 10691740000 81462644703252 00020 商汤-W 9517974535 79671643350793 09993 金辉控股 7418314265 ``` ##### `TURNOVER_RATIO`（id=3106 · cumulative · CumulativeProperty） N 日累計売買代金率 単位：% ；百分率は小数で渡す（5% は 0.05） ```python req.add_cumulative_property(name=CumulativeProperty.TURNOVER_RATIO, days=20, lower=0.05) req.add_retrieve_cumulative(name=CumulativeProperty.TURNOVER_RATIO, days=20) req.set_sort(direction=ScrSortDir.DESC, property_type='cumulative', property_params={'name': int(CumulativeProperty.TURNOVER_RATIO), 'days': 20}) ``` 実測返却（HK · all_count=800、ヒット 5 行、head 先頭 5）： ``` stock_id code name turnover_ratio_20d 58196806861368 00568 山东墨龙 6.7527 84688165145005 02477 经纬天地 3.8966 88089779243675 02715 埃斯顿 3.7288 84434762074537 02473 喜相逢集团 3.4646 87230785784391 02631 天岳先进 3.2208 ``` #### 財務属性 FinancialProperty `add_financial_property(name, term, year, lower, upper)` で渡す。`term` は `Term` 列挙（年報=100、Q1=1、TTM 系は term 不要）；**比率系は小数で渡す**（15% は 0.15） ##### `NET_PROFIT`（id=4101 · financial · FinancialProperty） 純利益 単位：通貨建て；term=ANNUAL(100) 年報、Q1=1、Q2/Q3/Q4 は部分期間 ```python req.add_financial_property(name=FinancialProperty.NET_PROFIT, term=Term.ANNUAL, lower=1_000_000_000.0) req.add_retrieve_financial(name=FinancialProperty.NET_PROFIT, term=Term.ANNUAL) req.set_sort(direction=ScrSortDir.DESC, property_type='financial', property_params={'name': int(FinancialProperty.NET_PROFIT), 'term': int(Term.ANNUAL)}) ``` 実測返却（HK · all_count=437、ヒット 5 行、head 先頭 5）： ``` stock_id code name net_profit 57754425230710 01398 工商银行 412328868600.0 56186762167211 00939 建设银行 377880459000.0 63586990818568 01288 农业银行 324736536300.0 57118770073492 03988 中国银行 286850625600.0 83820581829436 80700 腾讯控股-R 255561692100.0 ``` ##### `ROE`（id=4110 · financial · FinancialProperty） 自己資本利益率 単位：% ；百分率は小数で渡す（15% は 0.15）；term=ANNUAL ```python req.add_financial_property(name=FinancialProperty.ROE, term=Term.ANNUAL, lower=0.15) req.add_retrieve_financial(name=FinancialProperty.ROE, term=Term.ANNUAL) req.set_sort(direction=ScrSortDir.DESC, property_type='financial', property_params={'name': int(FinancialProperty.ROE), 'term': int(Term.ANNUAL)}) ``` 実測返却（HK · all_count=322、ヒット 5 行、head 先頭 5）： ``` stock_id code name roe 62487479191132 01628 禹洲集团 40.644 69823283339309 08237 华星控股 12.6906 52845277610549 00565 锦艺集团控股 3.0644 86882893433405 02621 手回集团 2.7027 64969970288874 02282 美高梅中国 2.6886 ``` ##### `REVENUE_GROWTH`（id=4106 · financial · FinancialProperty） 売上前年比成長率 単位：% ；百分率は小数で渡す（20% は 0.20）；term=ANNUAL ```python req.add_financial_property(name=FinancialProperty.REVENUE_GROWTH, term=Term.ANNUAL, lower=0.20) req.add_retrieve_financial(name=FinancialProperty.REVENUE_GROWTH, term=Term.ANNUAL) req.set_sort(direction=ScrSortDir.DESC, property_type='financial', property_params={'name': int(FinancialProperty.REVENUE_GROWTH), 'term': int(Term.ANNUAL)}) ``` 実測返却（HK · all_count=638、ヒット 5 行、head 先頭 5）： ``` stock_id code name revenue_growth 46772193854353 00913 港湾数字 106.7922 88377542057458 07666 剂泰科技-P 73.067 53047141075220 02324 首都创投 63.5792 43589623088228 01124 沿海家园 26.7323 74259984551169 03329 交银国际 20.5256 ``` ##### `BASIC_EPS`（id=4801 · financial · FinancialProperty） 基本一株利益 単位：通貨建て；term=ANNUAL ```python req.add_financial_property(name=FinancialProperty.BASIC_EPS, term=Term.ANNUAL, lower=1.0) req.add_retrieve_financial(name=FinancialProperty.BASIC_EPS, term=Term.ANNUAL) req.set_sort(direction=ScrSortDir.DESC, property_type='financial', property_params={'name': int(FinancialProperty.BASIC_EPS), 'term': int(Term.ANNUAL)}) ``` 実測返却（HK · all_count=324、ヒット 5 行、head 先頭 5）： ``` stock_id code name basic_eps 86998857554659 06883 颖通控股 123007487.548 88261577939456 06656 思格新能 139.457 69290707392656 06288 FAST RETAIL-DRS 74.984 80418967660265 09961 携程集团-S 56.044 85439784425509 06181 老铺黄金 31.388 ``` ##### `DIVIDENDS_TTM_RATIO`（id=4219 · financial · FinancialProperty） TTM 配当利回り 単位：% ；百分率は小数で渡す；TTM 系は term/year 不要 ```python req.add_financial_property(name=FinancialProperty.DIVIDENDS_TTM_RATIO, lower=0.05) req.add_retrieve_financial(name=FinancialProperty.DIVIDENDS_TTM_RATIO) req.set_sort(direction=ScrSortDir.DESC, property_type='financial', property_params={'name': int(FinancialProperty.DIVIDENDS_TTM_RATIO)}) ``` 実測返却（HK · all_count=463、ヒット 5 行、head 先頭 5）： ``` stock_id code name div_ttm_ratio 50856707752105 00169 万达酒店发展 4.0526 2136 02136 利福中国 0.6562 77622943942788 02180 万宝盛华 0.3752 75419625726233 08473 弥明生活百货 0.3303 64896955845349 02789 远大中国 0.2994 ``` #### テクニカル指標位置関係 Indicator `add_indicator_positional(first_indicator_name, period_type, position, second_indicator=None, value=None, first_indicator_params=None)` で渡す。`position` は `Position`（OVER=1、BELOW=2、CROSS_UP=3、CROSS_DOWN=4） ##### `MA5 / MA20`（id=11 · indicator · Indicator） MA5 が MA20 を上抜け add_indicator_positional：first/second はいずれも `Indicator` 列挙の名称 ```python req.add_indicator_positional(first_indicator_name=Indicator.MA5, period_type=Period.DAY, position=Position.CROSS_UP, second_indicator=Indicator.MA20) ``` 実測返却（HK · all_count=67、ヒット 5 行、head 先頭 5）： ``` stock_id code name 88356067214548 01236 乐动机器人 88313117542845 02493 迈威生物-B 88179973556902 02726 瀚天天成 87033217287972 01828 富卫集团 86968792779992 03288 海天味业 ``` ##### `RSI`（id=52 · indicator · Indicator） RSI 買われ過ぎ（>70） 指標パラメータは first_indicator_params で渡す、例：RSI 周期 14 ```python req.add_indicator_positional(first_indicator_name=Indicator.RSI, period_type=Period.DAY, position=Position.OVER, second_value=70, first_indicator_params=[14]) ``` 実測返却（HK · all_count=97、ヒット 5 行、head 先頭 5）： ``` stock_id code name 88502096109937 08561 爱世纪集团股权 88476326299379 01779 天辰生物-B 88450556496782 02958 远见控股(旧) 88416196762328 06872 丹诺医药-B 88407606823814 02950 升能集团(旧) ``` ##### `MACD_DIF`（id=41 · indicator · Indicator） MACD DIF が 0 軸上 second_value は単一閾値；position=OVER は DIF > value の意味 ```python req.add_indicator_positional(first_indicator_name=Indicator.MACD_DIF, period_type=Period.DAY, position=Position.OVER, second_value=0) ``` 実測返却（HK · all_count=786、ヒット 5 行、head 先頭 5）： ``` stock_id code name 88476326299379 01779 天辰生物-B 88467736365964 02956 中国健康科技股权 88450556496782 02958 远见控股(旧) 88437671594888 02952 杭品生活科技股权 88433376627363 02723 深演智能 ``` ##### `PRICE / BOLL_UPPER`（id=1 · indicator · Indicator） 株価がボリンジャー上限突破 PRICE(1) と BOLL_UPPER(61) の位置関係を比較 ```python req.add_indicator_positional(first_indicator_name=Indicator.PRICE, period_type=Period.DAY, position=Position.CROSS_UP, second_indicator=Indicator.BOLL_UPPER) ``` 実測返却（HK · all_count=50、ヒット 5 行、head 先頭 5）： ``` stock_id code name 87544318404244 09876 大洋环球控股 85864986184208 02576 太美医疗科技 84482006714840 02520 山西安装 83000243002163 06963 阳光保险 82961588291781 02245 力勤资源 ``` #### テクニカル指標形状 Pattern `add_indicator_pattern(name, period_type)` で渡す。`name` は `Pattern` 列挙 ##### `MACD_GOLD_CROSS`（id=21 · pattern · Pattern） MACD ゴールデンクロス add_indicator_pattern：name は Pattern 列挙 ```python req.add_indicator_pattern(name=Pattern.MACD_GOLD_CROSS, period_type=Period.DAY) ``` 実測返却（HK · all_count=116、ヒット 5 行、head 先頭 5）： ``` stock_id code name 88502096109937 08561 爱世纪集团股权 88416196764014 08558 麦迪森控股(旧) 88265872906147 06051 有赞 86998857553944 06168 周六福 86822763895471 06831 绿茶集团 ``` ##### `KDJ_GOLD_CROSS`（id=11 · pattern · Pattern） KDJ ゴールデンクロス 同上、K が D を上抜け ```python req.add_indicator_pattern(name=Pattern.KDJ_GOLD_CROSS, period_type=Period.DAY) ``` 実測返却（HK · all_count=179、ヒット 5 行、head 先頭 5）： ``` stock_id code name 88480621267856 02960 ALCO HOLD RTS 88420491725703 02951 京玖康疗(旧) 88179973556702 02526 德适-B 87746181861167 03887 HASHKEY HLDGS 87741886892639 02655 果下科技 ``` ##### `BOLL_BREAK_UPPER`（id=41 · pattern · Pattern） 株価がボリンジャー上限突破 BOLL 形状系 41~44 ```python req.add_indicator_pattern(name=Pattern.BOLL_BREAK_UPPER, period_type=Period.DAY) ``` 実測返却（HK · all_count=50、ヒット 5 行、head 先頭 5）： ``` stock_id code name 87544318404244 09876 大洋环球控股 85864986184208 02576 太美医疗科技 84482006714840 02520 山西安装 83000243002163 06963 阳光保险 82961588291781 02245 力勤资源 ``` #### 特色指標 FeaturedProperty `add_featured_property(name, intervals, value_set, period, range_period, first_custom_param)` で渡す。区間は `intervals=[{...}]`、列挙は `value_set=[...]` ##### `SHORT_POSITION`（id=5110 · featured · FeaturedProperty） 空売り残高 単位：株；intervals 不要 ```python req.add_featured_property(name=FeaturedProperty.SHORT_POSITION) req.add_retrieve_featured(name=FeaturedProperty.SHORT_POSITION) req.set_sort(direction=ScrSortDir.DESC, property_type='featured', property_params={'name': int(FeaturedProperty.SHORT_POSITION)}) ``` 実測返却（HK · all_count=0、ヒット 0 行）：データなし。理由：当該 featured ファクターは HK ではデータ未公開、US 市場へ切替えて照会 ##### `ANALYST_RATING`（id=5401 · featured · FeaturedProperty） アナリスト評価 列挙値：1=強い買い、2=買い、3=保有、4=売り、5=強い売り；value_set 配列を渡す ```python req.add_featured_property(name=FeaturedProperty.ANALYST_RATING, value_set=[1, 2]) req.add_retrieve_featured(name=FeaturedProperty.ANALYST_RATING) req.set_sort(direction=ScrSortDir.ASC, property_type='featured', property_params={'name': int(FeaturedProperty.ANALYST_RATING)}) ``` 実測返却（HK · all_count=0、ヒット 0 行）：データなし。理由：カバレッジの高い US 市場へ切替えるか value_set を緩和 ##### `ANALYST_TARGET_PRICE`（id=5403 · featured · FeaturedProperty） アナリスト目標株価 単位：通貨建て；区間は dict 配列 `[{'lower': {'value': X, 'includes': True}}]` ```python req.add_featured_property(name=FeaturedProperty.ANALYST_TARGET_PRICE, intervals=[{'lower': {'value': 100.0, 'includes': True}}]) req.add_retrieve_featured(name=FeaturedProperty.ANALYST_TARGET_PRICE) req.set_sort(direction=ScrSortDir.DESC, property_type='featured', property_params={'name': int(FeaturedProperty.ANALYST_TARGET_PRICE)}) ``` 実測返却（HK · all_count=0、ヒット 0 行）：データなし。理由：カバレッジの高い US 市場へ切替えるか intervals 下限を緩和 ##### `HIST_PERCENTILE_PE`（id=5502 · featured · FeaturedProperty） 現在 PE の履歴パーセンタイル range_period 必須：RangePeriod 列挙 (THREE_MONTHS=1、SIX_MONTHS=2、ONE_YEAR=3、THREE_YEARS=4) ```python req.add_featured_property(name=FeaturedProperty.HIST_PERCENTILE_PE, range_period=RangePeriod.THREE_YEARS, intervals=[{'upper': {'value': 0.30, 'includes': True}}]) req.add_retrieve_featured(name=FeaturedProperty.HIST_PERCENTILE_PE, range_period=RangePeriod.THREE_YEARS) req.set_sort(direction=ScrSortDir.ASC, property_type='featured', property_params={'name': int(FeaturedProperty.HIST_PERCENTILE_PE), 'rangePeriod': int(RangePeriod.THREE_YEARS)}) ``` 実測返却（HK · all_count=0、ヒット 0 行）：データなし。理由：HK の一部銘柄は履歴 PE データなし。range_period / intervals を緩和可 ##### `CASH_FLOW_MAIN_NET_IN`（id=5901 · featured · FeaturedProperty） 主力資金純流入 単位：通貨建て；資金流入は CashFlowPeriod 列挙 (DAY=1、WEEK=2、MONTH_P=3、QUARTER=4) ```python req.add_featured_property(name=FeaturedProperty.CASH_FLOW_MAIN_NET_IN, range_period=CashFlowPeriod.DAY, intervals=[{'lower': {'value': 10_000_000.0, 'includes': True}}]) req.add_retrieve_featured(name=FeaturedProperty.CASH_FLOW_MAIN_NET_IN, range_period=CashFlowPeriod.DAY) req.set_sort(direction=ScrSortDir.DESC, property_type='featured', property_params={'name': int(FeaturedProperty.CASH_FLOW_MAIN_NET_IN), 'rangePeriod': int(CashFlowPeriod.DAY)}) ``` 実測返却（HK · all_count=0、ヒット 0 行）：データなし。理由：HK 実測でデータなし。US 市場かより短い周期を推奨 #### ブローカー保有 BrokerProperty `add_broker_holdings(name, days, param, intervals)` で渡す。**HK のみ**；`days` パラメータは無効。 - **サポート指標**：6101 集中度 / 6103 数 / 6106 中央決済保有割合 / 6107 中央決済保有変動 - **非サポート指標**：6102 保有変動、6104 ブローカーランキング、6105 ブローカー保有量 - **倍率**：6101 / 6106 / 6107 倍率 1000、百分率で渡す（20% は 20）；6103 は倍率なし（整数） - **intervals の使い方**：dict 配列、キーは `filterMin` / `filterMax`（**`lower` / `upper` ではない**）、片側/両側区間に対応。例：`[{'filterMin': {'value': 20.0, 'includes': True}}]` あるいは `[{'filterMin': {'value': 20.0, 'includes': True}, 'filterMax': {'value': 50.0, 'includes': False}}]` ##### `CONCENTRATED_DISTRIBUTION`（id=6101 · broker · BrokerProperty） ブローカー集中度 HK のみ；intervals は dict 配列で渡す、単位 %（20% は 20.0） ```python req.add_broker_holdings(name=BrokerProperty.CONCENTRATED_DISTRIBUTION, intervals=[{'filterMin': {'value': 20.0, 'includes': True}}]) req.add_retrieve_broker(name=BrokerProperty.CONCENTRATED_DISTRIBUTION) req.set_sort(direction=ScrSortDir.DESC, property_type='broker', property_params={'name': int(BrokerProperty.CONCENTRATED_DISTRIBUTION)}) ``` ##### `CENTRAL_HOLDINGS_RATIO`（id=6106 · broker · BrokerProperty） 中央決済保有割合 HK のみ；intervals は dict 配列、単位 % ```python req.add_broker_holdings(name=BrokerProperty.CENTRAL_HOLDINGS_RATIO, intervals=[{'filterMin': {'value': 10.0, 'includes': True}}]) req.add_retrieve_broker(name=BrokerProperty.CENTRAL_HOLDINGS_RATIO) req.set_sort(direction=ScrSortDir.DESC, property_type='broker', property_params={'name': int(BrokerProperty.CENTRAL_HOLDINGS_RATIO)}) ``` ##### `BROKER_NUM`（id=6103 · broker · BrokerProperty） 当該銘柄保有のブローカー数 HK のみ；整数（intervals は dict 配列） ```python req.add_broker_holdings(name=BrokerProperty.BROKER_NUM, intervals=[{'filterMin': {'value': 100, 'includes': True}}]) req.add_retrieve_broker(name=BrokerProperty.BROKER_NUM) req.set_sort(direction=ScrSortDir.DESC, property_type='broker', property_params={'name': int(BrokerProperty.BROKER_NUM)}) ``` #### K 線形状 KlineShapeProperty `add_kline_shape(name, period, value_set)` で渡す。`period` 必須、現在は日 K(`Period.DAY`=11) と 1 時間 K(`Period.HOUR_1`=5) のみ対応 ##### `SHAPE_TYPE`（id=6200 · kline_shape · KlineShapeProperty） K 線形状検出 period 必須：日 K=11、1 時間 K=5（実測で SDK ドキュメント表記と差異あり） ```python req.add_kline_shape(name=KlineShapeProperty.SHAPE_TYPE, period=Period.DAY, value_set=[KlineShapeType.DOUBLE_BOTTOMS, KlineShapeType.HEAD_SHOULDERS_BOTTOM]) req.add_retrieve_kline_shape(name=KlineShapeProperty.SHAPE_TYPE, period=Period.DAY) ``` 実測返却（HK · all_count=0、ヒット 0 行）：データなし。理由：指定形状＋区間でヒットなし、value_set を緩和可 ##### `RISE_PROB`（id=6201 · kline_shape · KlineShapeProperty） 形状後の上昇確率 単位：% ；SHAPE_TYPE と併用 ```python req.add_kline_shape(name=KlineShapeProperty.SHAPE_TYPE, period=Period.DAY, value_set=[KlineShapeType.DOUBLE_BOTTOMS]) req.add_retrieve_kline_shape(name=KlineShapeProperty.RISE_PROB, period=Period.DAY) req.set_sort(direction=ScrSortDir.DESC, property_type='kline_shape', property_params={'name': int(KlineShapeProperty.RISE_PROB), 'period': int(Period.DAY)}) ``` 実測返却（HK · all_count=0、ヒット 0 行）：データなし。理由：SHAPE_TYPE と併用；HK サンプルでヒットなし #### オプション属性 OptionProperty `add_option(name, intervals, param, period)` で渡す。原資産の IV / HV などオプション軸で絞り込みに使用 ##### `STOCK_IV`（id=1000 · option · OptionProperty） 原資産オプションの IV 単位：% ；intervals は dict 配列；period は OptionHVPeriod 列挙 ```python req.add_option(name=OptionProperty.STOCK_IV, intervals=[{'lower': {'value': 30.0, 'includes': True}}]) req.add_retrieve_option(name=OptionProperty.STOCK_IV) req.set_sort(direction=ScrSortDir.DESC, property_type='option', property_params={'name': int(OptionProperty.STOCK_IV)}) ``` 実測返却（HK · all_count=0、ヒット 0 行）：データなし。理由：オプションが揃う市場（US）へ切替えるか intervals 下限を緩和 ##### `STOCK_IV_RANK`（id=1001 · option · OptionProperty） 原資産 IV ランク 0~100；現在の IV が履歴範囲に占める相対位置（intervals は dict 配列） ```python req.add_option(name=OptionProperty.STOCK_IV_RANK, intervals=[{'lower': {'value': 50.0, 'includes': True}}]) req.add_retrieve_option(name=OptionProperty.STOCK_IV_RANK) req.set_sort(direction=ScrSortDir.DESC, property_type='option', property_params={'name': int(OptionProperty.STOCK_IV_RANK)}) ``` 実測返却（HK · all_count=0、ヒット 0 行）：データなし。理由：オプションが揃う市場（US）へ切替えるか intervals 下限を緩和 ##### `STOCK_HV`（id=1006 · option · OptionProperty） 原資産ヒストリカルボラ 単位：% ；intervals は dict 配列；period は OptionHVPeriod 列挙 ```python req.add_option(name=OptionProperty.STOCK_HV, intervals=[{'lower': {'value': 20.0, 'includes': True}}]) req.add_retrieve_option(name=OptionProperty.STOCK_HV) req.set_sort(direction=ScrSortDir.DESC, property_type='option', property_params={'name': int(OptionProperty.STOCK_HV)}) ``` 実測返却（HK · all_count=0、ヒット 0 行）：データなし。理由：オプションが揃う市場（US）へ切替えるか intervals 下限を緩和 :::tip APIレート制限 * 30秒以内に銘柄スクリーニング API を最大10回までリクエスト可能です ::: --- # 取得セクター内銘柄リスト `get_plate_stock(plate_code, sort_field=SortField.CODE, ascend=True)` * **概要** 指定セクター内の銘柄リストを取得、株価指数の構成銘柄を取得 * **パラメータ** パラメータ|型|説明 :-|:-|:- plate_code|str|セクターコード (まず[セクターリストの取得](../quote/get-plate-list.md)でセクターコードを取得してください例："SH.BK0001"、"SH.BK0002") sort_field|[SortField](./quote.md#3508)|ソートフィールド ascend|bool|ソート方向 (True：昇順False：降順) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、セクター株式データ
str ret != RET_OK の場合、エラーの説明を返す
* セクター株式データ フィールド|タイプ|説明 :-|:-|:- code|str|銘柄コード lot_size|int|1手あたりの株数。先物の場合は契約乗数 stock_name|str|銘柄名 stock_type|[SecurityType](./quote.md#3508)|株式タイプ list_time|str|上場時間 (フォーマット：yyyy-MM-dd 香港株と A 株市場のデフォルトは北京時間、米国株市場のデフォルトは米国東部時間) stock_id|int|株式 ID main_contract|bool|かどうか主連契約 (先物特有フィールド) last_trade_time|str|最后取引時間 (先物特有フィールド主連、当月、翌月等の先物にはこのフィールドはありません) * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_plate_stock('HK.BK1001') if ret == RET_OK: print(data) print(data['stock_name'][0]) # 最初の銘柄名を取得 print(data['stock_name'].values.tolist()) # list に変換 else: print('error:', data) quote_ctx.close() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。 ``` * **Output** ```python code lot_size stock_name stock_owner stock_child_type stock_type list_time stock_id main_contract last_trade_time 0 HK.00462 4000 天然乳品 NaN NaN STOCK 2005-06-10 55589761712590 False .. ... ... ... ... ... ... ... ... ... ... 9 HK.06186 1000 中国飞鹤 NaN NaN STOCK 2019-11-13 78159814858794 False [10 rows x 10 columns] 天然乳品 ['天然乳品', '现代牧业', '雅士利国际', '原生態牧业', '中国圣牧', '中地乳业', '庄园牧场', '澳优', '蒙牛乳业', '中国飞鹤'] ``` :::tip APIレート制限 * 30 秒以内に最大 10 回セクター内銘柄リストAPI ::: ::: details よく使用されるセクター、指数コード コード|説明 :-|:- HK.HSI Constituent Stocks|恒指成份股 HK.HSCEI Stock|国指成份股 HK.Motherboard|香港株主板 HK.GEM|香港株創业板 HK.LIST1910|所有香港株 HK.LIST1911|主板 H 股 HK.LIST1912|創业板 H 股 HK.Fund|ETF（香港株基金） HK.LIST1600|熱度榜（港） HK.LIST1921|已上場新股-香港株 SH.LIST3000000|上海主板 SH.LIST0901|上证 B 股 SH.LIST0902|深证 B 股 SH.LIST3000002|沪深指数 SH.LIST3000005|全 A 株（上海・深圳） SH.LIST0600|熱度榜（沪深） SH.LIST0992|科創板 SH.LIST0921|已上場新股-A 株 SZ.LIST3000001|深证主板 SZ.LIST3000003|中小板 SZ.LIST3000004|創业板（深） US.USAALL|全米国株 ::: --- # 取得セクターリスト `get_plate_list(market, plate_class)` * **概要** 取得セクターリスト * **パラメータ** パラメータ|型|説明 :-|:-|:- market|[Market](./quote.md#5423)|市場識別子 (ご注意：上海と深センは区別されません。いずれを入力しても上海・深セン市場のサブセクターが返されます) plate_class|[Plate](./quote.md#5910)|セクター分類 * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、セクターリストデータ
str ret != RET_OK の場合、エラーの説明を返す
* セクターリストデータフォーマットは以下の通りです： フィールド|タイプ|説明 :-|:-|:- code|str|セクターコード plate_name|str|セクター名字 plate_id|str|セクター ID * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_plate_list(Market.HK, Plate.CONCEPT) if ret == RET_OK: print(data) print(data['plate_name'][0]) # 最初のセクター名称を取得 print(data['plate_name'].values.tolist()) # list に変換 else: print('error:', data) quote_ctx.close() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。 ``` * **Output** ```python code plate_name plate_id 0 HK.BK1000 做空集合股 BK1000 .. ... ... ... 77 HK.BK1999 殡葬概念 BK1999 [78 rows x 3 columns] 做空集合股 ['做空集合股', '阿里概念股', '雄安概念股', '苹果概念', '一带一路', '5G概念', '夜店股', '粤港澳大湾区', '特斯拉概念股', '啤酒', '疑似财技股', '体育用品', '稀土概念', '人民币升值概念', '抗疫概念', '新股与次新股', '腾讯概念', '云办公', 'SaaS概念', '在线教育', '汽车经销商', '挪威政府全球养老基金持仓', '武汉本地概念股', '核电', '内地医药股', '化妆美容股', '科网股', '公用股', '石油股', '电讯设备', '电力股', '手游股', '婴儿及小童用品股', '百货业股', '收租股', '港口运输股', '电信股', '环保', '煤炭股', '汽车股', '电池', '物流', '内地物业管理股', '农业股', '黄金股', '奢侈品股', '电力设备股', '连锁快餐店', '重型机械股', '食品股', '内险股', '纸业股', '水务股', '奶制品股', '光伏太阳能股', '内房股', '内地教育股', '家电股', '风电股', '蓝筹地产股', '内银股', '航空股', '石化股', '建材水泥股', '中资券商股', '高铁基建股', '燃气股', '公路及铁路股', '钢铁金属股', '华為概念', 'OLED概念', '工业大麻', '香港本地股', '香港零售股', '区块链', '猪肉概念', '节假日概念', '殡葬概念'] ``` :::tip APIレート制限 * 30 秒以内に最大 10 回セクターリストAPI ::: --- # 静的データの取得 `get_stock_basicinfo(market, stock_type=SecurityType.STOCK, code_list=None)` * **概要** 取得静態データ * **パラメータ** パラメータ|型|説明 :-|:-|:- market|[Market](./quote.md#3611)|市場タイプ stock_type|[SecurityType](./quote.md#6687)|株式タイプ。ただし SecurityType.DRVT の指定は対応していません code_list|list|銘柄リスト (- デフォルトは None で、全市場の株式の静的情報を取得します - 銘柄リストを指定した場合、指定した株式の情報のみ返します - オプションの受け入れをサポート - list 内の要素の型は str) 注：market と code_list の両方が指定された場合、market は無視され、code_list のみで照会が行われます。 * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、株式静態データ
str ret != RET_OK の場合、エラーの説明を返す
* 株式静的データフォーマットは以下の通りです： フィールド|タイプ|説明 :-|:-|:- code|str|銘柄コード name|str|銘柄名 lot_size|int|1手あたりの株数。オプションの場合は1枚あたりの株数 (指数オプションにはこのフィールドはありません)、先物の場合は契約乗数 stock_type|[SecurityType](./quote.md#6687)|株式タイプ stock_child_type|[WrtType](./quote.md#1608)|ワラント子タイプ stock_owner|str|ワラントが属する正株のコード、またはオプションの原資産株のコード option_type|[OptionType](./quote.md#1635)|オプションタイプ strike_time|str|オプション行使日 (フォーマット：yyyy-MM-dd 香港株と A 株市場のデフォルトは北京時間、米国株市場のデフォルトは米国東部時間) strike_price|float|オプション行使価格 suspension|bool|オプションかどうか売買停止 (True：売買停止中False：未売買停止) listing_date|str|上場日 (このフィールドはメンテナンス終了のため、使用は推奨しません フォーマット：yyyy-MM-dd) stock_id|int|株式 ID delisting|bool|かどうか退市 index_option_type|str|指数オプションタイプ main_contract|bool|かどうか主連契約 last_trade_time|str|最后取引時間 (主連、当月、翌月等の先物にはこのフィールドはありません) exchange_type|[ExchType](./quote.html#3573)|所属取引所 * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_stock_basicinfo(Market.HK, SecurityType.STOCK) if ret == RET_OK: print(data) else: print('error:', data) print('******************************************') ret, data = quote_ctx.get_stock_basicinfo(Market.HK, SecurityType.STOCK, ['HK.06998', 'HK.00700']) if ret == RET_OK: print(data) print(data['name'][0]) # 最初の銘柄名を取得 print(data['name'].values.tolist()) # list に変換 else: print('error:', data) quote_ctx.close() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。 ``` * **Output** ```python code name lot_size stock_type stock_child_type stock_owner option_type strike_time strike_price suspension listing_date stock_id delisting index_option_type main_contract last_trade_time exchange_type 0 HK.00001 长和 500 STOCK N/A N/A N/A N/A 2015-03-18 4440996184065 False N/A False HK_MAINBOARD ... ... ... ... ... ... ... ... ... ... ... ... ... ... ... ... ... 2592 HK.09979 绿城管理控股 1000 STOCK N/A N/A N/A 2020-07-10 79203491915515 False N/A False HK_MAINBOARD [2593 rows x 16 columns] ****************************************** code name lot_size stock_type stock_child_type stock_owner option_type strike_time strike_price suspension listing_date stock_id delisting index_option_type main_contract last_trade_time exchange_type 0 HK.06998 嘉和生物-B 500 STOCK N/A N/A N/A 2020-10-07 79572859099990 False N/A False HK_MAINBOARD 1 HK.00700 腾讯控股 100 STOCK N/A N/A N/A 2004-06-16 54047868453564 False N/A False HK_MAINBOARD 嘉和生物-B ['嘉和生物-B', '腾讯控股'] ``` :::tip ご注意 * プログラムが認識できない株式（かなり前に上場廃止になった株式や存在しない株式を含む）を指定した場合、このAPIは株式情報を返し、「上場廃止かどうか」フィールドで該当株式が存在しないことを示します。統一的な処理として、コードは通常通り表示され、株式名は「不明株式」と表示され、その他のフィールドはデフォルト値（整数型のデフォルトは 0、文字列型のデフォルトは空文字列）となります。 * このAPIは他の相場情報APIとは異なり、他のAPIではプログラムが認識できない株式を受け取った場合、リクエストを拒否し「不明株式」というエラー説明を返します。 * オプションデータ（例：ギリシャ文字、満期日、未平倉建玉）を取得するには、[取得スナップショット](./get-market-snapshot.md)をご利用ください。 ::: --- # 取得 IPO 情報 `get_ipo_list(market)` * **概要** 指定市場の IPO 情報の取得 * **パラメータ** パラメータ|型|説明 :-|:-|:- market|[Market](./quote.md#7040)|市場識別子 (ご注意：上海と深センは区別されません。いずれを入力しても上海・深セン市場の株式が返されます) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、 IPO データ
str ret != RET_OK の場合、エラーの説明を返す
* IPO データ フィールド|タイプ|説明 :-|:-|:- code|str|銘柄コード name|str|銘柄名 list_time|str|上場日，米国株是予计上場日 (フォーマット：yyyy-MM-dd) list_timestamp|float|上場日タイムスタンプ，米国株是予计上場日タイムスタンプ apply_code|str|申込コード（A 株適用） issue_size|int|発行総数（A 株适用）；発行量（米国株、シンガポール、マレーシア、日本适用） online_issue_size|int|网上発行量（A 株适用） apply_upper_limit|int|申购上限（A 株适用） apply_limit_market_value|int|顶格申购需配市值（A 株适用） is_estimate_ipo_price|bool|かどうか推定発行価格（A 株适用） ipo_price|float|発行価格 (推定値は募集資金、発行数量、発行費用などのデータ変動により変わる可能性があり、参考値です。実際のデータ公表後に速やかに更新されます)（A 株适用） industry_pe_rate|float|行业PER（A 株适用） is_estimate_winning_ratio|bool|かどうか推定中签率（A 株适用） winning_ratio|float|当選率 (- 推定値は募集資金、発行数量、発行費用などのデータ変動により変わる可能性があり、参考値です。実際のデータ公表後に速やかに更新されます - このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します)（A 株適用） issue_pe_rate|float|発行PER（A 株适用） apply_time|str|申込日文字列 (フォーマット：yyyy-MM-dd)（A 株适用） apply_timestamp|float|申込日タイムスタンプ（A 株适用） winning_time|str|当選発表日文字列 (フォーマット：yyyy-MM-dd)（A 株、シンガポール、マレーシア适用） winning_timestamp|float|当選発表日タイムスタンプ（A 株、シンガポール、マレーシア适用） is_has_won|bool|当選番号が公表済みかどうか（A 株适用） winning_num_data|str|中签号（A 株适用） (フォーマット類似：末"五"位数：12345，12346末"六"位数：123456) ipo_price_min|float|最低発售価（香港株适用）；最低発行価格（米国株、シンガポール、日本适用） ipo_price_max|float|最高発售価（香港株适用）；最高発行価格（米国株、シンガポール、日本适用） list_price|float|上場価格（香港株适用） lot_size|int|1ロットの株数 entrance_price|float|入场费（香港株适用） is_subscribe_status|bool|申込受付中かどうか (True：申込中False：上場待ち) apply_end_time|str|申込締切日文字列 (フォーマット：yyyy-MM-dd)（香港株、シンガポール、マレーシア适用） apply_end_timestamp|float|申込締切日タイムスタンプ|申込手続きの処理が必要なため、申込締切時間は取引所公表の日付より早くなります（香港株、シンガポール、マレーシア适用） apply_start_time|str|申込開始日文字列 (フォーマット：yyyy-MM-dd)（シンガポール、マレーシア適用） apply_start_timestamp|float|申込開始日タイムスタンプ（シンガポール、マレーシア適用） offer_price|float|発行価格（マレーシア適用） * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_ipo_list(Market.HK) if ret == RET_OK: print(data) print(data['code'][0]) # 最初のレコードの銘柄コードを取得 print(data['code'].values.tolist()) # list に変換 else: print('error:', data) quote_ctx.close() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。 ``` * **Output** ```python code name list_time list_timestamp apply_code issue_size online_issue_size apply_upper_limit apply_limit_market_value is_estimate_ipo_price ipo_price industry_pe_rate is_estimate_winning_ratio winning_ratio issue_pe_rate apply_time apply_timestamp winning_time winning_timestamp is_has_won winning_num_data ipo_price_min ipo_price_max list_price lot_size entrance_price is_subscribe_status apply_end_time apply_end_timestamp apply_start_time apply_start_timestamp offer_price 0 HK.06666 恒大物业 2020-12-02 1.606838e+09 N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A 8.500 9.75 0.0 500 4924.12 True 2020-11-26 1.606352e+09 N/A N/A N/A 1 HK.02110 裕勤控股 2020-12-07 1.607270e+09 N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A 0.225 0.27 0.0 10000 2727.21 True 2020-11-27 1.606439e+09 N/A N/A N/A HK.06666 ['HK.06666', 'HK.02110'] ``` ::: tip APIレート制限 * 30 秒以内に最大 10 回 IPO 情報API ::: --- # 取得グローバル市場状態 `get_global_state()` * **概要** グローバル状態の取得 * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data dict ret == RET_OK の場合、グローバル状態
str ret != RET_OK の場合、エラーの説明を返す
* グローバル状態データフォーマットは以下の通りです： フィールド|タイプ|説明 :-|:-|:- market_sz|[MarketState](./quote.md#3508)|深圳市場状態 market_sh|[MarketState](./quote.md#3508)|上海市場状態 market_hk|[MarketState](./quote.md#3508)|香港市場状態 market_hkfuture|[MarketState](./quote.md#3508)|香港先物市場状態 (商品によって取引時間が異なるため、 [get_market_state](../quote/get-market-state.md) API で指定商品の市場状態を取得することを推奨します) market_usfuture|[MarketState](./quote.md#3508)|美国先物市場状態 (商品によって取引時間が異なるため、 [get_market_state](../quote/get-market-state.md) API で指定商品の市場状態を取得することを推奨します) market_us|[MarketState](./quote.md#3508)|美国市場状態 (商品によって取引時間が異なるため、 [get_market_state](../quote/get-market-state.md) API で指定商品の市場状態を取得することを推奨します) market_sgfuture|[MarketState](./quote.md#3508)|新加坡先物市場状態 (商品によって取引時間が異なるため、 [get_market_state](../quote/get-market-state.md) API で指定商品の市場状態を取得することを推奨します) market_jpfuture|[MarketState](./quote.md#3508)|日本先物市場状態 market_sg|[MarketState](./quote.md#3508)|シンガポール市場状態 market_my|[MarketState](./quote.md#3508)|マレーシア市場状態 market_jp|[MarketState](./quote.md#3508)|日本市場状態 server_ver|str|OpenD バージョン番号 trd_logined|bool|True：ログイン済み取引サーバー，False：未ログイン取引サーバー qot_logined|bool|True：ログイン済み相場サーバー，False：未ログイン相場サーバー timestamp|str|現在のグリニッジタイムスタンプ (単位：秒) local_timestamp|float| OpenD 実行マシンの現在のタイムスタンプ (単位：秒) program_status_type|[ProgramStatusType](../ftapi/common.md#7462)|現在の状態 program_status_desc|str|额外描述 * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) print(quote_ctx.get_global_state()) quote_ctx.close() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。 ``` * **Output** ```python (0, {'market_sz': 'MORNING', 'market_us': 'AFTER_HOURS_END', 'market_sh': 'MORNING', 'market_hk': 'MORNING', 'market_hkfuture': 'FUTURE_DAY_OPEN', 'market_usfuture': 'FUTURE_OPEN', 'market_sgfuture': 'FUTURE_DAY_OPEN', 'market_jpfuture': 'FUTURE_DAY_OPEN', 'server_ver': '504', 'trd_logined': True, 'timestamp': '1620962951', 'qot_logined': True, 'local_timestamp': 1620962951.047128, 'program_status_type': 'READY', 'program_status_desc': ''}) ``` --- # 取引カレンダーの取得 `request_trading_days(market=None, start=None, end=None, code=None)` * **概要** 指定市場 / 指定銘柄の取引カレンダーをリクエストします。 注意：この取引日は暦日から週末と祝日を除いたものであり、臨時休場は含まれていません。 * **パラメータ** パラメータ|型|説明 :-|:-|:- market|[TradeDateMarket](./quote.md#2605)|市場タイプ start|str|起始日付 (形式：yyyy-MM-dd 例如：“2018-01-01”) end|str|結束日付 (形式：yyyy-MM-dd 例如：“2018-01-01”) code| str | 銘柄コード 注：market と code が同時に指定された場合、market は無視され、code のみで検索されます。 * startとendの組み合わせは以下の通り Start タイプ|End タイプ|説明 :-|:-|:- str|str|start と end がそれぞれ指定された日付 None|str|start 為 end 往前 365 天 str|None|end 為 start 往后 365 天 None|None|start 為往前 365 天，end 現在の日付 * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data list 当 ret == RET_OK 时，返す取引日データ。list 中元素タイプ為 dict
str 当 ret != RET_OK 时，返すエラー説明
* 取引日データのフォーマットは以下の通り： フィールド|タイプ|説明 :-|:-|:- time|str|時刻 (形式：yyyy-MM-dd) trade_date_type|[TradeDateType](./quote.md#5125)|取引日タイプ * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.request_trading_days(market=TradeDateMarket.HK, start='2020-04-01', end='2020-04-10') if ret == RET_OK: print('HK market calendar:', data) else: print('error:', data) print('******************************************') ret, data = quote_ctx.request_trading_days(start='2020-04-01', end='2020-04-10', code='HK.00700') if ret == RET_OK: print('HK.00700 calendar:', data) else: print('error:', data) quote_ctx.close() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。 ``` * **Output** ```python HK market calendar: [{'time': '2020-04-01', 'trade_date_type': 'WHOLE'}, {'time': '2020-04-02', 'trade_date_type': 'WHOLE'}, {'time': '2020-04-03', 'trade_date_type': 'WHOLE'}, {'time': '2020-04-06', 'trade_date_type': 'WHOLE'}, {'time': '2020-04-07', 'trade_date_type': 'WHOLE'}, {'time': '2020-04-08', 'trade_date_type': 'WHOLE'}, {'time': '2020-04-09', 'trade_date_type': 'WHOLE'}] ****************************************** HK.00700 calendar: [{'time': '2020-04-01', 'trade_date_type': 'WHOLE'}, {'time': '2020-04-02', 'trade_date_type': 'WHOLE'}, {'time': '2020-04-03', 'trade_date_type': 'WHOLE'}, {'time': '2020-04-06', 'trade_date_type': 'WHOLE'}, {'time': '2020-04-07', 'trade_date_type': 'WHOLE'}, {'time': '2020-04-08', 'trade_date_type': 'WHOLE'}, {'time': '2020-04-09', 'trade_date_type': 'WHOLE'}] ``` :::tip APIレート制限 * 每 30 秒内最多リクエスト 30 次取得取引日API。 * 過去の取引カレンダーは過去10年分のデータを提供、将来の取引カレンダーは今年の12月31日まで提供します (例：本日が2021年7月6日の場合、2011-07-06から2021-12-31までの取引カレンダーのみ提供)。 ::: --- # 相場銘柄検索 `get_search_quote(keyword, max_count=10)` * **説明** キーワードで相場銘柄を検索し、一致する銘柄リストを返します。 * **パラメータ** パラメータ|型|説明 :-|:-|:- keyword|str|検索キーワード max_count|int|今回のリクエストで返す最大件数 (デフォルト10件、最大100件) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、相場検索結果リストを返します
str ret != RET_OK の場合、エラー説明を返します
* DataFrameフィールド： フィールド|型|説明 :-|:-|:- market|[Market](./quote.md#3611)|市場タイプ code|str|銘柄コード name|str|銘柄名称 sec_type|[SecurityType](./quote.md#6687)|銘柄タイプ is_watched|bool|ウォッチリスト登録済み * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_search_quote('aapl',10) if ret == RET_OK: print(data) else: print('error:', data) quote_ctx.close() # 接続上限を避けるため、終了後は接続を閉じてください ``` * **Output** ```python market code name sec_type is_watched 0 US US.AAPL 苹果 STOCK True 1 US US.AAPB 2倍做多AAPL ETF-GraniteShares ETF False 2 US US.LIST2139 虚拟现实 PLATE False 3 US US.LIST2432 流媒体概念 PLATE False 4 US US.LIST2437 苹果概念 PLATE False 5 JP JP.2788 Apple International STOCK False 6 US US.AAPI APPLE ISPORTS GROUP INC STOCK False 7 SH SH.603020 爱普股份 STOCK False 8 US US.APLY AAPL期权收益策略ETF-YieldMax ETF False 9 US US.APRU APPLE RUSH COMPANY INC STOCK False ``` :::tip API制限 * 30秒あたり相場銘柄検索は最大10回まで。 ::: --- # ニュース検索 `get_search_news(keyword, max_count=10, news_sub_type=NewsSubType.ALL)` * **説明** キーワードでニュースを検索し、一致するニュース・公告・レーティング等のリストを返します。 * **パラメータ** パラメータ|型|説明 :-|:-|:- keyword|str|検索キーワード max_count|int|今回のリクエストで返す最大件数 (デフォルト10件、最大100件) news_sub_type|[NewsSubType](./quote.md#8461)|ニュースサブタイプ (デフォルト NewsSubType.ALL) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、ニュース検索結果リストを返します
str ret != RET_OK の場合、エラー説明を返します
* DataFrameフィールド： フィールド|型|説明 :-|:-|:- title|str|タイトル news_sub_type|[NewsSubType](./quote.md#8461)|ニュースサブタイプ source|str|ソース publish_time|str|公開日時 view_count|int|閲覧数 related_securities|list|関連銘柄リスト url|str|詳細ページリンク * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_search_news('space', 10, news_sub_type=NewsSubType.ALL) if ret == RET_OK: print(data) else: print('error:', data) quote_ctx.close() # 接続上限を避けるため、終了後は接続を閉じてください ``` * **Output** ```python title news_sub_type source publish_time view_count related_securities url 0 Space：2026年12月期 第一财季业绩说明材料 NEWS 日本交易所 5/13 329 [] https://news.futunn.com/notice/307288728 1 Space：2026年12月期 第一财季业绩简报[日本会计准则]（合并） NEWS 日本交易所 5/13 277 [] https://news.futunn.com/notice/307288725 2 SPACE CO., LTD. 第一季度盈利表现强劲，但全年利润和股息预期下调。 NEWS TipRanks 5/13 201 [] https://news.futunn.com/post/73007255?futusour... 3 New Street Research 开始覆盖太空经济和基础设施领域。 NEWS PR Newswire 5/14 6035 [] https://news.futunn.com/post/73047684?futusour... 4 Space：临时报告书 NEWS 日本金融厅 3/27 257 [] https://news.futunn.com/notice/306761904 5 Gemini Space Station | 8-K：重大事件 NOTICE 美股SEC公告 6/16 278 [US.GEMI] https://news.futunn.com/notice/307532371?futus... 6 Extra Space Storage | 4：持股变动声明-高管 McNeal Gwyn ... NOTICE 美股SEC公告 6/13 348 [US.EXR] https://news.futunn.com/notice/307521769?futus... 7 Space Exploration Technologies Corp：承保或代理协议 NOTICE SEDAR 6/12 400 [] https://news.futunn.com/notice/307519369?futus... 8 Space Exploration Technologies Corp：补充长期形式的预备招... NOTICE SEDAR 6/12 231 [] https://news.futunn.com/notice/307519371?futus... 9 Space Exploration Technologies Corp：补充长期形式的预备招... NOTICE SEDAR 6/12 210 [] https://news.futunn.com/notice/307519370?futus... ``` :::tip API制限 * 30秒あたりニュース検索は最大10回まで。 ::: --- # 決算カレンダーの取得 `get_earnings_calendar(market, sort_type=None, begin_date=None, end_date=None, filter_list=None)` * **説明** 決算カレンダーを取得します。指定市場で指定日付範囲内に決算発表予定または発表済みの銘柄リストを返します。決算日、EPS/売上高/EBITの実績値と予測値、オプションインプライドボラティリティなどの情報を含みます。 * **パラメータ** パラメータ|タイプ|説明 :-|:-|:- market|[Market](./quote.md#3611)|市場タイプ（必須） sort_type|[EarningsCalendarSortType](./quote-market.md#6430)|ソートタイプ（デフォルト Hot） begin_date|str|開始日付、フォーマット "yyyy-MM-dd"、未指定の場合デフォルト今日（当日のみ取得） end_date|str|終了日付、フォーマット "yyyy-MM-dd"、未指定の場合 beginDate 当日のみ取得；beginDate との間隔は7日以内 filter_list|list[`EarningsCalendarFilter`]|フィルタ条件リスト（複数条件はAND関係） * **入力制限** - **`filter_list` フィルター条件（`EarningsCalendarFilter`）：** `EarningsCalendarFilter` でフィルター条件を構築し、2種類のフィルター方式をサポート： | コンストラクタパラメータ | 説明 | |----------|------| | `indicator_type` | フィルター指標タイプ（`EarningsCalendarIndicatorType`、必須） | | `value_list` | 正確な値リスト（発表タイプ、指標タイプ、銘柄リストタイプなどの列挙型フィルターに使用） | | `interval_min` / `interval_max` | 範囲フィルターの最小/最大値 | | `min_inclusive` / `max_inclusive` | 範囲境界を含むかどうか（デフォルト True） | * **戻り値**
パラメータ タイプ 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、データを返す
str ret != RET_OK の場合、エラー説明を返す
* データフォーマット： フィールド|タイプ|説明 :-|:-|:- security|str|銘柄コード（例 `'US.AAPL'`） name|str|銘柄名 earnings_date|str|決算日付（"yyyy-MM-dd"） earnings_timestamp|float|決算発表タイムスタンプ（Unix秒） pub_type|str|発表タイプ（BEFORE=プレマーケット / AFTER=アフターマーケット / REGULAR=取引時間中） period_text|str|会計年度期間（例 `'2025Q1'`） eps_actual|float|EPS 実績値（発表済みの場合に値あり） eps_predict|float|EPS 予測値 revenue_actual|float|総売上高実績値（発表済みの場合に値あり） revenue_predict|float|総売上高予測値 ebit_actual|float|EBIT 実績値（発表済みの場合に値あり） ebit_predict|float|EBIT 予測値 option_volume|int|オプション出来高（香港・米国株のみ） iv|float|インプライドボラティリティ（%）（香港・米国株のみ） iv_rank|float|IVランク（%）（香港・米国株のみ） iv_percentile|float|IVパーセンタイル（%）（香港・米国株のみ） market_cap|float|リアルタイム時価総額 price|float|最新価格 * **Example** ```python from futu import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_earnings_calendar(market=Market.US) if ret == RET_OK: print(data.head(2)) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` security name earnings_date earnings_timestamp pub_type period_text eps_actual eps_predict revenue_actual revenue_predict ebit_actual ebit_predict option_volume iv iv_rank iv_percentile market_cap price 0 US.MU 美光科技 2026-06-24 1.782331e+09 AFTER 2026Q3 N/A 20.8654 N/A 35251836320.0 N/A 26879423830.0 633420 113.795 97.754 98.015 1.186117e+12 1051.77 1 US.PAYX 沛齐 2026-06-24 1.782308e+09 BEFORE 2026Q4 N/A 1.2167 N/A 1606293190.0 N/A 661853410.0 6603 42.209 85.862 93.650 3.510892e+10 97.99 ``` :::tip API制限 - 30秒以内に最大60回のリクエストが可能です - ページネーションリクエストは最初のページのみレート制限にカウントされます ::: --- # マクロ指標リストの取得 `get_macro_indicator_list(region)` * **説明** マクロ指標リストを取得します。指定国/地域のマクロ経済指標カテゴリおよび指標情報を返します。指標IDと名称を含み、後続の履歴データ照会に使用します。 * **パラメータ** パラメータ|タイプ|説明 :-|:-|:- region|[MacroRegion](./quote-market.md#9608)|国/地域（必須） * **戻り値**
パラメータ タイプ 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、データを返す
str ret != RET_OK の場合、エラー説明を返す
* データフォーマット： フィールド|タイプ|説明 :-|:-|:- category_name|str|カテゴリ名（例："全部"/"雇用"/"インフレ"/"金利"） indicator_id|int|マクロ指標ID（履歴データ照会用） name|str|指標名 * **Example** ```python from futu import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_macro_indicator_list(region=MacroRegion.US) if ret == RET_OK: print(data.head(2)) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` category_name indicator_id name 0 物价 1003000003 美国生产者物价指数(PPI)同比 1 物价 1003000001 美国核心CPI同比 ``` :::tip API制限 - 30秒以内に最大60回のリクエストが可能です - ページネーションリクエストは最初のページのみレート制限にカウントされます ::: --- # マクロ指標履歴の取得数据 `get_macro_indicator_history(indicator_id, time=None, max_count=None)` * **説明** マクロ指標の履歴データを取得します。指定マクロ指標の履歴データポイントリストを返します。データ日付、公表日、公表値、予測値、前回値などの情報を含み、時間降順で並びます。 * **パラメータ** パラメータ|タイプ|説明 :-|:-|:- indicator_id|int|マクロ指標ID（`get_macro_indicator_list` から取得）（必須） time|str|時間ノード、フォーマット "yyyy-MM-dd"、この時間から遡って取得；未指定の場合デフォルト現在時刻 max_count|int|取得件数、デフォルト 100、上限 1000 * **戻り値**
パラメータ タイプ 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、データを返す
str ret != RET_OK の場合、エラー説明を返す
* データフォーマット： フィールド|タイプ|説明 :-|:-|:- data_time|str|データ日付（"yyyy-MM-dd"） release_time|str|公表日（"yyyy-MM-dd HH:mm:ss"） value|float|公表値（元の値に復元済み） predict_value|float|予測値（復元済み） previous_value|float|前回値（復元済み） unit_type|str|単位タイプ（PERCENT=パーセント / VALUE=数値 / INDEX=指数） * **Example** ```python from futu import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) # まず指標IDを取得 ret, indicators = quote_ctx.get_macro_indicator_list(region=MacroRegion.US) if ret == RET_OK: indicator_id = indicators.iloc[0]['indicator_id'] # 履歴データを照会 ret, data = quote_ctx.get_macro_indicator_history(indicator_id=indicator_id, max_count=2) if ret == RET_OK: print(data) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` data_time release_time value predict_value previous_value unit_type 0 2026-05-01 2026-06-11 20:34:01 0.0642 N/A 0.0566 PERCENT 1 2026-04-01 2026-05-13 20:31:01 0.0566 N/A 0.0427 PERCENT ``` :::tip API制限 - 30秒以内に最大60回のリクエストが可能です - ページネーションリクエストは最初のページのみレート制限にカウントされます ::: --- # FedWatch目標金利確率の取得 `get_fed_watch_target_rate()` * **説明** CME FedWatchツールの連邦基金目標金利確率予測データを取得します。各FOMC会議に対応する目標金利レンジおよび市場インプライド確率分布を返します。データソースはCME連邦基金先物の価格設定です。 * **戻り値**
パラメータ タイプ 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、データを返す
str ret != RET_OK の場合、エラー説明を返す
* データフォーマット： フィールド|タイプ|説明 :-|:-|:- meeting_date|str|FOMC会議日（"yyyy-MM-dd"） target_range|str|目標金利レンジ、例 "4.25% ~ 4.50%" probability|float|市場予想確率(%)、例 92.13 は 92.13%を示す * **Example** ```python from futu import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_fed_watch_target_rate() if ret == RET_OK: print(data) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` meeting_date target_range probability 0 2026-07-29 3.50-3.75% 62.6 1 2026-07-29 3.75-4.00% 37.4 2 2026-09-16 3.50-3.75% 29.8 3 2026-09-16 3.75-4.00% 50.6 4 2026-09-16 4.00-4.25% 19.6 ``` :::tip API制限 - 30秒以内に最大60回のリクエストが可能です - ページネーションリクエストは最初のページのみレート制限にカウントされます ::: --- # FedWatchドットプロットの取得 `get_fed_watch_dot_plot()` * **説明** CME金利ドットプロットデータを取得します。FRB各FOMC委員の将来各年度の連邦基金金利予想の投票分布を返します。各金利水準の投票人数、中央値金利、および現在の連邦基金金利を含みます。 * **戻り値**
パラメータ タイプ 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、データを返す
str ret != RET_OK の場合、エラー説明を返す
* データフォーマット： フィールド|タイプ|説明 :-|:-|:- year|int|予測年度、例 2025、2026、2027 rate|float|予想金利(%)、例 4.125 は 4.125%を示す vote_count|int|この金利水準に投票した委員数 is_median|bool|この年度の中央値金利かどうか median_rate|float|この年度の中央値金利(%) current_rate|float|現在の連邦基金金利(%) * **Example** ```python from futu import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_fed_watch_dot_plot() if ret == RET_OK: print(data) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` year rate vote_count is_median median_rate current_rate 0 2026 3.375 1 False 3.875 3.63 1 2026 3.625 8 False 3.875 3.63 ``` :::tip API制限 - 30秒以内に最大60回のリクエストが可能です - ページネーションリクエストは最初のページのみレート制限にカウントされます ::: --- # 業績予想上振れランキングの取得 `get_earnings_beat_rank(market, beat_type, count=None, term=None, filter_list=None, sort_field=None)` * **説明** 業績予想上振れランキングを取得します。指定市場で決算実績値が予想値を上回る銘柄ランキングリストを返します。予想上振れ率、決算発表翌日騰落率、前年同期比成長率等のデータを含みます。 * **パラメータ** パラメータ|タイプ|説明 :-|:-|:- market|[Market](./quote.md#3611)|市場タイプ（HK/US/SG/JP対応）（必須） beat_type|[BeatType](./quote-market.md#2296)|予想上振れタイプ（必須） count|int|取得数量 [1, 300]、デフォルト 30 term|[BeatTerm](./quote-market.md#8401)|決算期間（例：`'2024/Q1'`） filter_list|list[`EarningsBeatRankFilter`]|フィルター条件リスト（複数条件はAND関係） sort_field|[EarningsBeatSortField](./quote-market.md#4485)|ソートフィールド（固定降順）、デフォルト時価総額 * **入力制限** - **`filter_list` フィルター条件（`EarningsBeatRankFilter`）：** `EarningsBeatRankFilter` でフィルター条件を構築、範囲フィルターのみサポート： | コンストラクタパラメータ | 説明 | |----------|------| | `indicator_type` | フィルター指標タイプ（`EarningsBeatIndicatorType`、必須） | | `interval_min` | 範囲最小値（閉区間） | | `interval_max` | 範囲最大値（閉区間） | `filter_list` 未指定時はデフォルトフィルターを適用：予想超過率 > 0、発表日が直近30日以内。 * **戻り値**
パラメータ タイプ 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、(all_count, DataFrame) タプルを返す
str ret != RET_OK の場合、エラー説明を返す
* データフォーマット： フィールド|タイプ|説明 :-|:-|:- security|str|銘柄コード（例 `'US.AAPL'`） name|str|銘柄名 industry|str|所属業種 cur_price|float|最新価格 last_close_price|float|前日終値 change_rate|float|本日騰落率（%） market_cap|float|時価総額 pe_ttm|float|PER TTM dividends_ttm|float|配当利回り TTM（%） released_date|str|決算発表日（例：`'2024-01-15'`） beat_ratio|float|予想上振れ率（%） actual|float|実績値 estimate|float|予想値 yoy|float|前年同期 yoy_growth|float|前年同期比成長率（%） earning_day_chg|float|決算発表翌日騰落率（%） term|str|決算期間（例：`'2024/Q1'`） detail_post_period|str|発表時間帯（BEFORE=プレマーケット / AFTER=アフターマーケット / REGULAR=当日 / INTRADAY_TRADING=日中） * **Example** ```python from futu import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_earnings_beat_rank(market=Market.US, beat_type=BeatType.EPS, count=2) if ret == RET_OK: all_count, df = data print(f'データ総数: {all_count}') print(df) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` データ総数: 1276 security name industry cur_price last_close_price change_rate market_cap pe_ttm dividends_ttm released_date beat_ratio actual estimate yoy yoy_growth earning_day_chg term detail_post_period 0 US.NVDA 英伟达 半导体 200.04 208.65 -4.126 4.840968e+12 30.63399 0.019 2026-05-20 37.253 2.3900 1.7413 0.76 214.473 -1.772 2027/Q1 AFTER 1 US.AAPL 苹果 消费电子产品 294.30 297.01 -0.912 4.322489e+12 35.62953 0.353 2026-04-30 3.373 2.0099 1.9444 1.65 21.818 3.239 2026/Q2 AFTER ``` :::tip API制限 - 30秒以内に最大60回のリクエストが可能です - ページネーションリクエストは最初のページのみレート制限にカウントされます ::: --- # 配当ランキングの取得 `get_dividend_rank(market, rank_type, count=None, filter_list=None, sort_field=None)` * **説明** 配当ランキングを取得します。指定市場で高配当利回りまたは配当連続増加の銘柄ランキングリストを返します。配当利回り、配当頻度、連続増配年数等のデータを含みます。 * **パラメータ** パラメータ|タイプ|説明 :-|:-|:- market|[Market](./quote.md#3611)|市場タイプ（HK/US/MY/SG/JP対応）（必須） rank_type|[DividendRankType](./quote-market.md#8233)|ランキングタイプ（必須） count|int|取得数量 [1, 300]、デフォルト 10 filter_list|list[`DividendRankFilter`]|フィルター条件リスト（複数条件はAND関係、範囲型と列挙型をサポート） sort_field|[DividendRankSortField](./quote-market.md#7784)|ソートフィールド（固定降順）、デフォルトは rankType により決定 * **入力制限** - **`filter_list` フィルター条件（`DividendRankFilter`）：** `DividendRankFilter` でフィルター条件を構築、**範囲型**と**列挙型**の2種類をサポート： | コンストラクタパラメータ | 説明 | |----------|------| | `indicator_type` | フィルター指標タイプ（`DividendRankIndicatorType`、必須） | | `value_list` | 列挙値リスト（列挙型フィルターに使用、例：配当頻度） | | `interval_min` | 範囲最小値（閉区間、範囲フィルターに使用） | | `interval_max` | 範囲最大値（閉区間、範囲フィルターに使用） | > 注意：`value_list` と `interval_min/interval_max` のうち少なくとも1つを指定してください。 * **戻り値**
パラメータ タイプ 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、データを返す
str ret != RET_OK の場合、エラー説明を返す
* データフォーマット： フィールド|タイプ|説明 :-|:-|:- security|str|銘柄コード（例：`'HK.00005'`） name|str|銘柄名 industry|str|所属業種 cur_price|float|最新価格 change_rate|float|本日騰落率（%） change_amount|float|本日騰落額 market_cap|float|時価総額 dividend_yield_ttm|float|配当利回り TTM（%） avg_dividend_yield_5y|float|5年平均配当利回り（%） distribution_frequency|str|配当頻度（ANNUAL/SEMI_ANNUAL/QUARTERLY/MONTHLY）、HK市場非対応 dividend_grow_year|int|配当連続増配年数 dividends_ttm|float|配当 TTM（金額） payout_ratio_lfy|float|配当支払率 LFY（%） next_payable_date|str|次回配当日（例：`'2025-09-15'`） * **Example** ```python from futu import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_dividend_rank(market=Market.HK, rank_type=DividendRankType.HIGH_YIELD, count=2) if ret == RET_OK: print(data) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` security name industry cur_price change_rate change_amount market_cap dividend_yield_ttm avg_dividend_yield_5y distribution_frequency dividend_grow_year dividends_ttm payout_ratio_lfy next_payable_date 0 HK.00288 万洲国际 包装食品 8.54 -0.582 -0.05 1.095701e+11 10.655 10.855 SEMI_ANNUAL 2 0.910 116.44 N/A 1 HK.01919 中远海控 航运及港口 13.20 -1.123 -0.15 2.021314e+11 8.522 38.168 SEMI_ANNUAL 0 1.125 49.67 N/A ``` :::tip API制限 - 30秒以内に最大60回のリクエストが可能です - ページネーションリクエストは最初のページのみレート制限にカウントされます ::: --- # 配当カレンダーの取得 `get_dividend_calendar(market, date, data_from=None, count=None)` * **説明** 配当カレンダーを取得します。指定市場の特定日の配当データリストを返します。権利落ち日、権利確定日、配当支払日等の情報を含みます。 * **パラメータ** パラメータ|タイプ|説明 :-|:-|:- market|[Market](./quote.md#3611)|市場タイプ（HK/US/MY/SG/JP対応）（必須） date|str|照会日付、フォーマット `"YYYY-MM-DD"`（必須） data_from|int|ページングオフセット、デフォルト 0 count|int|取得数量、デフォルト制限なし * **入力制限** - **`date`**：1日分のデータのみ照会可能、フォーマット `"YYYY-MM-DD"`。 * **戻り値**
パラメータ タイプ 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、(all_count, DataFrame) タプルを返す
str ret != RET_OK の場合、エラー説明を返す
* データフォーマット： フィールド|タイプ|説明 :-|:-|:- security|str|銘柄コード（例：`'HK.00005'`） name|str|銘柄名 statement|str|配当方案説明 record_date|str|権利確定日（`"YYYY-MM-DD"`） ex_date|str|権利落ち日（`"YYYY-MM-DD"`） dividend_payable_date|str|配当支払日（`"YYYY-MM-DD"`） * **Example** ```python from futu import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_dividend_calendar(market=Market.US, date='2026-06-24', count=2) if ret == RET_OK: all_count, df = data print(f'データ総数: {all_count}') print(df) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` データ総数: 225 security name statement record_date ex_date dividend_payable_date 0 US.STX 希捷科技 1股派息0.74USD 2026-06-24 2026-06-24 2026-07-07 1 US.VGT 资讯科技ETF-Vanguard 1股派息0.1384USD 2026-06-24 2026-06-24 2026-06-26 ``` :::tip API制限 - 30秒以内に最大60回のリクエストが可能です - ページネーションリクエストは最初のページのみレート制限にカウントされます ::: --- # 経済イベントカレンダーの取得 `get_economic_calendar(begin_date, end_date=None, market_list=None, importance=None, count=None, next_page=None)` * **説明** 経済イベントカレンダーを取得します。指定日付範囲内の経済データ発表イベントを返します。イベントタイトル、発表時間、国、重要度、前回値、予想値、実際発表値を含みます。市場と重要度によるフィルタ、ページング照会に対応しています。 * **パラメータ** パラメータ|タイプ|説明 :-|:-|:- begin_date|str|開始日付、フォーマット "yyyy-MM-dd"（必須） end_date|str|終了日付、フォーマット "yyyy-MM-dd"；未指定時は begin_date 当日のみ照会 market_list|list[Market]|市場フィルター（複数選択、HK/US/SH/SG/JP/AU/MY/CA対応）、未指定時は全市場を返す importance|[EconomicImportance](./quote-market.md#8726)|イベント重要度フィルター、デフォルト ALL（全部） count|int|ページあたり数量、デフォルト 50、最大 100 next_page|str|ページングマーカー、初回は未指定、以降は前回返却の next_page を指定 * **戻り値**
パラメータ タイプ 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、データを返す
str ret != RET_OK の場合、エラー説明を返す
* データフォーマット： フィールド|タイプ|説明 :-|:-|:- title|str|イベントタイトル（例："非農業部門雇用者数"） timestamp|float|発表タイムスタンプ（秒） country|str|国名 star|str|重要度（"LOW"/"MEDIUM"/"HIGH"） previous|str|前回値（未返却時は "--"） consensus|str|予想値（未返却時は "--"） actual|str|実際発表値（未返却時は "--"） * **Example** ```python from futu import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data, next_page, has_more = quote_ctx.get_economic_calendar(begin_date='2026-06-23', end_date='2026-06-24', count=2) if ret == RET_OK: print(data) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` title timestamp country star previous consensus actual 0 日本6月综合PMI初值 1.782175e+09 日本 MEDIUM 1 日本6月制造业PMI初值 1.782175e+09 日本 MEDIUM ``` :::tip API制限 - 30秒以内に最大60回のリクエストが可能です - ページネーションリクエストは最初のページのみレート制限にカウントされます ::: --- # プレマーケットランキングの取得 `get_us_pre_market_rank(sort_dir=None, count=10, offset=None, filter_list=None)` * **説明** 米国株プレマーケットランキングを取得します。プレマーケット取引時間帯の騰落率ランキングを返します。プレマーケット価格、騰落率、売買代金、出来高等のデータを含みます。 * **パラメータ** パラメータ|タイプ|説明 :-|:-|:- sort_dir|[RankSortDir](./quote-market.md#5988)|ソート方向、デフォルト降順（値上がり上位） count|int|取得数量 [1, 200]、デフォルト 10 offset|int|開始位置、デフォルト 0 filter_list|list[`SimpleRankFilter`]|フィルター条件リスト（複数条件はAND関係） * **入力制限** - **`filter_list` フィルター条件（`SimpleRankFilter`）：** `SimpleRankFilter` でフィルター条件を構築： | コンストラクタパラメータ | 説明 | |----------|------| | `indicator_type` | フィルター指標タイプ（`SimpleRankIndicatorType`、必須） | | `interval_min` | 範囲最小値（閉区間、MARKET_CAP/PE に使用） | | `interval_max` | 範囲最大値（閉区間、MARKET_CAP/PE に使用） | | `price_filter` | 価格フィルター列挙（`PriceFilter`、PRICE タイプ必須） | * **戻り値**
パラメータ タイプ 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、(all_count, DataFrame) タプルを返す
str ret != RET_OK の場合、エラー説明を返す
* データフォーマット： フィールド|タイプ|説明 :-|:-|:- security|str|銘柄コード（例 `'US.AAPL'`） name|str|銘柄名 pre_market_price|float|プレマーケット価格 pre_market_change_ratio|float|プレマーケット騰落率（%） pre_market_change_amount|float|プレマーケット騰落額 pre_market_turnover|float|プレマーケット売買代金 pre_market_volume|int|プレマーケット出来高 close_price|float|終値（前取引日） change_ratio|float|日中騰落率（%） change_amount|float|日中騰落額 * **Example** ```python from futu import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_us_pre_market_rank(count=2) if ret == RET_OK: all_count, df = data print(f'データ総数: {all_count}') print(df) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` データ総数: 17728 security name pre_market_price pre_market_change_ratio pre_market_change_amount pre_market_turnover pre_market_volume close_price change_ratio change_amount 0 US.ATLN Atlantic International 1.18 168.303 0.74 1.219515e+08 136776297 1.33 202.961276 0.891 1 US.BOLD Boundless Bio 2.40 71.428 1.00 6.180064e+07 25082585 2.60 85.714286 1.200 ``` :::tip API制限 - 30秒以内に最大60回のリクエストが可能です - ページネーションリクエストは最初のページのみレート制限にカウントされます ::: --- # アフターアワーズランキングの取得 `get_us_after_hours_rank(sort_dir=None, count=10, offset=None, filter_list=None)` * **説明** 米国株アフターマーケットランキングを取得します。アフターマーケット取引時間帯の騰落率ランキングを返します。アフターマーケット価格、騰落率、売買代金、出来高等のデータを含みます。 * **パラメータ** パラメータ|タイプ|説明 :-|:-|:- sort_dir|[RankSortDir](./quote-market.md#5988)|ソート方向、デフォルト降順（値上がり） count|int|取得数量 [1, 200]、デフォルト 10 offset|int|開始位置、デフォルト 0 filter_list|list[`SimpleRankFilter`]|フィルター条件リスト（複数条件はAND関係） * **入力制限** - **`filter_list` フィルター条件（`SimpleRankFilter`）：** `SimpleRankFilter` でフィルター条件を構築： | コンストラクタパラメータ | 説明 | |----------|------| | `indicator_type` | フィルター指標タイプ（`SimpleRankIndicatorType`、必須） | | `interval_min` | 範囲最小値（閉区間、MARKET_CAP/PE に使用） | | `interval_max` | 範囲最大値（閉区間、MARKET_CAP/PE に使用） | | `price_filter` | 価格フィルター列挙（`PriceFilter`、PRICE タイプ必須） | * **戻り値**
パラメータ タイプ 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、(all_count, DataFrame) タプルを返す
str ret != RET_OK の場合、エラー説明を返す
* データフォーマット： フィールド|タイプ|説明 :-|:-|:- security|str|銘柄コード（例：`'US.TSLA'`） name|str|銘柄名 after_hours_price|float|アフターマーケット価格 after_hours_change_ratio|float|アフターマーケット騰落率（%） after_hours_change_amount|float|アフターマーケット騰落額 after_hours_turnover|float|アフターマーケット売買代金 after_hours_volume|int|アフターマーケット出来高 close_price|float|終値（前取引日） change_ratio|float|日中騰落率（%） change_amount|float|日中騰落額 * **Example** ```python from futu import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_us_after_hours_rank(count=2) if ret == RET_OK: all_count, df = data print(f'データ総数: {all_count}') print(df) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` データ総数: 17728 security name after_hours_price after_hours_change_ratio after_hours_change_amount after_hours_turnover after_hours_volume close_price change_ratio change_amount 0 US.MGN Megan 0.33 92.048 0.158 2.811130e+07 90547558 0.172 30.303030 0.04 1 US.QNRX Quoin Pharmaceuticals 4.85 49.230 1.600 1.498305e+07 3050404 3.250 -26.303855 -1.16 ``` :::tip API制限 - 30秒以内に最大60回のリクエストが可能です - ページネーションリクエストは最初のページのみレート制限にカウントされます ::: --- # ナイトセッションランキングの取得 `get_us_overnight_rank(sort_dir=None, count=10, offset=None, filter_list=None)` * **説明** 米国株ナイトセッションランキングを取得します。ナイトセッション取引時間帯の騰落率ランキングを返します。ナイトセッション価格、騰落率、売買代金、出来高等のデータを含みます。 * **パラメータ** パラメータ|タイプ|説明 :-|:-|:- sort_dir|[RankSortDir](./quote-market.md#5988)|ソート方向、デフォルト降順（値上がり） count|int|取得数量 [1, 200]、デフォルト 10 offset|int|開始位置、デフォルト 0 filter_list|list[`SimpleRankFilter`]|フィルター条件リスト（複数条件はAND関係） * **入力制限** - **`filter_list` フィルター条件（`SimpleRankFilter`）：** `SimpleRankFilter` でフィルター条件を構築： | コンストラクタパラメータ | 説明 | |----------|------| | `indicator_type` | フィルター指標タイプ（`SimpleRankIndicatorType`、必須） | | `interval_min` | 範囲最小値（閉区間、MARKET_CAP/PE に使用） | | `interval_max` | 範囲最大値（閉区間、MARKET_CAP/PE に使用） | | `price_filter` | 価格フィルター列挙（`PriceFilter`、PRICE タイプ必須） | * **戻り値**
パラメータ タイプ 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、(all_count, DataFrame) タプルを返す
str ret != RET_OK の場合、エラー説明を返す
* データフォーマット： フィールド|タイプ|説明 :-|:-|:- security|str|銘柄コード（例：`'US.NVDA'`） name|str|銘柄名 overnight_price|float|ナイトセッション価格 overnight_change_ratio|float|ナイトセッション騰落率（%） overnight_change_amount|float|ナイトセッション騰落額 overnight_turnover|float|ナイトセッション売買代金 overnight_volume|int|ナイトセッション出来高 close_price|float|終値（前取引日） change_ratio|float|日中騰落率（%） change_amount|float|日中騰落額 * **Example** ```python from futu import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_us_overnight_rank(count=2) if ret == RET_OK: all_count, df = data print(f'データ総数: {all_count}') print(df) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` データ総数: 17728 security name overnight_price overnight_change_ratio overnight_change_amount overnight_turnover overnight_volume close_price change_ratio change_amount 0 US.MGN Megan 0.3128 81.543 1.405000e+08 1681274.123 5102016 0.172 30.303030 0.04 1 US.QNRX Quoin Pharmaceuticals 5.2900 62.769 2.040000e+09 1164463.400 223649 3.250 -26.303855 -1.16 ``` :::tip API制限 - 30秒以内に最大60回のリクエストが可能です - ページネーションリクエストは最初のページのみレート制限にカウントされます ::: --- # 値上がり値下がりランキングの取得 `get_top_movers_rank(market, sort_dir=None, count=10, offset=None, filter_list=None)` * **説明** 値上がり/値下がりランキング（日中）を取得します。日中取引時間帯の騰落率ランキングを返します。香港株と米国株に対応し、最新価格、騰落率、売買代金、売買回転率、PER等のデータを含みます。 * **パラメータ** パラメータ|タイプ|説明 :-|:-|:- market|[Market](./quote.md#3611)|市場タイプ（HK/US）（必須） sort_dir|[RankSortDir](./quote-market.md#5988)|ソート方向、デフォルト降順（値上がり） count|int|取得数量 [1, 200]、デフォルト 10 offset|int|開始位置、デフォルト 0 filter_list|list[`SimpleRankFilter`]|フィルター条件リスト（複数条件はAND関係） * **入力制限** - **`filter_list` フィルター条件（`SimpleRankFilter`）：** | コンストラクタパラメータ | 説明 | |----------|------| | `indicator_type` | フィルター指標タイプ（`SimpleRankIndicatorType`、必須） | | `interval_min` | 範囲最小値（閉区間、MARKET_CAP/PE に使用） | | `interval_max` | 範囲最大値（閉区間、MARKET_CAP/PE に使用） | | `price_filter` | 価格フィルター列挙（`PriceFilter`、PRICE タイプ必須） | * **戻り値**
パラメータ タイプ 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、(all_count, DataFrame) タプルを返す
str ret != RET_OK の場合、エラー説明を返す
* データフォーマット： フィールド|タイプ|説明 :-|:-|:- security|str|銘柄コード（例：`'HK.00700'`） name|str|銘柄名 cur_price|float|最新価格 change_ratio|float|騰落率（%） change_amount|float|騰落額 turnover|float|売買代金 volume|int|出来高 turnover_ratio|float|売買回転率（%） pe_ttm|float|PER TTM amplitude|float|振幅（%） market_cap|float|時価総額 volume_ratio|float|出来高比率 * **Example** ```python from futu import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_top_movers_rank(market=Market.US, count=2) if ret == RET_OK: all_count, df = data print(f'データ総数: {all_count}') print(df) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` データ総数: 1794 security name cur_price change_ratio change_amount turnover volume turnover_ratio pe_ttm amplitude market_cap volume_ratio 0 US.QNT Quantinuum 77.46 13.461257 9.19 4.257190e+08 5582936 175.45 -8.523 225.28 2.020045e+10 1.540 1 US.NJDCY 日本电产(ADR) 3.90 9.859155 0.35 4.051129e+04 9816 0.00 24.074 225.35 1.788243e+10 0.426 ``` :::tip API制限 - 30秒以内に最大60回のリクエストが可能です - ページネーションリクエストは最初のページのみレート制限にカウントされます ::: --- # 人気ランキングの取得 `get_hot_list(market, sort_field=None, sort_dir=None, count=10, offset=None, filter_list=None)` * **説明** 人気ランキングを取得します。指定市場の人気度ランキング銘柄リストを返します。取引人気度、検索人気度、ニュース人気度、総合人気度でソート可能で、時価総額でフィルタリングできます。 * **パラメータ** パラメータ|タイプ|説明 :-|:-|:- market|[Market](./quote.md#3611)|市場タイプ（HK/US）（必須） sort_field|[HotListSortField](./quote-market.md#4623)|ソートフィールド、デフォルト総合人気度 sort_dir|[RankSortDir](./quote-market.md#5988)|ソート方向、デフォルト降順 count|int|取得数量 [1, 200]、デフォルト 10 offset|int|開始位置、デフォルト 0 filter_list|list[`HotListFilter`]|フィルター条件リスト（時価総額） * **入力制限** - **`filter_list` フィルター条件（`HotListFilter`）：** | コンストラクタパラメータ | 説明 | |----------|------| | `indicator_type` | フィルター指標タイプ（`HotListIndicatorType`、必須） | | `interval_min` | 範囲最小値（閉区間） | | `interval_max` | 範囲最大値（閉区間） | * **戻り値**
パラメータ タイプ 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、(all_count, DataFrame) タプルを返す
str ret != RET_OK の場合、エラー説明を返す
* データフォーマット： フィールド|タイプ|説明 :-|:-|:- security|str|銘柄コード（例：`'US.TSLA'`） name|str|銘柄名 trade_heat|float|取引人気度 trade_heat_change|float|取引人気度変化 search_heat|float|検索人気度 search_heat_change|float|検索人気度変化 news_heat|float|ニュース人気度 news_heat_change|float|ニュース人気度変化 average_heat|float|総合人気度 average_heat_change|float|総合人気度変化 news_type|str|ニュースタイプ（"Community"=コミュニティ討論, "News"=ニュース） news_title|str|ニュース/討論タイトル news_url|str|ニュース URL（news_type="News" の場合有効） * **Example** ```python from futu import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_hot_list(market=Market.US, count=2) if ret == RET_OK: all_count, df = data print(f'データ総数: {all_count}') print(df) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` データ総数: 6342 security name trade_heat trade_heat_change search_heat search_heat_change news_heat news_heat_change average_heat average_heat_change news_type news_title news_url 0 US.SPCX SpaceX 9999995.0 0.0 9999972.0 0.0 9999998.0 0.0 9999988.0 0.0 News SpaceX收涨1%，终结三连跌！首发债券获约3.6... https://news.futunn.com/post/55589925?lang=... 1 US.MU 美光科技 5578115.0 0.0 7923445.0 0.0 1835896.0 -2.0 5112485.0 0.0 N/A N/A N/A ``` :::tip API制限 - 30秒以内に最大60回のリクエストが可能です - ページネーションリクエストは最初のページのみレート制限にカウントされます ::: --- # 空売り異常変動ランキングの取得 `get_short_selling_rank(market=None, sort_field=None, sort_dir=None, count=10, offset=None, plate_list=None)` * **説明** 空売り異常変動ランキングを取得します。米国株/香港株の空売りデータランキングを返します。14種類のソート次元と業種セクターフィルタに対応し、空売り数量、比率、ショートポジション、カバー日数等のデータを含みます。 * **パラメータ** パラメータ|タイプ|説明 :-|:-|:- market|[Market](./quote.md#3611)|市場タイプ（HK/US）、デフォルト US sort_field|[ShortSellingSortField](./quote-market.md#3706)|ソートフィールド、デフォルト空売り変化量 sort_dir|[RankSortDir](./quote-market.md#5988)|ソート方向、デフォルト降順 count|int|取得数量 [1, 35]、デフォルト 10 offset|int|開始位置、デフォルト 0 plate_list|list[str]|業種セクターコードリスト（例：`['US.BK2024']`）、空=全部 * **戻り値**
パラメータ タイプ 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、(all_count, DataFrame) タプルを返す
str ret != RET_OK の場合、エラー説明を返す
* データフォーマット： フィールド|タイプ|説明 :-|:-|:- security|str|銘柄コード（例：`'US.GME'`） name|str|銘柄名 close_price|float|終値 change_ratio|float|騰落率（%） change_ratio_5d|float|5日騰落率（%） change_ratio_10d|float|10日騰落率（%） volume|int|出来高 short_number|int|空売り数量 short_number_change|int|空売り変化量 short_ratio|float|空売り比率（%） short_ratio_change|float|空売り変化比率（%） short_position_volume|int|ショートポジション数量 short_position_ratio|float|ショートポジション比率（%） days_to_cover|float|カバー日数 week_avg_short_number|int|直近1週間日均空売り week_avg_short_ratio|float|直近1週間日均空売り比率（%） month_avg_short_number|int|直近1ヶ月日均空売り month_avg_short_ratio|float|直近1ヶ月日均空売り比率（%） * **Example** ```python from futu import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_short_selling_rank(count=2) if ret == RET_OK: all_count, df = data print(f'データ総数: {all_count}') print(df) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` データ総数: 0 security name close_price change_ratio change_ratio_5d change_ratio_10d volume short_number short_number_change short_ratio short_ratio_change short_position_volume short_position_ratio days_to_cover week_avg_short_number week_avg_short_ratio month_avg_short_number month_avg_short_ratio 0 US.SKYQ Sky Quarry 1.9000 62.39 45.03 4.39 221413731 20302431 20226903 9.16 26780.66 327119 6.82 1.0 4111613 9.19 1136188 8.26 1 US.TNON Tenon Medical 0.6215 77.57 0.72 2.89 271138156 15289764 15273389 5.63 93272.60 149174 1.28 2.9 3063337 5.01 772705 5.04 ``` :::tip API制限 - 30秒以内に最大60回のリクエストが可能です - ページネーションリクエストは最初のページのみレート制限にカウントされます ::: --- # 期間騰落率の取得 `get_period_change_rank(market, period_type=None, sort_dir=None, count=10, offset=None, filter_list=None)` * **説明** 期間騰落率ランキングを取得します。指定市場で異なる期間（5分間〜250日/年初来）の騰落率ランキングを返します。豊富なフィルター条件（時価総額、価格、PER、PBR、売買回転率、出来高比率、振幅等）に対応しています。 * **パラメータ** パラメータ|タイプ|説明 :-|:-|:- market|[Market](./quote.md#3611)|市場タイプ（HK/US）（必須） period_type|[RankPeriodType](./quote-market.md#6848)|ソート期間、デフォルト 5 分間 sort_dir|[RankSortDir](./quote-market.md#5988)|ソート方向、デフォルト降順 count|int|取得数量 [1, 200]、デフォルト 10 offset|int|開始位置、デフォルト 0 filter_list|list[`PeriodChangeRankFilter`]|フィルター条件リスト（複数条件はAND関係） * **入力制限** - **`filter_list` フィルター条件（`PeriodChangeRankFilter`）：** | コンストラクタパラメータ | 説明 | |----------|------| | `indicator_type` | フィルター指標タイプ（`PeriodChangeIndicatorType`、必須） | | `interval_min` | 範囲最小値（閉区間） | | `interval_max` | 範囲最大値（閉区間） | * **戻り値**
パラメータ タイプ 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、(all_count, DataFrame) タプルを返す
str ret != RET_OK の場合、エラー説明を返す
* データフォーマット： フィールド|タイプ|説明 :-|:-|:- security|str|銘柄コード（例 `'US.AAPL'`） name|str|銘柄名 cur_price|float|最新価格 change_ratio|float|本日騰落率（%） turnover|float|売買代金 volume|int|出来高 market_cap|float|時価総額 change_rate_5min|float|5分間騰落率（%） change_rate_5d|float|5日騰落率（%） change_rate_10d|float|10日騰落率（%） change_rate_20d|float|20日騰落率（%） change_rate_60d|float|60日騰落率（%） change_rate_120d|float|120日騰落率（%） change_rate_250d|float|250日騰落率（%） change_rate_ytd|float|年初来騰落率（%） pe_ttm|float|PER TTM pb|float|PBR turnover_ratio|float|売買回転率（%） volume_ratio|float|出来高比率 amplitude|float|振幅（%） * **Example** ```python from futu import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_period_change_rank(market=Market.US, count=2) if ret == RET_OK: all_count, df = data print(f'データ総数: {all_count}') print(df) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` データ総数: 6429 security name cur_price change_ratio turnover volume market_cap change_rate_5min change_rate_5d change_rate_10d change_rate_20d change_rate_60d change_rate_120d change_rate_250d change_rate_ytd pe_ttm pb turnover_ratio volume_ratio amplitude 0 US.JYD 佳裕达物流 0.93 11.537 271197.0 311313 7717977.00 9.540 32.80 30.875 20.779 -68.150 -80.128 -90.610 -81.374 -0.40558 0.49892 5.220 0.732 20.94 1 US.RAIN Rain Enhancement Technologies 2.23 19.892 112286.0 56451 18261097.59 9.313 -2.62 1.826 -6.302 -21.754 -71.914 -22.299 -61.815 -1.79838 -1.27283 2.812 0.816 27.15 ``` :::tip API制限 - 30秒以内に最大60回のリクエストが可能です - ページネーションリクエストは最初のページのみレート制限にカウントされます ::: --- # 高配当国有企業ランキングの取得 `get_high_dividend_soe_rank(sort_field=None, sort_dir=None, count=10, offset=None, filter_list=None)` * **説明** 純資産割れ高配当国有企業ランキング（香港株）を取得します。国有企業バリュー株コンセプトセクター、PBR<=1、配当利回りTTM>=5%、PER>=0のデフォルト条件を満たす香港株ランキングデータを返します。フィルター条件でデフォルト閾値を上書きできます。 * **パラメータ** パラメータ|タイプ|説明 :-|:-|:- sort_field|[HighDividendSOESortField](./quote-market.md#8730)|ソートフィールド、デフォルト時価総額 sort_dir|[RankSortDir](./quote-market.md#5988)|ソート方向、デフォルト降順 count|int|取得数量 [1, 200]、デフォルト 10 offset|int|開始位置、デフォルト 0 filter_list|list[`HighDividendSOERankFilter`]|フィルター条件リスト（デフォルト条件を上書き可能） * **入力制限** - **`filter_list` フィルター条件（`HighDividendSOERankFilter`）：** | コンストラクタパラメータ | 説明 | |----------|------| | `indicator_type` | フィルター指標タイプ（`HighDividendSOEIndicatorType`、必須） | | `interval_min` | 範囲最小値（閉区間） | | `interval_max` | 範囲最大値（閉区間） | - **サーバー側デフォルト固定条件：** - コンセプトセクター = 国有企業バリュー株 - PBR <= 1 - 配当利回り TTM >= 5% - PER >= 0 * **戻り値**
パラメータ タイプ 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、(all_count, DataFrame) タプルを返す
str ret != RET_OK の場合、エラー説明を返す
* データフォーマット： フィールド|タイプ|説明 :-|:-|:- security|str|銘柄コード（例：`'HK.00857'`） name|str|銘柄名 industry|str|所属業種 cur_price|float|最新価格 change_ratio|float|騰落率（%） turnover|float|売買代金 volume|int|出来高 market_cap|float|時価総額 pe_ttm|float|PER TTM pb|float|PBR dividend_yield_ttm|float|配当利回り TTM（%） turnover_ratio|float|売買回転率（%） change_rate_5d|float|5日騰落率（%） change_rate_10d|float|10日騰落率（%） change_rate_20d|float|20日騰落率（%） change_rate_60d|float|60日騰落率（%） change_rate_120d|float|120日騰落率（%） change_rate_250d|float|250日騰落率（%） * **Example** ```python from futu import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_high_dividend_soe_rank(count=2) if ret == RET_OK: all_count, df = data print(f'データ総数: {all_count}') print(df) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` データ総数: 98 security name industry cur_price change_ratio turnover volume market_cap pe_ttm pb dividend_yield_ttm turnover_ratio change_rate_5d change_rate_10d change_rate_20d change_rate_60d change_rate_120d change_rate_250d 0 HK.01398 工商银行 银行 6.9 -0.862 325569646.0 46871758 2.459203e+12 5.84745 0.55072 5.072 0.054 -3.894 -0.288 1.917 9.411 16.416 24.292 1 HK.00857 中国石油股份 油气生产商 8.9 -0.447 154397506.0 17228406 1.628887e+12 9.09090 0.88539 5.932 0.081 -6.342 -10.216 -16.217 -14.691 14.209 36.468 ``` :::tip API制限 - 30秒以内に最大60回のリクエストが可能です - ページネーションリクエストは最初のページのみレート制限にカウントされます ::: --- # 機関リストの取得 `get_institution_list(market, sort_field=None, sort_dir=None, count=None, page=None, name_part=None)` * **説明** 機関リストを取得します。指定市場で保有時価総額/増減保有/保有銘柄数などの指標でランキングされた機関リストを返します。あいまい検索とカーソルページングに対応しています。 * **パラメータ** パラメータ|タイプ|説明 :-|:-|:- market|[Market](./quote.md#3611)|市場タイプ（HK/US）（必須） sort_field|[InstitutionListSortField](./quote-market.md#4657)|ソートフィールド、デフォルト保有時価総額 sort_dir|[RankSortDir](./quote-market.md#5988)|ソート方向、デフォルト降順 count|int|取得数量 [1, 200]、デフォルト 20 page|str|ページカーソル、初回は未指定、次ページは前回返されたnext_pageを指定 name_part|str|機関名あいまい検索 * **戻り値**
パラメータ タイプ 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、データを返す
str ret != RET_OK の場合、エラー説明を返す
* データフォーマット： フィールド|タイプ|説明 :-|:-|:- institution_id|int|機関ID institution_name|str|機関名 position_value|float|保有時価総額 position_value_change|float|保有時価総額変化 position_count|int|保有銘柄数 position_count_change|int|保有銘柄数変化 disclosure_date|str|開示日（yyyy-MM-dd） currency|str|通貨 * **Example** ```python from futu import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data, next_page, all_count = quote_ctx.get_institution_list(market=Market.US, count=2) if ret == RET_OK: print(f'データ総数: {all_count}') print(data) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` データ総数: 17030 institution_id institution_name position_value position_value_change position_count position_count_change disclosure_date currency 0 403413 贝莱德 6.959193e+12 3.432083e+10 4443 56 2026-06-19 USD 1 1951572549 Vanguard Capital Management, LLC 4.881261e+12 4.492246e+12 4289 3859 2026-06-10 USD ``` :::tip API制限 - 30秒以内に最大60回のリクエストが可能です - ページネーションリクエストは最初のページのみレート制限にカウントされます ::: --- # 機関プロフィールの取得 `get_institution_profile(market, institution_id)` * **説明** 機関概況を取得します。指定機関の保有時価総額、保有変動統計、Top10保有比率などのプロファイルデータを返します。 * **パラメータ** パラメータ|タイプ|説明 :-|:-|:- market|[Market](./quote.md#3611)|市場タイプ（HK/US）（必須） institution_id|int|機関ID（get_institution_list から取得）（必須） * **戻り値**
パラメータ タイプ 説明
ret RET_CODE API呼び出し結果
data dict ret == RET_OK の場合、辞書データを返す
str ret != RET_OK の場合、エラー説明を返す
* データフォーマット： フィールド|タイプ|説明 :-|:-|:- institution_name|str|機関名 description|str|機関概要 position_value|float|保有時価総額 last_position_value|float|前期保有時価総額 position_value_change_pct|float|時価総額変化率（%） total_holding_count|int|総保有数 holding_change_count|int|保有変動数 new_count|int|新規ポジション銘柄数 sold_out_count|int|ポジション解消銘柄数 increase_count|int|買い増し銘柄数 decrease_count|int|保有削減銘柄数 top10_pct|float|Top10保有比率（%） top10_pct_change|float|Top10比率変動（%） disclosure_date|str|開示日（yyyy-MM-dd） currency|str|通貨 * **Example** ```python from futu import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) # まず機関IDを取得 ret, data, _, _ = quote_ctx.get_institution_list(market=Market.US, count=1) if ret == RET_OK and len(data) > 0: inst_id = data.iloc[0]['institution_id'] # 機関概況を照会 ret, profile = quote_ctx.get_institution_profile(market=Market.US, institution_id=inst_id) if ret == RET_OK: for k, v in profile.items(): print(f"{k}: {v}") else: print('error:', profile) quote_ctx.close() ``` * **Output** ``` institution_name: 贝莱德 description: 贝莱德集团是美国规模最大的资产管理集团之一，提供种类繁多的证券、固定收益、现金管理等投资产品。 position_value: 6959192681765.731 last_position_value: 6093992885377.756 position_value_change_pct: 14.1975 total_holding_count: 4443 holding_change_count: 12 new_count: 87 sold_out_count: 31 increase_count: 2364 decrease_count: 1682 top10_pct: 24.3287 top10_pct_change: 0.4142 disclosure_date: 2026-06-19 currency: USD ``` :::tip API制限 - 30秒以内に最大60回のリクエストが可能です - ページネーションリクエストは最初のページのみレート制限にカウントされます ::: --- # 機関保有の業種分布を取得します `get_institution_distribution(market, institution_id)` * **説明** 機関保有の業種分布を取得します。指定機関の保有を業種別に分類した時価総額と比率データを返します。 * **パラメータ** パラメータ|タイプ|説明 :-|:-|:- market|[Market](./quote.md#3611)|市場タイプ（HK/US）（必須） institution_id|int|機関ID（get_institution_list から取得）（必須） * **戻り値**
パラメータ タイプ 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、データを返す
str ret != RET_OK の場合、エラー説明を返す
* データフォーマット： フィールド|タイプ|説明 :-|:-|:- industry_id|int|業種ID industry_name|str|業種名 position_value|float|保有時価総額 portfolio_pct|float|業種比率（%） * **Example** ```python from futu import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) # まず機関IDを取得 ret, data, _, _ = quote_ctx.get_institution_list(market=Market.US, count=1) if ret == RET_OK and len(data) > 0: inst_id = data.iloc[0]['institution_id'] # 業種分布を照会 ret, data = quote_ctx.get_institution_distribution(market=Market.US, institution_id=inst_id) if ret == RET_OK: print(data) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` industry_id industry_name position_value portfolio_pct 0 6 电子 1319006433351.533936 19.8494 1 26 计算机 992844462205.649048 14.9411 2 12 医药生物 633746255374.343994 9.5371 3 27 互联网与传媒 484195469416.382996 7.2865 4 19 非银金融 481223610387.026001 7.2418 5 N/A 其他 N/A 41.1441 ``` :::tip API制限 - 30秒以内に最大60回のリクエストが可能です - ページネーションリクエストは最初のページのみレート制限にカウントされます ::: --- # 機関保有変動の取得 `get_institution_holding_change(market, institution_id, change_type=None, sort_field=None, sort_dir=None, count=None, page=None)` * **説明** 機関保有変動を取得します。指定機関の変動タイプ別（新規ポジション/ポジション解消/買い増し/保有削減）にフィルタリングした保有変動記録を返します。ソートとカーソルページングに対応しています。 * **パラメータ** パラメータ|タイプ|説明 :-|:-|:- market|[Market](./quote.md#3611)|市場タイプ（HK/US）（必須） institution_id|int|機関ID（必須） change_type|[InstitutionHoldingChangeType](./quote-market.md#7098)|変動タイプ、デフォルト新規ポジション sort_field|[InstitutionHoldingChangeSortField](./quote-market.md#4672)|ソートフィールド、デフォルト変動比率 sort_dir|[RankSortDir](./quote-market.md#5988)|ソート方向、デフォルト降順 count|int|取得数量 [1, 200]、デフォルト 20 page|str|ページカーソル * **戻り値**
パラメータ タイプ 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、データを返す
str ret != RET_OK の場合、エラー説明を返す
* データフォーマット： フィールド|タイプ|説明 :-|:-|:- security|str|銘柄コード（例 `'US.AAPL'`） name|str|銘柄名 portfolio_pct|float|保有比率（%） change_shares|int|変動株数 change_pct|float|変動比率（%） holding_date|int|保有日時（タイムスタンプ） source|str|開示ソース * **Example** ```python from futu import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) # まず機関IDを取得 ret, data, _, _ = quote_ctx.get_institution_list(market=Market.US, count=1) if ret == RET_OK and len(data) > 0: inst_id = data.iloc[0]['institution_id'] # 保有変動を照会 ret, data, next_page, all_count = quote_ctx.get_institution_holding_change( market=Market.US, institution_id=inst_id, count=2) if ret == RET_OK: print(f'データ総数: {all_count}') print(data) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` データ総数: 87 security name portfolio_pct change_shares change_pct holding_date source 0 US.YSS York Space Systems 14.6594 19012439 14.6594 2026-03-30 13F 1 US.VSNT Versant Media 12.2661 17356403 12.2661 2026-03-30 13F ``` :::tip API制限 - 30秒以内に最大60回のリクエストが可能です - ページネーションリクエストは最初のページのみレート制限にカウントされます ::: --- # 機関保有リストの取得 `get_institution_holding_list(market, institution_id, change_type=None, sort_field=None, sort_dir=None, count=None, page=None, keyword=None)` * **説明** 機関保有リストを取得します。指定機関の全保有明細（時価総額、保有比率、変動等を含む）を返します。変動タイプによるフィルタリング、多次元ソートおよびキーワード検索に対応しています。 * **パラメータ** パラメータ|タイプ|説明 :-|:-|:- market|[Market](./quote.md#3611)|市場タイプ（HK/US）（必須） institution_id|int|機関ID（必須） change_type|[InstitutionHoldingChangeType](./quote-market.md#7098)|変動タイプでフィルタ（未指定=全部） sort_field|[InstitutionHoldingListSortField](./quote-market.md#3234)|ソートフィールド、デフォルト保有時価総額 sort_dir|[RankSortDir](./quote-market.md#5988)|ソート方向、デフォルト降順 count|int|取得数量 [1, 200]、デフォルト 20 page|str|ページカーソル keyword|str|検索キーワード（銘柄名/コード） * **戻り値**
パラメータ タイプ 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、データを返す
str ret != RET_OK の場合、エラー説明を返す
* データフォーマット： フィールド|タイプ|説明 :-|:-|:- security|str|銘柄コード（例 `'US.AAPL'`） name|str|銘柄名 industry_name|str|所属業種 holding_value|float|保有時価総額 holding_pct|float|保有比率—株式時価総額に対する割合（%） last_holding_pct|float|前期保有比率（%） change_shares|int|変動株数 portfolio_pct|float|機関総ポジションに対する比率（%） change_pct|float|変動比率（%） holding_date|int|保有日時（タイムスタンプ） source|str|開示ソース currency|str|通貨 * **Example** ```python from futu import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) # まず機関IDを取得 ret, data, _, _ = quote_ctx.get_institution_list(market=Market.US, count=1) if ret == RET_OK and len(data) > 0: inst_id = data.iloc[0]['institution_id'] # 保有リストを照会 ret, data, next_page, all_count = quote_ctx.get_institution_holding_list( market=Market.US, institution_id=inst_id, count=2) if ret == RET_OK: print(f'データ総数: {all_count}') print(data) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` データ総数: 4430 security name industry_name holding_value holding_pct last_holding_pct change_shares portfolio_pct change_pct holding_date source currency 0 US.NVDA 英伟达 电子 3.887350e+11 7.9295 7.8996 -19284971 4.9289 -0.0796 2026-03-30 13F USD 1 US.AAPL 苹果 计算机 3.398298e+11 7.7520 7.7624 -10565359 4.3088 -0.0719 2026-03-30 13F USD ``` :::tip API制限 - 30秒以内に最大60回のリクエストが可能です - ページネーションリクエストは最初のページのみレート制限にカウントされます ::: --- # ARKファンド保有の取得 `get_ark_fund_holding(holding_type=None, cycle_type=None, sort_field=None, sort_dir=None, count=None, page=None)` * **説明** ARKファンド保有を取得します。ARK傘下ETFの保有データを返します。保有/買い増し/保有削減/新規ポジション/ポジション解消タイプ別の表示、異なる期間および多次元ソートに対応しています。 * **パラメータ** パラメータ|タイプ|説明 :-|:-|:- holding_type|[ArkHoldingType](./quote-market.md#4359)|保有タイプ、デフォルト保有 cycle_type|[ArkCycleType](./quote-market.md#4538)|期間タイプ、デフォルト直近1日（holdingType=保有時は無視） sort_field|[ArkFundHoldingSortField](./quote-market.md#4006)|ソートフィールド、デフォルト保有数量 sort_dir|[RankSortDir](./quote-market.md#5988)|ソート方向、デフォルト降順 count|int|取得数量 [1, 200]、デフォルト 20 page|str|ページカーソル * **戻り値**
パラメータ タイプ 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、データを返す
str ret != RET_OK の場合、エラー説明を返す
* データフォーマット： フィールド|タイプ|説明 :-|:-|:- security|str|銘柄コード（例 `'US.TSLA'`、一部銘柄はN/Aの場合あり） name|str|名称 shares|int|保有数量 shares_change|int|保有数量変動 market_value|float|保有時価総額（米ドル） weight|float|保有ウェイト（%） weight_change|float|保有ウェイト変動（%） * **Example** ```python from futu import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data, next_page, all_count = quote_ctx.get_ark_fund_holding(count=2) if ret == RET_OK: print(f'データ総数: {all_count}') print(data) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` データ総数: 2 security name shares shares_change market_value weight weight_change 0 N/A N/A 62494591 15631862 6.249459e+07 0.45 0.12 1 US.RXRX Recursion Pharmaceuticals 31671298 -71280 1.007147e+08 0.73 0.01 ``` :::tip API制限 - 30秒以内に最大60回のリクエストが可能です - ページネーションリクエストは最初のページのみレート制限にカウントされます ::: --- # ARK個別銘柄取引動態の取得 `get_ark_stock_dynamic(security)` * **説明** ARK個別銘柄取引動態を取得します。指定銘柄のARKファンドにおける最新取引動態情報（連続同方向取引、直近取引、最新1件等）を返します。 * **パラメータ** パラメータ|タイプ|説明 :-|:-|:- security|str|銘柄コード（例 `'US.TSLA'`）（必須） * **戻り値**
パラメータ タイプ 説明
ret RET_CODE API呼び出し結果
data dict ret == RET_OK の場合、辞書データを返す
str ret != RET_OK の場合、エラー説明を返す
* データフォーマット： フィールド|タイプ|説明 :-|:-|:- dynamic_type|str|動態タイプ（下記の列挙値を参照） transaction_count|int|取引回数 net_shares|int|純取引株数 last_transaction_time|str|最新取引時間（yyyy-MM-dd） "CONSECUTIVE_SAME_DIRECTION"|連続同方向取引| "RECENT_TRANSACTION"|直近取引| "LAST_TRANSACTION"|最新1件| "NO_DYNAMIC"|動態なし| * **Example** ```python from futu import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_ark_stock_dynamic(security='US.TSLA') if ret == RET_OK: for k, v in data.items(): print(f"{k}: {v}") else: print('error:', data) quote_ctx.close() ``` * **Output** ``` dynamic_type: CONSECUTIVE_SAME_DIRECTION transaction_count: 2 net_shares: 76041 last_transaction_time: 2026-06-22 ``` :::tip API制限 - 30秒以内に最大60回のリクエストが可能です - ページネーションリクエストは最初のページのみレート制限にカウントされます ::: --- # ARKアクティブ取引の取得 `get_ark_active_transaction(holding_type=None, cycle_type=None, sort_field=None, sort_dir=None, count=None, page=None)` * **説明** ARKアクティブ取引集計を取得します。ARKファンドのアクティブ取引記録（変動金額、変動株数を含む）を返します。保有変動タイプ、期間選択およびソートに対応しています。 * **パラメータ** パラメータ|タイプ|説明 :-|:-|:- holding_type|[ArkActiveTransactionHoldingType](./quote-market.md#8957)|保有変動タイプ、デフォルト買い増し cycle_type|[ArkCycleType](./quote-market.md#4538)|期間タイプ、デフォルト直近1日 sort_field|[ArkActiveTransactionSortField](./quote-market.md#4292)|ソートフィールド、デフォルト変動金額 sort_dir|[RankSortDir](./quote-market.md#5988)|ソート方向、デフォルト降順 count|int|取得数量 [1, 200]、デフォルト 50 page|str|ページカーソル * **戻り値**
パラメータ タイプ 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、データを返す
str ret != RET_OK の場合、エラー説明を返す
* データフォーマット： フィールド|タイプ|説明 :-|:-|:- security|str|銘柄コード（例 `'US.TSLA'`、一部銘柄はN/Aの場合あり） name|str|名称 change_amount|float|変動金額（米ドル） change_shares|int|変動数量（株） * **Example** ```python from futu import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data, next_page, all_count = quote_ctx.get_ark_active_transaction(count=2) if ret == RET_OK: print(f'データ総数: {all_count}') print(data) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` データ総数: 2 security name change_amount change_shares 0 US.AMZN 亚马逊 9631518.0 41141 1 US.PLTR Palantir 9482340.0 81254 ``` :::tip API制限 - 30秒以内に最大60回のリクエストが可能です - ページネーションリクエストは最初のページのみレート制限にカウントされます ::: --- # レーティング変動の取得 `get_rating_change(market, change_type=None, count=None, page=None)` * **説明** レーティング変動を取得します。米国株のレーティング変動記録（格上げ/格下げ/初回レーティング）を返します。機関名、目標株価変動などの情報を含み、ページングに対応しています。 * **パラメータ** パラメータ|タイプ|説明 :-|:-|:- market|[Market](./quote.md#3611)|市場タイプ（USのみ）（必須） change_type|[RatingChangeType](./quote-market.md#946)|レーティング変動タイプ（"UPGRADE"/"DOWNGRADE"/"NEW_RATING"） count|int|取得数量 [1, 20]、デフォルト 10 page|str|ページカーソル * **戻り値**
パラメータ タイプ 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、データを返す
str ret != RET_OK の場合、エラー説明を返す
* データフォーマット： フィールド|タイプ|説明 :-|:-|:- security|str|銘柄コード（例 `'US.TSLA'`） name|str|銘柄名 rating|str|現在のレーティング（"BUY"/"HOLD"/"SELL"） last_rating|str|前回のレーティング（"BUY"/"HOLD"/"SELL"） target_price|float|現在の目標株価 last_target_price|float|前回の目標株価 change_type|str|レーティング変動タイプ（"UPGRADE"/"DOWNGRADE"/"NEW_RATING"） institution_name|str|機関名 recommendation_date|str|推奨日（yyyy-MM-dd） last_recommendation_date|str|前回の推奨日（yyyy-MM-dd） "SELL"|売り| "HOLD"|保持| "BUY"|買い| * **Example** ```python from futu import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data, next_page, all_count = quote_ctx.get_rating_change(market=Market.US, count=2) if ret == RET_OK: print(f'データ総数: {all_count}') print(data) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` データ総数: 5904 security name rating last_rating target_price last_target_price change_type institution_name recommendation_date last_recommendation_date 0 US.MU 美光科技 BUY BUY 1500.0 950.0 UPGRADE 美银证券 2026-06-23 2026-05-13 1 US.INTC 英特尔 BUY BUY 160.0 135.0 UPGRADE 美银证券 2026-06-23 2026-06-11 ``` :::tip API制限 - 30秒以内に最大60回のリクエストが可能です - ページネーションリクエストは最初のページのみレート制限にカウントされます ::: --- # 産業チェーンリストの取得 `get_industrial_chain_list(market, keyword=None, count=None, page=None)` * **説明** 産業チェーンリストを取得します。指定市場の産業チェーン情報（産業チェーンタイプ、時価総額、構成銘柄数等を含む）を返します。キーワード検索とカーソルページングに対応しています。 * **パラメータ** パラメータ|タイプ|説明 :-|:-|:- market|[Market](./quote.md#3611)|市場タイプ（必須） keyword|str|検索キーワード count|int|取得数量 [1, 50]、デフォルト 20 page|str|ページカーソル * **戻り値**
パラメータ タイプ 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、データを返す
str ret != RET_OK の場合、エラー説明を返す
* データフォーマット： フィールド|タイプ|説明 :-|:-|:- chain_id|int|産業チェーンID chain_type|str|産業チェーンタイプ（"CHAIN"/"PARALLEL"/"UP_MID_DOWN"） name|str|産業チェーン名 detail|str|詳細説明 market_cap|float|時価総額 stocks_num|int|構成銘柄数 relation_security_list|list|関連銘柄コードリスト "CHAIN"|直列型| "PARALLEL"|並列型| "UP_MID_DOWN"|上流・中流・下流型| * **Example** ```python from futu import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data, next_page, all_count = quote_ctx.get_industrial_chain_list(market=Market.US, count=2) if ret == RET_OK: print(f'データ総数: {all_count}') print(data) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` データ総数: 70 chain_id chain_type name detail market_cap stocks_num relation_security_list 0 9610020 UP_MID_DOWN AI AIGC（Artificial Intelligence Generated Content... 4.801784e+13 329 [US.NVDA, US.AAPL] 1 9610085 UP_MID_DOWN 商业航天 2.590359e+12 155 [US.GE, US.RTX] ``` :::tip API制限 - 30秒以内に最大60回のリクエストが可能です - ページネーションリクエストは最初のページのみレート制限にカウントされます ::: --- # 産業チェーン詳細の取得 `get_industrial_chain_detail(chain_id)` * **説明** 産業チェーン詳細を取得します。指定産業チェーンの完全な構造情報を返します。階層ノードリストと関連ニュースリンクを含みます。 * **パラメータ** パラメータ|タイプ|説明 :-|:-|:- chain_id|int|産業チェーンID * **戻り値**
パラメータ タイプ 説明
ret RET_CODE API呼び出し結果
data dict ret == RET_OK の場合、辞書データを返す
str ret != RET_OK の場合、エラー説明を返す
* データフォーマット： フィールド|タイプ|説明 :-|:-|:- chain_id|int|産業チェーンID chain_type|str|産業チェーンタイプ（"CHAIN"/"PARALLEL"/"UP_MID_DOWN"） name|str|産業チェーン名 node_list|list[dict]|ノードリスト（階層別にグループ化） information_list|list[dict]|ニュースリンクリスト node_id|int|ノードID parent_node_id|int|親ノードID（ルートノードは0） layer|int|ノード階層（1から開始） name|str|ノード名 plate_id|int|関連産業プレートID（関連なしはN/A） title|str|ニュースタイトル url|str|ニュースリンク * **Example** ```python from futu import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_industrial_chain_detail(chain_id=9610020) if ret == RET_OK: print(f"chain_id: {data['chain_id']}") print(f"chain_type: {data['chain_type']}") print(f"name: {data['name']}") print(f"node_list (先頭2件):") for node in data['node_list'][:2]: print(f" {node}") print(f"information_list: {data['information_list']}") else: print('error:', data) quote_ctx.close() ``` * **Output** ``` chain_id: 9610020 chain_type: UP_MID_DOWN name: AI node_list (先頭2件): {'node_id': 1, 'parent_node_id': 'N/A', 'layer': 1, 'name': '基础建设层', 'plate_id': 'N/A'} {'node_id': 4, 'parent_node_id': 'N/A', 'layer': 1, 'name': '算法层', 'plate_id': 'N/A'} information_list: [] ``` :::tip API制限 - 30秒以内に最大60回のリクエストが可能です - ページネーションリクエストは最初のページのみレート制限にカウントされます ::: --- # セクター関連の産業チェーンを取得します `get_industrial_chain_by_plate(plate_id)` * **説明** プレート関連産業チェーンを取得します。指定産業プレートに関連する産業チェーンリスト情報（タイプ、時価総額、構成銘柄数を含む）を返します。 * **パラメータ** パラメータ|タイプ|説明 :-|:-|:- plate_id|int|産業プレートID（`get_industrial_chain_detail` のnode_listから取得）（必須） * **戻り値**
パラメータ タイプ 説明
ret RET_CODE API呼び出し結果
data list ret == RET_OK の場合、リストデータを返す
str ret != RET_OK の場合、エラー説明を返す
* データフォーマット： フィールド|タイプ|説明 :-|:-|:- chain_id|int|産業チェーンID chain_type|str|産業チェーンタイプ（"CHAIN"/"PARALLEL"/"UP_MID_DOWN"） name|str|産業チェーン名 market_cap|float|時価総額 stocks_num|int|構成銘柄数 "CHAIN"|直列型| "PARALLEL"|並列型| "UP_MID_DOWN"|上流・中流・下流型| * **Example** ```python from futu import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_industrial_chain_by_plate(plate_id=10010508) if ret == RET_OK: for chain in data: print(chain) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` {'chain_id': 9610020, 'chain_type': 'UP_MID_DOWN', 'name': 'AI', 'market_cap': 26949823045632.0, 'stocks_num': 329} ``` :::tip API制限 - 30秒以内に最大60回のリクエストが可能です - ページネーションリクエストは最初のページのみレート制限にカウントされます ::: --- # 産業セクター情報の取得 `get_industrial_plate_info(plate_id)` * **説明** 産業プレート情報を取得します。指定産業プレートの概要情報を返します。 * **パラメータ** パラメータ|タイプ|説明 :-|:-|:- plate_id|int|産業プレートID * **戻り値**
パラメータ タイプ 説明
ret RET_CODE API呼び出し結果
data dict ret == RET_OK の場合、辞書データを返す
str ret != RET_OK の場合、エラー説明を返す
* データフォーマット： フィールド|タイプ|説明 :-|:-|:- plate_id|int|産業プレートID summary|str|プレート概要 * **Example** ```python from futu import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_industrial_plate_info(plate_id=10010508) if ret == RET_OK: for k, v in data.items(): print(f"{k}: {v}") else: print('error:', data) quote_ctx.close() ``` * **Output** ``` plate_id: 10010508 summary: N/A ``` :::tip API制限 - 30秒以内に最大60回のリクエストが可能です - ページネーションリクエストは最初のページのみレート制限にカウントされます ::: --- # 産業セクター構成銘柄の取得 `get_industrial_plate_stock(chain_id=None, plate_id=None, market_list=None, sort_field=None, ascend=None, count=None, page=None)` * **説明** 産業プレート構成銘柄を取得します。指定産業プレートに含まれる銘柄リストを返します。市場フィルタリング、ソートおよびページングに対応しています。 * **パラメータ** パラメータ|タイプ|説明 :-|:-|:- chain_id|int|産業チェーンID（plate_idと二者択一、plate_id優先） plate_id|int|産業プレートID（優先使用） market_list|list[`Market`]|市場フィルタ（HK/US/CN/JP/SG/MY対応）、未指定の場合全部 sort_field|[PlateStockSortField](./quote-market.md#9578)|ソートフィールド、デフォルト時価総額 ascend|bool|昇順 True / 降順 False、デフォルト False（降順） count|int|1ページあたりの数量 [1, 200]、デフォルト 50 page|str|ページカーソル * **戻り値**
パラメータ タイプ 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、データを返す
str ret != RET_OK の場合、エラー説明を返す
* データフォーマット： フィールド|タイプ|説明 :-|:-|:- security|str|銘柄コード（例 `'US.AAPL'`） name|str|銘柄名 * **Example** ```python from futu import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data, next_page, all_count = quote_ctx.get_industrial_plate_stock(plate_id=10010508, count=2) if ret == RET_OK: print(f'データ総数: {all_count}') print(data) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` データ総数: 111 security name 0 US.NVDA 英伟达 1 US.AAPL 苹果 ``` :::tip API制限 - 30秒以内に最大60回のリクエストが可能です - ページネーションリクエストは最初のページのみレート制限にカウントされます ::: --- # ヒートマップデータの取得 `get_heat_map_data(market, sort_field=None, ascend=None, count=None, page=None, plate_type=None)` * **説明** ヒートマップデータを取得します。指定市場のセクターヒートマップ情報（騰落率、時価総額、売買代金、値上がり/値下がり銘柄数、主導銘柄等を含む）を返します。多次元ソートとカーソルページングに対応しています。 * **パラメータ** パラメータ|タイプ|説明 :-|:-|:- market|[Market](./quote.md#3611)|市場タイプ（必須） sort_field|[HeatMapSortField](./quote-market.md#7530)|ソートフィールド、デフォルト騰落率 ascend|bool|True=昇順、False=降順、デフォルト降順 count|int|取得数量 [1, 200]、デフォルト 30 page|str|ページカーソル plate_type|[HeatMapPlateType](./quote-market.md#2519)|セクタータイプ、デフォルト業種セクター * **戻り値**
パラメータ タイプ 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、データを返す
str ret != RET_OK の場合、エラー説明を返す
* データフォーマット： フィールド|タイプ|説明 :-|:-|:- plate|str|セクターコード（例 `'HK.BK1001'`） plate_name|str|セクター名 cur_price|float|最新価格 change_rate|float|騰落率（%） turnover|float|売買代金 volume|int|出来高 market_val|float|時価総額 pe_avg|float|平均PER rise_count|int|値上がり銘柄数 fall_count|int|値下がり銘柄数 equal_count|int|横ばい銘柄数 leader_stock|str|主導銘柄コード description|str|セクター説明 * **Example** ```python from futu import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data, next_page, all_count = quote_ctx.get_heat_map_data(market=Market.US, count=2) if ret == RET_OK: print(f'セクター総数: {all_count}') print(data) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` セクター総数: 145 plate plate_name cur_price change_rate turnover volume market_val pe_avg rise_count fall_count equal_count leader_stock description 0 US.LIST2496 人力资源与就业服务 1229.174414 4.717340 7.345543e+08 437599614 1.502404e+10 -6.112 15 3 2 US.ATLN N/A 1 US.LIST2473 糖果 1696.630748 3.295289 1.178965e+09 14299774 1.176028e+11 49.691 4 1 0 US.RMCF N/A ``` :::tip API制限 - 30秒以内に最大60回のリクエストが可能です - ページネーションリクエストは最初のページのみレート制限にカウントされます ::: --- # 騰落分布の取得 `get_rise_fall_distribution(security=None, market=None)` * **説明** 騰落分布を取得します。指定セクターまたは市場の値上がり/値下がり銘柄数の分布区間を返します。市場全体の騰落パターンの把握に利用できます。 * **パラメータ** パラメータ|タイプ|説明 :-|:-|:- security|str|セクターコード（優先使用、例 `'HK.BK1001'`） market|[Market](./quote.md#3611)|市場タイプ（`security` 未指定時に使用） * **戻り値**
パラメータ タイプ 説明
ret RET_CODE API呼び出し結果
data dict ret == RET_OK の場合、辞書データを返す
str ret != RET_OK の場合、エラー説明を返す
* データフォーマット： フィールド|タイプ|説明 :-|:-|:- plate|str|セクターコード range_list|list[dict]|騰落分布区間リスト type|str|分布タイプ（文字列、下表を参照） left_border|int|左境界値 right_border|int|右境界値 stock_count|int|区間内銘柄数 "RISE_LIMIT"|ストップ高（A株）| "POSITIVE_INFINITY"|(7%, +∞)| "NORMAL_RANGE"|通常区間| "NEGATIVE_INFINITY"|(-∞, -7%)| "FALL_LIMIT"|ストップ安（A株）| * **Example** ```python from futu import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_rise_fall_distribution(market=Market.US) if ret == RET_OK: print(data) else: print('error:', data) quote_ctx.close() ``` * **Output** ``` {'plate': 'US.USAALL', 'range_list': [{'type': 'NEGATIVE_INFINITY', 'left_border': 0, 'right_border': -7, 'stock_count': 817}, {'type': 'NORMAL_RANGE', 'left_border': -7, 'right_border': -5, 'stock_count': 581}, {'type': 'NORMAL_RANGE', 'left_border': 0, 'right_border': 3, 'stock_count': 4168}, {'type': 'NORMAL_RANGE', 'left_border': 0, 'right_border': 0, 'stock_count': 4310}, {'type': 'POSITIVE_INFINITY', 'left_border': 7, 'right_border': 0, 'stock_count': 416}]} ``` :::tip API制限 - 30秒以内に最大60回のリクエストが可能です - ページネーションリクエストは最初のページのみレート制限にカウントされます ::: --- # 市場定義 ## ARKアクティブ取引保有変動タイプ > **ArkActiveTransactionHoldingType** * `INCREASE` 買い増し（デフォルト） * `DECREASE` 保有削減 * `NEW` 新規ポジション * `SOLD_OUT` ポジション解消 ## ARKアクティブ取引ソートフィールド > **ArkActiveTransactionSortField** * `CHANGE_AMOUNT` 変動金額（デフォルト） * `CHANGE_SHARES` 変動株数 ## ARK期間タイプ > **ArkCycleType** * `ONE_DAY` 直近1日（デフォルト） * `FIVE_DAY` 直近5日 * `TEN_DAY` 直近10日 * `THIRTY_DAY` 直近30日 * `SIXTY_DAY` 直近60日 ## ARKファンド保有ソートフィールド > **ArkFundHoldingSortField** * `SHARES` 保有数量（デフォルト） * `WEIGHT_CHANGE` 占比变动 * `SHARES_CHANGE` 保有変動 * `MARKET_VALUE` 市值 * `WEIGHT` ETF 占比 ## ARK保有タイプ > **ArkHoldingType** * `POSITION` 保有（デフォルト） * `INCREASE` 買い増し * `DECREASE` 保有削減 * `NEW` 新規ポジション * `SOLD_OUT` ポジション解消 ## 決算サプライズ時間範囲 > **BeatTerm** * `LATEST` 最近一期（デフォルト） * `LATEST_QUARTER` 最近一期季报 * `LATEST_HALF` 最近一期半年报 * `LATEST_ANNUAL` 最近一期年报 * `ALL` 全部（时间一样季报优先，时间不同最近一期） ## 決算サプライズタイプ > **BeatType** * `EPS` 每股收益 * `REVENUE` 营收 * `EBIT` 息税前利润 ## 配当頻度タイプ > **DistributionFrequency** * `ANNUAL` 年派 * `SEMI_ANNUAL` 半年派 * `QUARTERLY` 季派 * `MONTHLY` 月派 ## 配当ランキングソートフィールド > **DividendRankSortField** * `DIVIDEND_YIELD_TTM` 股息率 TTM * `AVG_DIVIDEND_YIELD_5Y` 5年平均股息率 * `DISTRIBUTION_FREQUENCY` 派息频率 * `DIVIDEND_GROW_YEAR` 股息连续增长年数 * `DIVIDENDS_TTM` 股息 TTM * `PAYOUT_RATIO_LFY` 股息支付率 LFY * `PRICE` 价格 * `MARKET_CAP` 市值 * `CHANGE_RATE` 今日騰落率 * `CHANGE_AMOUNT` 今日騰落額 ## 配当ランキングタイプ > **DividendRankType** * `HIGH_YIELD` 高股息率 * `DIVIDEND_GROWTH` 配当連続増加 ## 決算サプライズソートフィールド > **EarningsBeatSortField** * `BEAT_RATIO` 超预期比率 * `EARNING_DAY_CHG` 決算後初日騰落率 * `RELEASED_DATE` 发布时间 * `ACTUAL` 实际值 * `ESTIMATE` 预测值 * `YOY` 去年同期 * `YOY_GROWTH` 同比增长率 * `PE_TTM` 市盈率 TTM * `DIVIDENDS_TTM` 股息率 TTM * `PRICE` 价格 * `CHANGE_RATE` 今日騰落率 ## 決算指標タイプ > **EarningsCalendarEstimateType** * `EPS` 每股收益（EPS GAAP） * `REVENUE` 总收入 * `EBIT` 息税前利润 ## 決算発表時間帯タイプ > **EarningsCalendarPubType** * `REGULAR` 盘中（未识别出时段） * `BEFORE` 盘前 * `AFTER` 盘后 ## 決算カレンダーソートタイプ > **EarningsCalendarSortType** * `HOT` 热门（デフォルト） * `MARKET_CAP` 历史市值 * `OPTION_VOLUME` 期权成交量（仅港美股） * `IV` 隐含波动率（仅港美股） * `IV_RANK` IV 等级（仅港美股） * `IV_PERCENTILE` IV 百分位数（仅港美股） * `RT_MARKET_CAP` 实时市值 ## 決算カレンダー銘柄リストタイプ > **EarningsCalendarStockListType** * `WATCHLIST` ウォッチリスト * `POSITION` 保有 * `SPECIAL` 特别关注 ## 経済データ重要度 > **EconomicImportance** * `ALL` 全て（デフォルト） * `LOW` 一星（低） * `MEDIUM` 二星（中） * `HIGH` 三星（高） ## ヒートマップセクタータイプ > **HeatMapPlateType** * `INDUSTRY` 業種セクター（デフォルト） * `CONCEPT` 概念板块 * `THEME` 主题板块 ## ヒートマップソートフィールド > **HeatMapSortField** * `CHANGE_RATE` 騰落率（デフォルト） * `MARKET_VAL` 市值 * `TURNOVER` 成交额 * `HOT` 热度 ## 高配当国有企業ソートフィールド > **HighDividendSOESortField** * `MARKET_CAP` 市值（デフォルト） * `DIVIDEND_YIELD_TTM` 股息率 TTM * `PB` 市净率 * `PE_TTM` 市盈率 TTM * `PRICE` 最新价 * `CHANGE_RATIO` 今日騰落率 ## 人気ランキングソートフィールド > **HotListSortField** * `TRADE_HEAT` 交易热度 * `SEARCH_HEAT` 搜索热度 * `NEWS_HEAT` 资讯热度 * `AVERAGE_HEAT` 総合注目度（デフォルト） ## 機関保有変動ソートフィールド > **InstitutionHoldingChangeSortField** * `CHANGE_PCT` 変動比率（デフォルト） * `CHANGE_SHARES` 変動株数 * `HOLDING_DATE` 保有日時 ## 機関保有変動タイプ > **InstitutionHoldingChangeType** * `NEW` 新規ポジション（デフォルト） * `SOLD_OUT` ポジション解消 * `INCREASE` 買い増し * `DECREASE` 保有削減 ## 機関保有リストソートフィールド > **InstitutionHoldingListSortField** * `HOLDING_VALUE` 保有時価総額（デフォルト） * `HOLDING_PCT` 保有比率（銘柄時価総額比） * `LAST_HOLDING_PCT` 前期保有比率 * `CHANGE_SHARES` 変動株数 * `CHANGE_PCT` 変動比率 * `PORTFOLIO_PCT` 機関総ポジション比率 * `INDUSTRY` 行业 * `HOLDING_DATE` 保有日時 ## 機関リストソートフィールド > **InstitutionListSortField** * `POSITION_VALUE` 保有時価総額（デフォルト） * `POSITION_VALUE_CHANGE` 增保有削減 * `POSITION_COUNT` 保有銘柄数 * `POSITION_COUNT_CHANGE` 保有銘柄数変動 ## マクロデータ単位タイプ > **MacroDataUnitType** * `PERCENT` 百分比(%) * `VALUE` 数值 * `INDEX` 指数 ## マクロ経済地域 > **MacroRegion** * `HK` 香港 * `US` 美国 * `JP` 日本 * `SG` 新加坡 * `AU` 澳大利亚 * `CA` 加拿大 * `MY` 马来西亚 * `CN` 中国(沪深) ## 産業チェーンセクター銘柄ソートフィールド > **PlateStockSortField** * `CODE` 代码 * `CHANGE_RATE` 騰落率 * `TURNOVER` 成交额 * `VOLUME` 成交量 * `MARKET_VAL` 市值（デフォルト） ## 価格フィルタタイプ > **PriceFilter** * `ALL` 所有（デフォルト） * `LESS_THAN_1` 小于 1 * `BETWEEN_1_AND_10` 1~10 之间 * `BETWEEN_10_AND_100` 10~100 之间 * `GREATER_THAN_100` 大于 100 * `NEAR_52_WEEK_HIGH` 接近 52 周最高 * `NEAR_52_WEEK_LOW` 接近 52 周最低 ## ランキング期間タイプ > **RankPeriodType** * `FIVE_MIN` 5分钟（デフォルト） * `ONE_DAY` 1日 * `FIVE_DAY` 5日 * `TWENTY_DAY` 20日 * `SIXTY_DAY` 60日 * `ONE_TWENTY_DAY` 120日 * `TWO_FIFTY_DAY` 250日 * `YTD` 年初至今 ## ランキングソート方向 > **RankSortDir** * `DESCENDING` 降順（デフォルト） * `ASCENDING` 昇順 ## レーティング変動タイプ > **RatingChangeType** * `UPGRADE` 格上げ（デフォルト） * `DOWNGRADE` 格下げ * `NEW_RATING` 首次评级 ## 空売りランキングソートフィールド > **ShortSellingSortField** * `SHORT_NUMBER_CHANGE` 空売り変動量（デフォルト） * `SHORT_RATIO_CHANGE` 卖空变化比例 * `SHORT_NUMBER` 卖空数量 * `SHORT_RATIO` 卖空比例 * `VOLUME` 成交量 * `POSITION_VOLUME` 空头保有数量 * `POSITION_RATIO` 空头保有比例 * `DAYS_TO_COVER` 回补天数 * `WEEK_AVG_VOLUME` 近一周日均成交量 * `WEEK_AVG_SHORT_NUMBER` 近一周日均卖空数量 * `WEEK_AVG_SHORT_RATIO` 近一周日均卖空比例 * `MONTH_AVG_VOLUME` 近一月日均成交量 * `MONTH_AVG_SHORT_NUMBER` 近一月日均卖空数量 * `MONTH_AVG_SHORT_RATIO` 近一月日均卖空比例 --- # インジケーター一覧取得 `get_indicator_list(search_key='', lang_type=IndicatorLangType.NONE, search_mode=IndicatorSearchMode.PARTIAL)` * **説明** インジケーター一覧を取得します。キーワード、言語タイプ、検索モードで絞り込みが可能です。 * **パラメータ** パラメータ|型|説明 :-|:-|:- search_key|str|検索キーワード、空文字列の場合は全件返却 lang_type|[IndicatorLangType](./quote.md#9744)|インジケーター言語タイプ、未指定または0は言語フィルタなし search_mode|[IndicatorSearchMode](./quote.md#350)|検索モード、デフォルトは部分一致 * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data list ret == RET_OK の場合、インジケーターリストを返します
str ret != RET_OK の場合、エラー説明を返します
--- # インジケーター計算リクエスト `request_indicator_calc_async(short_name, lang_type, code, kl_type, klines, num=None, input_params=None)` * **説明** インジケーター計算を非同期で起動します。リクエスト送信後、サーバーは `calc_id` を返却し、計算結果は [push-indicator-calc](./push-indicator-calc.md) コールバックで通知されます。 * **パラメータ** パラメータ|型|説明 :-|:-|:- short_name|str|インジケーター短縮名 lang_type|[IndicatorLangType](./quote.md#9744)|言語タイプ code|str|銘柄コード。例：`HK.00700` kl_type|[KLType](./quote.md#6493)|K線タイプ klines|pd.DataFrame または list[dict]|K線データ。`request_history_kline` / `get_cur_kline` の戻り値 num|int または None|最大 N 本の K 線を使用。None は全件 input_params|list[dict] または None|入参上書き `{"index": int, "value": str}`。空の場合はデフォルト * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data str ret == RET_OK の場合、計算タスクID（calcId）を返します
str ret != RET_OK の場合、エラー説明を返します
--- # インジケーター計算結果プッシュ `IndicatorCalcHandlerBase` * **説明** `Qot_RequestIndicatorCalc` で起動した非同期インジケーター計算の結果プッシュを受信します。本プッシュは能動的に呼び出すものではなく、SPI/ハンドラーを登録することで `calcId` 単位で結果を受動的に受信します。 * **コールバックパラメータ** フィールド|型|説明 :-|:-|:- calc_id|str|計算タスクID、リクエスト時に返却された calcId に対応 outputs|list|出力ライン（IndicatorOutputParam）のメタデータ output_rows|list|計算結果、時刻順 --- # 過去ローソク足データ枠の使用明細の取得 `get_history_kl_quota(get_detail=False)` * **概要** 過去ローソク足データ枠の使用明細の取得 * **パラメータ** パラメータ|型|説明 :-|:-|:- get_detail|bool|過去ローソク足データの取得詳細記録を返すかどうか (True：返すFalse：返さない) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data tuple ret == RET_OK の場合、過去ローソク足データ枠データ
str ret != RET_OK の場合、エラーの説明を返す
* 過去ローソク足データ枠データフォーマットは以下の通りです： フィールド|タイプ|説明 :-|:-|:- used_quota|int|使用済み枠 (現在の周期内にダウンロードした銘柄数) remain_quota|int|剩余额度 detail_list|list|過去ローソク足データの取得詳細記録（銘柄コードと取得時間を含む） (list 内の要素の型は dict) - detail_list データ列フォーマットは以下の通りです フィールド|タイプ|説明 :-|:-|:- code|str|銘柄コード name|str|銘柄名 request_time|str|最後に取得した時間の文字列 (フォーマット：yyyy-MM-dd HH:mm:ss) * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_history_kl_quota(get_detail=True) # true に設定すると過去ローソク足データの詳細な取得記録を返す if ret == RET_OK: print(data) else: print('error:', data) quote_ctx.close() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。 ``` * **Output** ```python (2, 98, {'code': 'HK.00123', 'name': '越秀地产', 'request_time': '2023-06-20 19:59:00'}, {'code': 'HK.00700', 'name': '腾讯控股', 'request_time': '2023-07-19 17:48:16'}]) ``` :::tip APIレート制限 * アカウントの資産と取引状況に基づき、過去ローソク足データ枠。が付与されます。そのため7日以内に取得できる銘柄の過去ローソク足データデータ。。詳細なルールは [登録枠 & 過去ローソク足データ枠](../intro/authority.md#8582)。 * 当日消費した過去ローソク足データ枠は、7日後に自動的に解放されます。 ::: --- # 到達価格アラートの設定 `set_price_reminder(code, op, key=None, reminder_type=None, reminder_freq=None, value=None, note=None)` * **概要** 指定銘柄の到達価格アラートの追加、削除、変更、有効化、無効化 * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|銘柄コード op|[SetPriceReminderOp](./quote.md#573)|操作タイプ key|int|識別子。新規追加およびすべて削除の場合は入力不要 reminder_type|[PriceReminderType](./quote.md#5296)|到達価格アラートのタイプ。削除・有効化・無効化の場合はこのパラメータを無視 reminder_freq|[PriceReminderFreq](./quote.md#5296)|到達価格アラートの頻度。削除・有効化・無効化の場合はこのパラメータを無視 value|float|アラート値。削除・有効化・無効化の場合はこのパラメータを無視 (小数点以下3桁まで、超過分は切り捨てられます) note|str|ユーザーが設定する備考。20文字以内のみ対応。削除・有効化・無効化の場合はこのパラメータを無視 reminder_session_list|list|米国株到達価格アラートの時間帯リスト。削除・有効化・無効化の場合はこのパラメータを無視 (- list内の要素タイプは[PriceReminderMarketStatus](./quote.md#123) - 米国株のデフォルト到達価格アラート時間帯：取引時間中+プレ/アフターマーケット) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
key int ret == RET_OK の場合、操作対象の到達価格アラートのkeyを返す
str ret != RET_OK の場合、エラーの説明を返す
* **Example** ```python from moomoo import * import time class PriceReminderTest(PriceReminderHandlerBase): def on_recv_rsp(self, rsp_pb): ret_code, content = super(PriceReminderTest,self).on_recv_rsp(rsp_pb) if ret_code != RET_OK: print("PriceReminderTest: error, msg: %s" % content) return RET_ERROR, content print("PriceReminderTest ", content) # PriceReminderTest 独自の処理ロジック return RET_OK, content quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) handler = PriceReminderTest() quote_ctx.set_handler(handler) ret, data = quote_ctx.get_market_snapshot(['US.AAPL']) if ret == RET_OK: bid_price = data['bid_price'][0] # リアルタイムの最良買い気配値を取得 ask_price = data['ask_price'][0] # リアルタイムの最良売り気配値を取得 # AAPLの全時間帯で最良売り気配値が（ask_price-1）を下回った場合にアラートを設定 ret_ask, ask_data = quote_ctx.set_price_reminder(code='US.AAPL', op=SetPriceReminderOp.ADD, key=None, reminder_type=PriceReminderType.ASK_PRICE_DOWN, reminder_freq=PriceReminderFreq.ALWAYS, value=(ask_price-1), note='123', reminder_session_list=[PriceReminderMarketStatus.US_PRE, PriceReminderMarketStatus.OPEN, PriceReminderMarketStatus.US_AFTER, PriceReminderMarketStatus.US_OVERNIGHT]) if ret_ask == RET_OK: print('売り気配値が（ask_price-1）を下回った時のリマインダー設定成功：', ask_data) else: print('error:', ask_data) # AAPLの全時間帯で最良買い気配値が（bid_price+1）を上回った場合にアラートを設定 ret_bid, bid_data = quote_ctx.set_price_reminder(code='US.AAPL', op=SetPriceReminderOp.ADD, key=None, reminder_type=PriceReminderType.BID_PRICE_UP, reminder_freq=PriceReminderFreq.ALWAYS, value=(bid_price+1), note='456', reminder_session_list=[PriceReminderMarketStatus.US_PRE, PriceReminderMarketStatus.OPEN, PriceReminderMarketStatus.US_AFTER, PriceReminderMarketStatus.US_OVERNIGHT]) if ret_bid == RET_OK: print('買い気配値が（bid_price+1）を上回った時のリマインダー設定成功：', bid_data) else: print('error:', bid_data) time.sleep(15) quote_ctx.close() ``` * **Output** ```python 売り気配値が（ask_price-1）を下回った時のリマインダー設定成功： 1744022257023211123 買い気配値が（bid_price+1）を上回った時のリマインダー設定成功： 1744022257052794489 ``` :::tip ご注意 * APIでの出来高設定はすべて株数単位です。ただしmoomooクライアントでは、A株は手（100株）単位で表示されます * 到達価格アラートタイプには最小精度があります。以下の通り： TURNOVER_UP：売買代金の最小精度は10元（人民元、香港ドル、米ドル）。入力値は自動的に最小精度の整数倍に切り捨てられます。例：【00700の売買代金102元アラート】を設定すると【00700の売買代金100元アラート】になります。【00700の売買代金8元アラート】を設定すると【00700の売買代金0元アラート】になります。 VOLUME_UP：A株の出来高の最小精度は1000株、その他の市場の株式は10株。入力値は自動的に最小精度の整数倍に切り捨てられます。 BID_VOL_UP、ASK_VOL_UP：A株の最良気配注文数量の最小精度は100株。入力値は自動的に最小精度の整数倍に切り捨てられます。 其余到達価格アラートタイプ精度対応到小数点后 3 位 ::: :::tip APIレート制限 * 每 30 秒内最多リクエスト 60 次設定到達価格アラートAPI * 各銘柄の各タイプで設定可能なアラートの上限は10件です ::: --- # 取得到価提醒リスト `get_price_reminder(code=None, market=None)` * **概要** 指定した株式 / 指定した市場に設定された到達価格アラートリストを取得 * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|銘柄コード market|[Market](./quote.md#907)|市場タイプ (入力上海株市場和深セン株市場，都会认為是 A 株市場) 注：code と market の両方が指定された場合、code が優先されます。 * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、到価提醒データ
str ret != RET_OK の場合、エラーの説明を返す
* 到達価格アラートデータフォーマットは以下の通りです： フィールド|タイプ|説明 :-|:-|:- code|str|銘柄コード key|int|識別子。到達価格アラートの変更に使用 reminder_type|[PriceReminderType](./quote.md#5296)|到達価格アラートのタイプ reminder_freq|[PriceReminderFreq](./quote.md#5296)|到達価格アラートの頻度 value|float|提醒值 enable|bool|を有効にするかどうか note|str|備考 (最大20文字まで対応) reminder_session_list|list|米国株到価提醒时段リスト (list中元素タイプ是[PriceReminderMarketStatus](./quote.md#5296)) * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_price_reminder(code='US.AAPL') if ret == RET_OK: print(data) print(data['key'].values.tolist()) # list に変換 else: print('error:', data) print('******************************************') ret, data = quote_ctx.get_price_reminder(code=None, market=Market.US) if ret == RET_OK: print(data) if data.shape[0] > 0: # 到達価格アラートリストが空でない場合 print(data['code'][0]) # 最初のレコードの銘柄コードを取得 print(data['code'].values.tolist()) # list に変換 else: print('error:', data) quote_ctx.close() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。 ``` * **Output** ```python code name key reminder_type reminder_freq value enable note reminder_session_list 0 US.AAPL 苹果 1744021708234288125 BID_PRICE_UP ALWAYS 184.37 True 456 [US_AFTER] 1 US.AAPL 苹果 1744022257052794489 BID_PRICE_UP ALWAYS 185.50 True 456 [OPEN, US_PRE, US_AFTER, US_OVERNIGHT] 2 US.AAPL 苹果 1744021708211891867 ASK_PRICE_DOWN ALWAYS 182.54 True 123 [US_AFTER] 3 US.AAPL 苹果 1744022257023211123 ASK_PRICE_DOWN ALWAYS 183.70 True 123 [OPEN, US_PRE, US_AFTER, US_OVERNIGHT] [1744021708234288125, 1744022257052794489, 1744021708211891867, 1744022257023211123] ****************************************** code name key reminder_type reminder_freq value enable note reminder_session_list 0 US.AAPL 苹果 1744021708234288125 BID_PRICE_UP ALWAYS 184.37 True 456 [US_AFTER] 1 US.AAPL 苹果 1744022257052794489 BID_PRICE_UP ALWAYS 185.50 True 456 [OPEN, US_PRE, US_AFTER, US_OVERNIGHT] 2 US.AAPL 苹果 1744021708211891867 ASK_PRICE_DOWN ALWAYS 182.54 True 123 [US_AFTER] 3 US.AAPL 苹果 1744022257023211123 ASK_PRICE_DOWN ALWAYS 183.70 True 123 [OPEN, US_PRE, US_AFTER, US_OVERNIGHT] 4 US.NVDA 英伟达 1739697581665326308 PRICE_DOWN ALWAYS 102.00 True [OPEN, US_PRE, US_AFTER, US_OVERNIGHT] US.AAPL ['US.AAPL', 'US.AAPL', 'US.AAPL', 'US.AAPL', 'US.NVDA'] ``` :::tip APIレート制限 * 30 秒以内に最大 10 回到価提醒リストAPI ::: --- # ウォッチリストの取得 `get_user_security(group_name)` * **概要** 指定グループのウォッチリストを取得 * **パラメータ** パラメータ|型|説明 :-|:-|:- group_name|str|照会するウォッチリストグループ名 * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、ウォッチリストデータを返します
str ret != RET_OK の場合、エラーの説明を返す
* ウォッチリストデータのフォーマット： フィールド|タイプ|説明 :-|:-|:- code|str|銘柄コード name|str|名字 lot_size|int|1ロットあたりの株数。オプションは1契約あたりの株数、先物は契約乗数 stock_type|[SecurityType](./quote.md#2547)|株式タイプ stock_child_type|[WrtType](./quote.md#4830)|ワラント子タイプ stock_owner|str|ワラントが属する正株のコード、またはオプションの原資産株のコード option_type|[OptionType](./quote.md#1635)|オプションタイプ strike_time|str|オプション行使日 (フォーマット：yyyy-MM-dd 香港株およびA株市場はデフォルトで北京時間、米国株市場はデフォルトで米国東部時間) strike_price|float|オプション行使価格 suspension|bool|オプション取引停止有無 (True：取引停止中) listing_date|str|上場日 (フォーマット：yyyy-MM-dd) stock_id|int|株式 ID delisting|bool|かどうか退市 main_contract|bool|かどうか主連契約 last_trade_time|str|最終取引日 (つなぎ足、当月限、翌月限などの先物にはこのフィールドはありません) * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_user_security("A") if ret == RET_OK: print(data) if data.shape[0] > 0: # ウォッチリストが空でない場合 print(data['code'][0]) # 最初のレコードの銘柄コードを取得 print(data['code'].values.tolist()) # list に変換 else: print('error:', data) quote_ctx.close() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。 ``` * **Output** ```python code name lot_size stock_type stock_child_type stock_owner option_type strike_time strike_price suspension listing_date stock_id delisting main_contract last_trade_time 0 HK.HSImain 恒指期货主连 50 FUTURE N/A N/A N/A 71000662 False True 1 HK.00700 腾讯控股 100 STOCK N/A N/A N/A 2004-06-16 54047868453564 False False HK.HSImain ['HK.HSImain', 'HK.00700'] ``` :::tip ご注意 システムグループの中国語・英語の対応名は以下の通りです 中国語|英語 :-|:-|:- すべて|All A株|CN 香港株|HK 米国株|US オプション|Options 香港株オプション|HK options 米国株オプション|US options お気に入り|Starred 先物|Futures ::: :::tip APIレート制限 * 30秒以内にウォッチリスト取得APIを最大10回までリクエスト可能です * ポジション（Positions）、ファンド（Mutual Fund）、外国為替（Forex）グループの照会には対応していません ::: --- # ウォッチリストグループの取得 `get_user_security_group(group_type = UserSecurityGroupType.ALL)` * **概要** ウォッチリストグループ一覧を取得 * **パラメータ** パラメータ|型|説明 :-|:-|:- group_type|[UserSecurityGroupType](./quote.md#2547)|グループタイプ * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、ウォッチリストグループデータを返します
str ret != RET_OK の場合、エラーの説明を返す
* ウォッチリストグループデータのフォーマット： フィールド|タイプ|説明 :-|:-|:- group_name|str|グループ名 group_type|[UserSecurityGroupType](./quote.md#2547)|グループタイプ * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.get_user_security_group(group_type = UserSecurityGroupType.ALL) if ret == RET_OK: print(data) else: print('error:', data) quote_ctx.close() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。 ``` * **Output** ```python group_name group_type 0 期權 SYSTEM .. ... ... 12 C CUSTOM [13 rows x 2 columns] ``` :::tip APIレート制限 * 30秒以内にウォッチリストグループ取得APIを最大10回までリクエスト可能です ::: --- # ウォッチリストの変更 `modify_user_security(group_name, op, code_list)` * **概要** 指定グループのウォッチリストを変更（システムグループの変更には対応していません） * **パラメータ** パラメータ|型|説明 :-|:-|:- group_name|str|変更するウォッチリストグループ名 op|[ModifyUserSecurityOp](./quote.md#573)|操作タイプ code_list|list|銘柄リスト (list内の要素タイプはstr) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
msg str ret == RET_OK の場合、"success"を返します
ret != RET_OK の場合、msgはエラー説明を返します
* **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) ret, data = quote_ctx.modify_user_security("A", ModifyUserSecurityOp.ADD, ['HK.00700']) if ret == RET_OK: print(data) # success を返す else: print('error:', data) quote_ctx.close() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。 ``` * **Output** ```python success ``` :::tip APIレート制限 * 30秒以内にウォッチリスト変更APIを最大10回までリクエスト可能です * カスタムグループの変更のみ対応しています。システムグループの変更には対応していません * 「全部」ウォッチリストの数量には上限があります：取引未実行のユーザーは500個、取引実行済みのユーザーは2000個（他のグループにウォッチリストを追加すると、「全部」リストにも同期追加されます） * 同名のグループがある場合、ソート順で最初のグループが操作対象となります ::: --- # 到達価格アラートコールバック `on_recv_rsp(self, rsp_pb)` * **概要** 到達価格アラート通知コールバック。設定済み到達価格アラートの通知プッシュを非同期処理します。 リアルタイム到達価格アラート通知プッシュの受信時にこの関数がコールバックされます。派生クラスで on_recv_rsp をオーバーライドしてください。 * **パラメータ** パラメータ|型|説明 :-|:-|:- rsp_pb|Qot_UpdatePriceReminder_pb2.Response|派生クラスでは直接処理不要 * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data dict 当 ret == RET_OK，返す到達価格アラート
str ret != RET_OK の場合、エラーの説明を返す
* 到達価格アラート フィールド|タイプ|説明 :-|:-|:- code|str|銘柄コード name|str|銘柄名 price|float|現在の価格 change_rate|str|現在の騰落率 market_status|[PriceReminderMarketStatus](./quote.md#7928)|トリガーの時間帯 content|str|到達価格アラート文字内容 note|str|備考 (最大20文字まで対応) key|int|到達価格アラート識別子 reminder_type|[PriceReminderType](./quote.md#5296)|到達価格アラートのタイプ set_value|float|用户設定したアラート値 cur_value|float|アラートトリガー時の値 * **Example** ```python import time from moomoo import * class PriceReminderTest(PriceReminderHandlerBase): def on_recv_rsp(self, rsp_pb): ret_code, content = super(PriceReminderTest,self).on_recv_rsp(rsp_pb) if ret_code != RET_OK: print("PriceReminderTest: error, msg: %s" % content) return RET_ERROR, content print("PriceReminderTest ", content) # PriceReminderTest 独自の処理ロジック return RET_OK, content quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) handler = PriceReminderTest() quote_ctx.set_handler(handler) # 到達価格アラート通知コールバックを設定 time.sleep(15) # スクリプトが OpenD のプッシュを受信する時間を15秒に設定 quote_ctx.close() # 接続をクローズすると、OpenD は1分後に対応銘柄の登録を自動解除 ``` * **Output** ```python PriceReminderTest {'code': 'US.AAPL', 'name': '苹果', 'price': 185.750, 'change_rate': 0.11, 'market_status': 'US_PRE', 'content': '買一価高于185.500', 'note': '', 'key': 1744022257052794489, 'reminder_type': 'BID_PRICE_UP', 'set_value': 185.500, 'cur_value': 185.750} ``` :::tip ご注意 * このAPIは継続的にプッシュデータを取得する機能を提供します。一括でリアルタイムデータを取得する場合は [到達価格アラート取得](./get-price-reminder.md) APIをご利用ください * リアルタイムデータの取得とリアルタイムデータコールバックの違いについては、 [如何から登録 API で取得してくださいリアルタイム相場情報？](../qa/quote.md#8509) ::: --- # 相場情報の定義 ## 累積フィルタ属性 > **StockField** * `NONE` 不明 * `CHANGE_RATE` 騰落率 (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します - 例： [-10.2, 20.4] の値範囲) * `AMPLITUDE` 振幅 (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します - 例： [0.5, 20.6] の値範囲) * `VOLUME` 日平均出来高 (- 小数点以下0桁まで、超過分は切り捨てられます - 例： [2000, 70000] の値範囲) * `TURNOVER` 日平均売買代金 (- 小数点以下3桁まで、超過分は切り捨てられます - 例： [1400, 890000] の値範囲) * `TURNOVER_RATE` 売買回転率 (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します - 例： [2, 30] の値範囲) ## 資産クラス > **AssetClass** * `UNKNOW` 不明 * `STOCK` 株式 * `BOND` 債券 * `COMMODITY` コモディティ * `CURRENCY_MARKET` マネーマーケット * `FUTURE` 先物 * `SWAP` スワップ ## コーポレートアクション ## ダークプールステータス > **DarkStatus** * `NONE` ダークプール取引なし * `TRADING` ダークプール取引中 * `END` ダークプール取引終了 ## 財務フィルタ属性 > **StockField** * `NONE` 不明 * `NET_PROFIT` 純利益 (- 小数点以下3桁まで、超過分は切り捨てられます - 例： [100000000, 2500000000] の値範囲) * `NET_PROFIX_GROWTH` 純利益成長率 (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します - 例： [-10, 300] の値範囲) * `SUM_OF_BUSINESS` 売上高 (- 小数点以下3桁まで、超過分は切り捨てられます - 例： [100000000, 6400000000] の値範囲) * `SUM_OF_BUSINESS_GROWTH` 売上高前年同期比成長率 (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します - 例： [-5, 200] の値範囲) * `NET_PROFIT_RATE` 純利益率 (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します - 例： [10, 113] の値範囲) * `GROSS_PROFIT_RATE` 粗利益率 (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します - 例： [4, 65] の値範囲) * `DEBT_ASSET_RATE` 負債比率 (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します - 例： [5, 470] の値範囲) * `RETURN_ON_EQUITY_RATE` ROE（自己資本利益率） (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します - 例： [20, 230] の値範囲) * `ROIC` ROIC（投下資本利益率） (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します - 例： [1.0, 10.0] の値範囲) * `ROA_TTM` ROA（総資産利益率） TTM (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します - 年次報告にのみ適用 - 例： [1.0, 10.0] の値範囲) * `EBIT_TTM` EBIT（税引前利益） TTM (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します - 例： [1000000000, 1000000000] の値範囲) * `EBITDA` EBITDA (- 小数点以下3桁まで、超過分は切り捨てられます - 単位：元 - 例： [1000000000, 1000000000] の値範囲) * `OPERATING_MARGIN_TTM` 営業利益率 TTM (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します - 年次報告にのみ適用 - 例： [1.0, 10.0] の値範囲) * `EBIT_MARGIN` EBIT利益率 (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します - 例： [1.0, 10.0] の値範囲) * `EBITDA_MARGIN ` EBITDA利益率 (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します - 例： [1.0, 10.0] の値範囲) * `FINANCIAL_COST_RATE` 財務コスト率 (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します - 例： [1.0, 10.0] の値範囲) * `OPERATING_PROFIT_TTM ` 営業利益 TTM (- 小数点以下3桁まで、超過分は切り捨てられます - 単位：元 - 年次報告にのみ適用 - 例： [1000000000, 1000000000] の値範囲) * `SHAREHOLDER_NET_PROFIT_TTM` 親会社株主に帰属する純利益 (- 小数点以下3桁まで、超過分は切り捨てられます - 単位：元 - 年次報告にのみ適用 - 例： [1000000000, 1000000000] の値範囲) * `NET_PROFIT_CASH_COVER_TTM` 利益に対するキャッシュ収入比率 (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します - 年次報告にのみ適用 - 例： [1.0, 60.0] の値範囲) * `CURRENT_RATIO` 流動比率 (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します。 - 例： [100, 250] の値範囲) * `QUICK_RATIO` 当座比率 (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します。 - 例： [100, 250] の値範囲) * `CURRENT_ASSET_RATIO` 流動資産比率 (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します。 - 例： [100, 250] の値範囲) * `CURRENT_DEBT_RATIO` 流動負債比率 (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します。 - 例： [100, 250] の値範囲) * `EQUITY_MULTIPLIER` 財務レバレッジ（自己資本乗数） (- 小数点以下3桁まで、超過分は切り捨てられます - 例： [100, 180] の値範囲) * `PROPERTY_RATIO` 有利子負債比率 (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します。 - 例： [50, 100] の値範囲) * `CASH_AND_CASH_EQUIVALENTS` 現金および現金同等物 (- 小数点以下3桁まで、超過分は切り捨てられます - 単位：元 - 例： [1000000000, 1000000000] の値範囲) * `TOTAL_ASSET_TURNOVER` 総資産回転率 (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します。 - 例： [50, 100] の値範囲) * `FIXED_ASSET_TURNOVER` 固定資産回転率 (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します。 - 例： [50, 100] の値範囲) * `INVENTORY_TURNOVER` 棚卸資産回転率 (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します。 - 例： [50, 100] の値範囲) * `OPERATING_CASH_FLOW_TTM` 営業活動キャッシュフロー TTM (- 小数点以下3桁まで、超過分は切り捨てられます - 単位：元 - 年次報告にのみ適用 - 例： [1000000000, 1000000000] の値範囲) * `ACCOUNTS_RECEIVABLE` 売掛金純額 (- 小数点以下3桁まで、超過分は切り捨てられます - 単位：元。 - 例： [1000000000, 1000000000] の値範囲) * `EBIT_GROWTH_RATE` EBIT前年同期比成長率 (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します。 - 例： [1.0, 10.0] の値範囲) * `OPERATING_PROFIT_GROWTH_RATE` 営業利益前年同期比成長率 (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します。 - 例： [1.0, 10.0] の値範囲) * `TOTAL_ASSETS_GROWTH_RATE` 総資産前年同期比成長率 (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します。 - 例： [1.0, 10.0] の値範囲) * `PROFIT_TO_SHAREHOLDERS_GROWTH_RATE` 親会社株主帰属純利益の前年同期比成長率 (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します。 - 例： [1.0, 10.0] の値範囲) * `PROFIT_BEFORE_TAX_GROWTH_RATE` 総利益前年同期比成長率 (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します。 - 例： [1.0, 10.0] の値範囲) * `EPS_GROWTH_RATE` EPS前年同期比成長率 (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します。 - 例： [1.0, 10.0] の値範囲) * `ROE_GROWTH_RATE` ROE前年同期比成長率 (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します。 - 例： [1.0, 10.0] の値範囲) * `ROIC_GROWTH_RATE` ROIC前年同期比成長率 (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します。 - 例： [1.0, 10.0] の値範囲) * `NOCF_GROWTH_RATE` 営業キャッシュフロー前年同期比成長率 (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します。 - 例： [1.0, 10.0] の値範囲) * `NOCF_PER_SHARE_GROWTH_RATE` 1株当たり営業キャッシュフロー前年同期比成長率 (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します。 - 例： [1.0, 10.0] の値範囲) * `OPERATING_REVENUE_CASH_COVER` 営業キャッシュ収入比 (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します。 - 例： [10, 100] の値範囲) * `OPERATING_PROFIT_TO_TOTAL_PROFIT` 営業利益率 (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します。 - 例： [10, 100] の値範囲) * `BASIC_EPS` 基本EPS（1株当たり利益） (- 小数点以下3桁まで、超過分は切り捨てられます - 単位：元 - 例： [0.1, 10] の値範囲) * `DILUTED_EPS` 希薄化EPS（1株当たり利益） (- 小数点以下3桁まで、超過分は切り捨てられます - 単位：元 - 例： [0.1, 10] の値範囲) * `NOCF_PER_SHARE` 1株当たり営業キャッシュフロー純額 (- 小数点以下3桁まで、超過分は切り捨てられます - 単位：元 - 例： [0.1, 10] の値範囲) ## 財務フィルタ属性期間 > **FinancialQuarter** * `NONE` 不明 * `ANNUAL` 年次報告 * `FIRST_QUARTER` 第1四半期報告 * `INTERIM` 中間報告 * `THIRD_QUARTER` 第3四半期報告 * `MOST_RECENT_QUARTER` 直近四半期報告 ## カスタムテクニカル指標属性 > **StockField** * `NONE` 不明 * `PRICE` 最新価格 * `MA` 単純移動平均線 * `MA5` 5日単純移動平均線（非推奨） * `MA10` 10日単純移動平均線（非推奨） * `MA20` 20日単純移動平均線（非推奨） * `MA30` 30日単純移動平均線（非推奨） * `MA60` 60日単純移動平均線（非推奨） * `MA120` 120日単純移動平均線（非推奨） * `MA250` 250日単純移動平均線（非推奨） * `RSI` RSI (指標パラメータのデフォルト値は[12]) * `EMA` 指数移動平均線 * `EMA5` 5日指数移動平均線（非推奨） * `EMA10` 10日指数移動平均線（非推奨） * `EMA20` 20日指数移動平均線（非推奨） * `EMA30` 30日指数移動平均線（非推奨） * `EMA60` 60日指数移動平均線（非推奨） * `EMA120` 120日指数移動平均線（非推奨） * `EMA250` 250日指数移動平均線（非推奨） * `KDJ_K` KDJ指標のK値 (指標パラメータはKDJで指定してください。未指定の場合、デフォルトは [9,3,3]) * `KDJ_D` KDJ指標のD値 (指標パラメータはKDJで指定してください。未指定の場合、デフォルトは [9,3,3]) * `KDJ_J` KDJ指標のJ値 (指標パラメータはKDJで指定してください。未指定の場合、デフォルトは [9,3,3]) * `MACD_DIFF` MACD指標のDIFF値 (指標パラメータはMACDで指定してください。未指定の場合、デフォルトは [12,26,9]) * `MACD_DEA` MACD指標のDEA値 (指標パラメータはMACDで指定してください。未指定の場合、デフォルトは [12,26,9]) * `MACD` MACD (指標パラメータはMACDで指定してください。未指定の場合、デフォルトは [12,26,9]) * `BOLL_UPPER` BOLL指標のUPPER値 (指標パラメータはBOLLで指定してください。未指定の場合、デフォルトは [20,2]) * `BOLL_MIDDLER` BOLL指標のMIDDLER値 (指標パラメータはBOLLで指定してください。未指定の場合、デフォルトは [20,2]) * `BOLL_LOWER` BOLL指標のLOWER値 (指標パラメータはBOLLで指定してください。未指定の場合、デフォルトは [20,2]) * `VALUE` カスタム値（stock_field1はこのフィールドに非対応） ## 指標言語タイプ > **IndicatorLangType** * `UNKNOWN` フィルタなし * `MYLANG` MyLang * `PYTHON` Python ## 指標検索モード > **IndicatorSearchMode** * `PARTIAL` 部分一致（デフォルト） * `EXACT` 完全一致。script フィールドも返却 ## 指標パラメータ値タイプ 指標入参 value dict の type フィールドの取り得る値。 ## 指標形状 type が SHAPE の場合、value は以下の列挙名文字列。 ## 指標線タイプ type が LINE の場合、value は以下の列挙名文字列。 ## 指標パラメータ値 指標入参 value dict はこの Protobuf 構造体に対応。SDK が各タイプを Python 値に変換。 ## 指標入力パラメータ [get_indicator_list](./get-indicator-list.md) が返す inputs 要素の構造。 ## 指標出力パラメータ 1本の出力線メタデータ。[push-indicator-calc](./push-indicator-calc.md) コールバックの outputs 要素と同じ構造。 ## 相対位置 > **RelativePosition** * `NONE` 不明 * `MORE` 大（stock_field1がstock_field2の上方に位置） * `LESS` 小（stock_field1がstock_field2の下方に位置） * `CROSS_UP` ゴールデンクロス（stock_field1が下からstock_field2を上抜け） * `CROSS_DOWN` デッドクロス（stock_field1が上からstock_field2を下抜け） ## テクニカルパターン指標属性 > **PatternField** * `NONE` 不明 * `MA_ALIGNMENT_LONG` MA強気配列（2日連続でMA5>MA10>MA20>MA30>MA60、かつ当日終値が前日終値を上回る） * `MA_ALIGNMENT_SHORT` MA弱気配列（2日連続でMA5EMA10>EMA20>EMA30>EMA60、かつ当日終値が前日終値を上回る） * `EMA_ALIGNMENT_SHORT` EMA弱気配列（2日連続でEMA5 **UserSecurityGroupType** * `NONE` 不明 * `CUSTOM` カスタムグループ * `SYSTEM` システムグループ * `ALL` 全グループ ## 指数オプションカテゴリ > **IndexOptionType** * `NONE` 不明 * `NORMAL` 通常の指数オプション * `SMALL` ミニ指数オプション ## 上場期間 > **IpoPeriod** * `NONE` 不明 * `TODAY` 本日上場 * `TOMORROW` 翌日上場 * `NEXTWEEK` 今後1週間以内に上場 * `LASTWEEK` 過去1週間以内に上場 * `LASTMONTH` 過去1ヶ月以内に上場 ## ワラント発行体 > **Issuer** * `UNKNOW` 不明 * `SG` ソシエテ・ジェネラル * `BP` BNPパリバ * `CS` クレディ・スイス * `CT` シティ * `EA` 東亜 * `GS` ゴールドマン・サックス * `HS` HSBC * `JP` JPモルガン * `MB` マッコーリー * `SC` スタンダードチャータード * `UB` UBS * `BI` 中銀（BOC） * `DB` ドイツ銀行 * `DC` 大和 * `ML` メリルリンチ * `NM` 野村 * `RB` ABNアムロ * `RS` RBS * `BC` バークレイズ * `HT` 海通 * `VT` レイトン * `KC` カレリアン * `MS` モルガン * `GJ` 国泰君安 * `XZ` DBS * `HU` 華泰 * `KS` 韓国投資 * `CI` 信証 ## ローソク足フィールド > **KL_FIELD** * `ALL` すべて * `DATE_TIME` 時間 * `HIGH` 高値 * `OPEN` 始値 * `LOW` 安値 * `CLOSE` 終値 * `LAST_CLOSE` 前のローソク足の終値 * `TRADE_VOL` 出来高 * `TRADE_VAL` 売買代金 * `TURNOVER_RATE` 売買回転率 * `PE_RATIO` PER（株価収益率） * `CHANGE_RATE` 騰落率 ## ローソク足タイプ > **KLType** * `NONE` 不明 * `K_1M` 1分足 * `K_3M` 3分足 (オプションはこのローソク足タイプに非対応) * `K_5M` 5分足 * `K_10M` 10分足 (オプションはこのローソク足タイプに非対応) * `K_15M` 15分足 * `K_30M` 30分足 (オプションはこのローソク足タイプに非対応) * `K_60M` 60分足 * `K_120M` 120分足（2時間） (オプションはこのローソク足タイプに非対応) * `K_180M` 180分足（3時間） (オプションはこのローソク足タイプに非対応) * `K_240M` 240分足（4時間） (オプションはこのローソク足タイプに非対応) * `K_DAY` 日足 * `K_WEEK` 週足 (オプションはこのローソク足タイプに非対応) * `K_MON` 月足 (オプションはこのローソク足タイプに非対応) * `K_QUARTER` 四半期足 (オプションはこのローソク足タイプに非対応) * `K_YEAR` 年足 (オプションはこのローソク足タイプに非対応) ## 周期タイプ > **PeriodType** * `INTRADAY` リアルタイム * `DAY` 日 * `WEEK` 週 * `MONTH` 月 ## 到達価格アラートの市場ステータス > **PriceReminderMarketStatus** * `NONE` 不明 * `OPEN` 立会時間中 * `US_PRE` 米国株プレマーケット * `US_AFTER` 米国株アフターマーケット * `US_OVERNIGHT` 米国株ナイトセッション ワラント > **ModifyUserSecurityOp** * `NONE` 不明 * `ADD` 追加 * `DEL` ウォッチリストから削除 * `MOVE_OUT` グループから移動 ## オプションタイプ（行使時間別） > **OptionAreaType** * `NONE` 不明 * `AMERICAN` アメリカン * `EUROPEAN` ヨーロピアン * `BERMUDA` バミューダ ## オプション イン・ザ・マネー/アウト・オブ・ザ・マネー > **OptionCondType** * `ALL` すべて * `WITHIN` イン・ザ・マネー * `OUTSIDE` アウト・オブ・ザ・マネー ## オプションタイプ（方向別） > **OptionType** * `ALL` すべて * `CALL` コールオプション * `PUT` プットオプション ## オプション戦略タイプ > **OptionStrategyType** * `NONE` 不明 * `SINGLE` 単一オプション * `COVERED` カバード * `SPREAD` バーティカルスプレッド * `STRADDLE` ストラドル * `STRANGLE` ストラングル * `COLLAR` カラー * `BUTTERFLY` バタフライ * `CONDOR` コンドル * `IRON_BUTTERFLY` アイアンバタフライ * `IRON_CONDOR` アイアンコンドル * `CALENDAR_SPREAD` カレンダースプレッド * `DIAGONAL_SPREAD` ダイアゴナルスプレッド * `CUSTOM` カスタム ## ニュースサブタイプ > **NewsSubType** * `ALL` すべて * `NEWS` ニュース * `NOTICE` 公告 * `RATING` レーティング ## セクターコレクションタイプ > **Plate** * `ALL` 全セクター * `INDUSTRY` 業種セクター * `REGION` 地域セクター (香港株・米国株市場の地域分類データは現在空です) * `CONCEPT` テーマセクター * `OTHER` その他セクター ([銘柄の所属セクター取得](../quote/get-owner-plate.md) APIの戻り値のみに使用。他のAPIのリクエストパラメータとしては使用不可) ## 到達価格アラート頻度 > **PriceReminderFreq** * `NONE` 不明 * `ALWAYS` 継続通知 * `ONCE_A_DAY` 1日1回 * `ONCE` 1回のみ通知 ## 到達価格アラートタイプ > **PriceReminderType** * `NONE` 不明 * `PRICE_UP` 価格が以下まで上昇 * `PRICE_DOWN` 価格が以下まで下落 * `CHANGE_RATE_UP` 日次上昇率が以下を超過 (パーセントフィールドで、設定時に20と入力すると20%を意味します) * `CHANGE_RATE_DOWN` 日次下落率が以下を超過 (パーセントフィールドで、設定時に20と入力すると20%を意味します) * `FIVE_MIN_CHANGE_RATE_UP` 5分間上昇率が以下を超過 (パーセントフィールドで、設定時に20と入力すると20%を意味します) * `FIVE_MIN_CHANGE_RATE_DOWN` 5分間下落率が以下を超過 (パーセントフィールドで、設定時に20と入力すると20%を意味します) * `VOLUME_UP` 出来高が以下を超過 * `TURNOVER_UP` 売買代金が以下を超過 * `TURNOVER_RATE_UP` 売買回転率が以下を超過 (パーセントフィールドで、設定時に20と入力すると20%を意味します) * `BID_PRICE_UP` 最良買い気配が以下を超過 * `ASK_PRICE_DOWN` 最良売り気配が以下を下回る * `BID_VOL_UP` 最良買い注文数量が以下を超過 * `ASK_VOL_UP` 最良売り注文数量が以下を超過 * `THREE_MIN_CHANGE_RATE_UP` 3分間上昇率が以下を超過 (パーセントフィールドで、設定時に20と入力すると20%を意味します) * `THREE_MIN_CHANGE_RATE_DOWN` 3分間下落率が以下を超過 (パーセントフィールドで、設定時に20と入力すると20%を意味します) ## ワラント イン・ザ・マネー/アウト・オブ・ザ・マネー > **PriceType** * `UNKNOW` 不明 * `OUTSIDE` アウト・オブ・ザ・マネー、インラインワラントの場合はアウトライン * `WITH_IN` イン・ザ・マネー、インラインワラントの場合はインライン ## ティックプッシュタイプ > **PushDataType** * `UNKNOW` 不明 * `REALTIME` リアルタイムプッシュのデータ * `BYDISCONN` moomooサーバーとの接続が切断された期間に補充取得したデータ (最大50件) * `CACHE` 非リアルタイム・非接続切断補充データ ## 相場情報市場 > **Market** * `NONE` 不明な市場 * `HK` 香港市場 * `US` 米国市場 * `SH` 上海株式市場 * `SZ` 深セン株式市場 * `SG` シンガポール市場 * `JP` 日本市場 * `AU` オーストラリア市場 * `CA` カナダ市場 * `MY` マレーシア市場 * `FX` 外国為替市場 * `CC` 暗号資産市場 ## 市場ステータス > **MarketState** 各市場ステータスの対応時間帯：[こちら](../qa/quote.md#687)をご参照ください * `NONE` 取引なし * `AUCTION` プレマーケットオークション * `WAITING_OPEN` 寄付待ち * `MORNING` 前場 * `REST` 昼休み * `AFTERNOON` 後場／米国株コアタイム * `CLOSED` 大引け * `PRE_MARKET_BEGIN` 米国株プレマーケット取引時間帯 * `PRE_MARKET_END` 米国株プレマーケット取引終了 * `AFTER_HOURS_BEGIN` 米国株アフターマーケット取引時間帯 * `AFTER_HOURS_END` 米国株アフターマーケット終了 * `OVERNIGHT` 米国株ナイトセッション取引時間帯 * `NIGHT_OPEN` ナイトセッション取引時間帯 * `NIGHT_END` ナイトセッション引け * `NIGHT` 米国指数オプション ナイトセッション取引時間帯 * `TRADE_AT_LAST` 米国指数オプション 大引け前取引時間帯 * `FUTURE_DAY_OPEN` デイセッション取引時間帯 * `FUTURE_DAY_BREAK` デイセッション休場 * `FUTURE_DAY_CLOSE` デイセッション引け * `FUTURE_DAY_WAIT_OPEN` 先物立会い待ち * `HK_CAS` 香港株クロージングオークション * `FUTURE_NIGHT_WAIT` ナイトセッション寄付待ち（廃止済み） * `FUTURE_AFTERNOON` 先物午後開始（廃止済み） * `FUTURE_SWITCH_DATE` 米国先物立会い待ち * `FUTURE_OPEN` 米国先物取引時間帯 * `FUTURE_BREAK` 米国先物ミッドブレイク * `FUTURE_BREAK_OVER` 米国先物ブレイク後取引時間帯 * `FUTURE_CLOSE` 米国先物引け * `STIB_AFTER_HOURS_WAIT` 旧名互換性維持。A股アフターアワー待機（15:00-15:05）。対象：上海証券取引所のA股/ETF、深証取引所のA股及び預託証券/ETF。 * `ASHARE_AFTER_HOURS_WAIT` A股アフターアワー待機（15:00-15:05）。`STIB_AFTER_HOURS_WAIT` と同値（27）。 * `STIB_AFTER_HOURS_BEGIN` 旧名互換性維持。A股アフターアワー固定価格取引開始（15:05-15:30）。 * `ASHARE_AFTER_HOURS_BEGIN` A股アフターアワー固定価格取引開始（15:05-15:30）。`STIB_AFTER_HOURS_BEGIN` と同値（28）。 * `STIB_AFTER_HOURS_END` 旧名互換性維持。A股アフターアワー固定価格取引終了（15:30以降）。 * `ASHARE_AFTER_HOURS_END` A股アフターアワー固定価格取引終了（15:30以降）。`STIB_AFTER_HOURS_END` と同値（29）。 ## 米国株取引時間帯 > **Session** * `NONE` 不明 * `RTH` 米国株コアタイム * `ETH` 米国株コアタイム＋プレ・アフターマーケット * `OVERNIGHT` 米国株ナイトセッション（取引APIのみ対応） * `ALL` 米国株全時間帯（相場情報&取引API対応） ## 相場情報の利用権限 > **QotRight** * `UNKNOW` 不明 * `BMP` BMP（この権限では登録に非対応） * `LEVEL1` Level1 * `LEVEL2` Level2 * `SF` 香港株 SF 高級全板相場情報 * `NO` 権限なし ## 関連データタイプ > **SecurityReferenceType** * `UNKNOW` 不明 * `WARRANT` 原資産関連のワラント * `FUTURE` 先物つなぎ足の関連契約 ## ローソク足権利落ち調整タイプ > **AuType** * `NONE` 権利落ち調整なし * `QFQ` 前方権利落ち調整 * `HFQ` 後方権利落ち調整 ## 銘柄ステータス > **SecurityStatus** * `NONE` 不明 * `NORMAL` 正常 * `LISTING` 上場待ち * `PURCHASING` 公募中 * `SUBSCRIBING` 申込中 * `BEFORE_DRAK_TRADE_OPENING` ダークプール開始前 * `DRAK_TRADING` ダークプール取引中 * `DRAK_TRADE_END` ダークプール終了 * `TO_BE_OPEN` 寄付待ち * `SUSPENDED` 取引停止 * `CALLED` 回収済み * `EXPIRED_LAST_TRADING_DATE` 最終取引日経過 * `EXPIRED` 期限切れ * `DELISTED` 上場廃止 * `CHANGE_TO_TEMPORARY_CODE` コーポレートアクション実施中、取引停止、一時コードでの取引に移行 * `TEMPORARY_CODE_TRADE_END` 一時取引終了、取引停止 * `CHANGED_PLATE_TRADE_END` 市場変更済み、旧コード取引停止 * `CHANGED_CODE_TRADE_END` コード変更済み、旧コード取引停止 * `RECOVERABLE_CIRCUIT_BREAKER` 回復可能なサーキットブレーカー * `UN_RECOVERABLE_CIRCUIT_BREAKER` 回復不可能なサーキットブレーカー * `AFTER_COMBINATION` クロージングマッチング * `AFTER_TRANSATION` クロージングトレード ## 銘柄タイプ > **SecurityType** * `NONE` 不明 * `BOND` 債券 * `BWRT` バスケットワラント * `STOCK` 原資産 * `ETF` 信託・ファンド * `WARRANT` ワラント * `IDX` 指数 * `PLATE` セクター * `DRVT` オプション * `PLATESET` セクターセット * `FUTURE` 先物 * `CRYPTO` 暗号資産 ## 到達価格アラート操作タイプの設定 > **SetPriceReminderOp** * `NONE` 不明 * `ADD` 追加 * `DEL` 削除 * `ENABLE` 有効化 * `DISABLE` 無効化 * `MODIFY` 変更 * `DEL_ALL` 全削除（指定銘柄のすべての到達価格アラートを削除） ## ソート方向 > **SortDir** * `NONE` ソートなし * `ASCEND` 昇順 * `DESCEND` 降順 ## ソートフィールド > **SortField** * `NONE` 不明 * `CODE` コード * `CUR_PRICE` 最新値 * `PRICE_CHANGE_VAL` 騰落額 * `CHANGE_RATE` 騰落率 % * `STATUS` ステータス * `BID_PRICE` 買値 * `ASK_PRICE` 売値 * `BID_VOL` 買い数量 * `ASK_VOL` 売り数量 * `VOLUME` 出来高 * `TURNOVER` 売買代金 * `AMPLITUDE` 振幅 % * `SCORE` 総合スコア * `PREMIUM` プレミアム % * `EFFECTIVE_LEVERAGE` 実効レバレッジ * `DELTA` デルタ値 (コール・プットのみ対応) * `IMPLIED_VOLATILITY` インプライドボラティリティ (コール・プットのみ対応) * `TYPE` タイプ * `STRIKE_PRICE` 行使価格 * `BREAK_EVEN_POINT` 損益分岐点 * `MATURITY_TIME` 満期日 * `LIST_TIME` 上場日 * `LAST_TRADE_TIME` 最終取引日 * `LEVERAGE` レバレッジ比率 * `IN_OUT_MONEY` イン・ザ・マネー/アウト・オブ・ザ・マネー % * `RECOVERY_PRICE` 回収価格 (CBBCのみ対応) * `CHANGE_PRICE` 転換価格 * `CHANGE` 転換比率 * `STREET_RATE` ストリート在庫比率 % * `STREET_VOL` ストリート在庫数量 * `WARRANT_NAME` ワラント名 * `ISSUER` 発行体 * `LOT_SIZE` 1ロット * `ISSUE_SIZE` 発行量 * `UPPER_STRIKE_PRICE` 上限価格 (インラインワラントのみ) * `LOWER_STRIKE_PRICE` 下限価格 (インラインワラントのみ) * `INLINE_PRICE_STATUS` インライン/アウトライン (インラインワラントのみ) * `PRE_CUR_PRICE` プレマーケット最新値 * `AFTER_CUR_PRICE` アフターマーケット最新値 * `PRE_PRICE_CHANGE_VAL` プレマーケット騰落額 * `AFTER_PRICE_CHANGE_VAL` アフターマーケット騰落額 * `PRE_CHANGE_RATE` プレマーケット騰落率 % * `AFTER_CHANGE_RATE` アフターマーケット騰落率 % * `PRE_AMPLITUDE` プレマーケット振幅 % * `AFTER_AMPLITUDE` アフターマーケット振幅 % * `PRE_TURNOVER` プレマーケット売買代金 * `AFTER_TURNOVER` アフターマーケット売買代金 * `LAST_SETTLE_PRICE` 前日決済値 * `POSITION` ポジション数量 * `POSITION_CHANGE` 日次ポジション増減 * `MARKET_CAP` 市値，用于 Qot_GetValuationPlateStockList * `VALUATION` 估值，用于 Qot_GetValuationPlateStockList * `FORWARD_VALUATION` 预测估值，用于 Qot_GetValuationPlateStockList * `HISTORICAL_PERCENTILE` 历史分位，用于 Qot_GetValuationPlateStockList * `HOLDER_QUANTITY` 持株株数、株主協定用 * `SHARE_CHANGE_NUM` 持株変動数、株主協定用 * `HOLDING_DATE` 持株日付、株主協定用 * `HOLDER_PCT_CHANGE` 変動比率，用于股东协议 * `HOLDER_CHANGE_AMOUNT` 変動金額，用于股东协议 * `HOLDER_PCT` 持株比率、株主協定用 ## ソート順序 > **SortType** * `NONE` 未知 * `DESC` 降順 * `ASC` 昇順 ## 財務報告タイプ > **F10Type** * `NONE` 未知 * `Q1` 单季报，Q1 * `Q2` 单季报，Q2 * `Q3` 单季报，Q3 * `Q4` 单季报，Q4 * `Q6` 累计季报，Q6（Q1+Q2） * `Q9` 累计季报，Q9（Q1+Q2+Q3） * `ANNUAL` 年报 * `QUARTERLY` 单季报组合（Q1, Q2, Q3, Q4） * `QUARTERLY_ANNUAL` 单季报 + 年报 * `MUL_QUARTERLY` 累计季报（Q1, Q6, Q9, Annual） ## 財務報告発表時間タイプ > **EarningsPubTimeType** * `NONE` 未知 * `PRE_MARKET` 盘前发布 * `AFTER_MARKET` 盘后发布 * `DURING_MARKET` 盘中发布 ## バリュエーションタイプ > **ValuationType** * `NONE` 未知 * `PE` 市盈率 * `PB` 市净率 * `PS` 市销率 ## 財務諸表タイプ > **FinancialStatementsType** * `NONE` 未知 * `INCOME` 利润表 * `BALANCE_SHEET` 资产负债表 * `CASH_FLOW` 现金流量表 * `MAIN_INDEX` 关键指标 ## 収益内訳ディメンションタイプ > **RevenueBreakdownType** * `NONE` 未知 * `PRODUCT` 产品 * `INDUSTRY` 行业 * `REGION` 地区 * `BUSINESS` 业务 ## アナリスト評価タイプ > **ResearchRatingType** * `NONE` 未知 * `SELL` Sell（卖出） * `UNDERPERFORM` Underperform（跑输大盘） * `HOLD` Hold（持有） * `BUY` Buy（买入） * `STRONG_BUY` Strong Buy（强力推荐） ## リサーチ評価ディメンションタイプ > **ResearchRatingDimensionType** * `NONE` 未知 * `INSTITUTION` 機関次元（デフォルト） * `ANALYST` 分析师维度 ## モーニングスタータイプ > **MorningstarRatingType** * `NONE` 未知 * `QUANTITATIVE` 定量评级（系统模型给出） * `QUALITATIVE` 定性评级（分析师人工给出） ## バリュエーション履歴区間タイプ > **ValuationIntervalType** * `NONE` 未知 * `MONTH3` 3个月 * `MONTH6` 6个月 * `YEAR1` 1年 * `YEAR2` 2年 * `YEAR3` 3年 * `YEAR5` 5年 * `YEAR10` 10年 * `YEAR20` 20年 * `YEAR30` 30年 * `SINCE2019` 2019年から ## コーポレートアクション再編タイプ > **ReformType** * `NONE` 未知 * `STOCK_SPLIT` 拆股 * `STOCK_MERGE` 合股 * `BONUS_SHARE` 送股 * `CAPITALIZATION_OF_RESERVES` 转增股 * `RIGHTS_ISSUE` 配股 * `NEW_SHARE_ISSUANCE` 增发 * `CASH_DIVIDEND` 现金分红 * `SPECIAL_DIVIDEND` 特别股息 * `SPINOFF` 公司分立 ## 保有変動フィルタータイプ > **HoldingChangesFilterType** * `NONE` 全て（デフォルト） * `INCREASE` 買い増し * `DECREASE` 保有削減 * `NEW_IN` 新規ポジション * `CLOSE_OUT` ポジション解消 ## 株主保有明細機関タイプ > **HolderDetailType** * `DEFAULT` デフォルト不过滤，按服务端デフォルト逻辑返回 * `ALL` 全部 * `UNCLASSIFIED` その他の機関 * `TRADITIONAL_INVESTMENT_MANAGER` 传统投资经理 * `HEDGE_FUND_MANAGER` ヘッジファンド * `VC_OR_PE` 风险资本/私募股权投资 * `CORPORATE_PENSION_PLAN_SPONSOR` 企业年金 * `FOUNDATION_FUND_SPONSOR` 基金会基金 * `INSURANCE_COMPANY` 保险公司 * `BANK_OR_INVESTMENT_BANK` 银行/投资银行 * `FAMILY_OFFICES_OR_TRUST` 家族办公室/信托 * `SOVEREIGN_WEALTH_FUND` 主权财富基金 * `REIT` REIT * `STRUCTURED_FINANCE_POOL_MANAGER` ストラクチャードファイナンスマネージャー * `UNION_PENSION_PLAN_SPONSOR` 联合养老金 * `GOVERNMENT_PENSION_PLAN_SPONSOR` 政府养老金 * `ENDOWMENT_FUND_SPONSOR` 捐赠基金 * `INDIVIDUAL_INSIDERS` 个人 * `ISSUE_SPONSORED_ADR` ADS * `CORPORATIONS_PUBLIC` 上市公司 * `CORPORATIONS_PRIVATE` 未公开上市公司 * `STATE_OWNED_SHARES` 国有股 ## 会社概要フィールドタイプ > **CompanyProfileFieldType** * `SOURCE_TEXT` 文本 * `LINK_TYPE` 链接 * `INDEPENDENT_TITLE` 独立标题 ## ブローカー純売買方向 > **BuySellType** * `NONE` 未知 * `NET_BUY` 净买入 * `NET_SELL` 净卖出 ## オプションボラティリティ照会期間タイプ > **OptionVolatilityTimePeriodType** * `NONE` 未知 * `WEEK` 周 * `MONTH` 月（デフォルト） * `QUARTER` 季度 * `HALF_YEAR` 半年 * `YEAR` 年 ## オプション・インプライドボラティリティ状態 > **OptionImpvolStatusType** * `IMPVOL_FLUCTUATING` 期权波动率处于震荡中 * `IMPVOL_OVERVALUED` 期权波动率处于高估 * `IMPVOL_UNDERVALUED` 期权波动率处于低估 ## 基本フィルタ属性 > **StockField** * `NONE` 不明 * `STOCK_CODE` 銘柄コード，範囲の上限・下限値は指定不可。 * `STOCK_NAME` 銘柄名，範囲の上限・下限値は指定不可。 * `CUR_PRICE` 最新値 (- 小数点以下3桁まで、超過分は切り捨てられます - 例： [10, 20] の値範囲) * `CUR_PRICE_TO_HIGHEST52_WEEKS_RATIO` **(CP - WH52) / WH52**
**CP**：現在値
**WH52**：52週高値
PC版の「52週高値からの乖離率」に対応 (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します - 例： [-30, -10] の値範囲) * `CUR_PRICE_TO_LOWEST52_WEEKS_RATIO` **(CP - WL52) / WL52**
**CP**：現在値
**WL52**：52週安値
PC版の「52週安値からの乖離率」に対応 (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します - 例： [20, 40] の値範囲) * `HIGH_PRICE_TO_HIGHEST52_WEEKS_RATIO` **(TH - WH52) / WH52**
**TH**：本日高値
**WH52**：52週高値
(- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します - 例： [-3, -1] の値範囲) * `LOW_PRICE_TO_LOWEST52_WEEKS_RATIO` **(TL - WL52) / WL52**
**TL**：本日安値
**WL52**：52週安値
(- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します - 例： [10, 70] の値範囲) * `VOLUME_RATIO` 出来高比率 (- 小数点以下3桁まで、超過分は切り捨てられます - 例： [0.5, 30] の値範囲) * `BID_ASK_RATIO` 委託比率 (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します - 例： [-20, 80.5] の値範囲) * `LOT_PRICE` 1ロット価格 (- 小数点以下3桁まで、超過分は切り捨てられます - 例： [40, 100] の値範囲) * `MARKET_VAL` 時価総額 (- 小数点以下3桁まで、超過分は切り捨てられます - 例： [50000000, 3000000000] の値範囲) * `PE_ANNUAL` PER（静態） (- 小数点以下3桁まで、超過分は切り捨てられます - 例： [-8, 65.3] の値範囲) * `PE_TTM` PER（TTM） (- 小数点以下3桁まで、超過分は切り捨てられます - 例： [-10, 20.5] の値範囲) * `PB_RATE` PBR（株価純資産倍率） (- 小数点以下3桁まで、超過分は切り捨てられます - 例： [0.5, 20] の値範囲) * `CHANGE_RATE_5MIN` 5分間騰落率 (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します - 例： [-5, 6.3] の値範囲) * `CHANGE_RATE_BEGIN_YEAR` 年初来騰落率 (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します - 例： [-50.1, 400.7] の値範囲) * `PS_TTM` PSR（TTM） (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します - 例： [100, 500] の値範囲) * `PCF_TTM` PCR（TTM） (- 小数点以下3桁まで、超過分は切り捨てられます - パーセントフィールドです。デフォルトで%は表示されません。例：20は実際には20%に相当します - 例： [100, 1000] の値範囲) * `TOTAL_SHARE` 総株式数 (- 小数点以下3桁まで、超過分は切り捨てられます - 単位：株 - 例： [1000000000, 1000000000] の値範囲) * `FLOAT_SHARE` 流通株式数 (- 小数点以下3桁まで、超過分は切り捨てられます - 単位：株 - 例： [1000000000, 1000000000] の値範囲) * `FLOAT_MARKET_VAL` 流通時価総額 (- 小数点以下3桁まで、超過分は切り捨てられます - 単位：元 - 例： [1000000000, 1000000000] の値範囲) ## 登録タイプ > **SubType** * `NONE` 不明 * `QUOTE` 基本株価情報 * `ORDER_BOOK` 板情報 * `TICKER` ティック * `RT_DATA` タイムシェア * `K_DAY` 日足 * `K_5M` 5分足 * `K_15M` 15分足 * `K_30M` 30分足 * `K_60M` 60分足 * `K_1M` 1分足 * `K_WEEK` 週足 * `K_MON` 月足 * `BROKER` ブローカーキュー * `K_QURATER` 四半期足 * `K_YEAR` 年足 * `K_3M` 3分足 * `K_10M` 10分足 * `K_120M` 120分足（2時間） * `K_180M` 180分足（3時間） * `K_240M` 240分足（4時間） * `ORDER_BOOK_ODD` 碎股（端株）板情報 ## 板情報タイプ > **OrderBookType** * `NORMAL` 整株板（デフォルト） * `ODD` 碎株板 ## ティック約定方向 > **TickerDirect** * `NONE` 不明 * `BUY` 外盤 (外盤（買い主導）、売り1気配以上の価格で約定) * `SELL` 内盤 (内盤（売り主導）、買い1気配以下の価格で約定) * `NEUTRAL` 中性盤 (中性盤、買い1気配と売り1気配の間の価格でマッチング約定) ## ティック約定タイプ > **TickerType** * `UNKNOWN` 不明 * `AUTO_MATCH` 自動マッチング * `LATE` 寄付前約定 * `NON_AUTO_MATCH` 非自動マッチング * `INTER_AUTO_MATCH` 同一ブローカー自動マッチング * `INTER_NON_AUTO_MATCH` 同一ブローカー非自動マッチング * `ODD_LOT` 端株取引 * `AUCTION` オークション取引 * `BULK` バッチ取引 * `CRASH` 現金取引 * `CROSS_MARKET` クロスマーケット取引 * `BULK_SOLD` 一括売却 * `FREE_ON_BOARD` 基準外価格取引 * `RULE127_OR155` 第127条取引（NYSE規則）または第155条取引 * `DELAY` 遅延取引 * `MARKET_CENTER_CLOSE_PRICE` 終値集中約定 * `NEXT_DAY` 翌日決済取引 * `MARKET_CENTER_OPENING` 始値集中約定取引 * `PRIOR_REFERENCE_PRICE` 前参照価格 * `MARKET_CENTER_OPEN_PRICE` 始値集中約定 * `SELLER` 売り方 * `T` T類取引（プレマーケットおよびアフターマーケット取引） * `EXTENDED_TRADING_HOURS` 延長取引時間帯 * `CONTINGENT` 統合取引 * `AVERAGE_PRICE` 平均価格約定 * `OTC_SOLD` 店頭売却 * `ODD_LOT_CROSS_MARKET` 端株クロスマーケット取引 * `DERIVATIVELY_PRICED` デリバティブ価格付け * `REOPENINGP_RICED` 再開場価格付け * `CLOSING_PRICED` 引値価格付け * `COMPREHENSIVE_DELAY_PRICE` 総合遅延価格 * `OVERSEAS` 取引の一方が香港取引所のメンバーではない場外取引 ## 取引日照会市場 > **TradeDateMarket** * `NONE` 不明 * `HK` 香港市場 (- 株式、ETFs、ワラント、CBBC、オプション、非祝日取引先物を含む - 祝日取引先物は含まない) * `US` 米国市場 (- 株式、ETFs、オプションを含む - 先物は含まない) * `CN` A株市場 * `NT` 深セン（上海）ストックコネクト * `ST` ストックコネクト（深セン・上海） * `JP_FUTURE` 日本先物 * `SG_FUTURE` シンガポール先物 ## 取引日タイプ > **TradeDateType** * `WHOLE` 終日取引 * `MORNING` 午前取引、午後休場 * `AFTERNOON` 午後取引、午前休場 ## ワラントステータス > **WarrantStatus** * `NONE` 不明 * `NORMAL` 正常 * `SUSPEND` 取引停止 * `STOP_TRADE` 取引終了 * `PENDING_LISTING` 上場待ち ## ワラントタイプ > **WrtType** * `NONE` 不明 * `CALL` コールワラント * `PUT` プットワラント * `BULL` ブル証券 * `BEAR` ベア証券 * `INLINE` インラインワラント ## 所属取引所 > **ExchType** * `NONE` 不明 * `HK_MAINBOARD` HKEX・メインボード * `HK_GEMBOARD` HKEX・GEM * `HK_HKEX` HKEX（香港取引所） * `US_NYSE` NYSE（ニューヨーク証券取引所） * `US_NASDAQ` NASDAQ（ナスダック） * `US_PINK` OTC市場 * `US_AMEX` AMEX（アメリカン証券取引所） * `US_OPTION` 米国 (米国株オプションのみ) * `US_NYMEX` NYMEX * `US_COMEX ` COMEX * `US_CBOT` CBOT * `US_CME` CME * `US_CBOE` CBOE * `CN_SH` SSE（上海証券取引所） * `CN_SZ` SZSE（深セン証券取引所） * `CN_STIB` 科創板（STAR Market） * `SG_SGX` SGX（シンガポール取引所） * `JP_OSE` 大阪取引所 * `CC_CRYPTO` 暗号資産取引所 ## 相場情報共通パラメータヘッダー **QotHeader** ```protobuf message QotHeader { optional int32 securityFirm = 1; //証券会社識別子、Trd_Common.SecurityFirm を参照 } ``` ## 証券識別子 **Security** ```protobuf message Security { required int32 market = 1; //QotMarket、相場情報市場 required string code = 2; //コード } ``` ## ローソク足データ **KLine** ```protobuf message KLine { required string time = 1; //タイムスタンプ文字列（フォーマット：yyyy-MM-dd HH:mm:ss） required bool isBlank = 2; //空コンテンツのデータポイントかどうか。trueの場合は時間情報のみ optional double highPrice = 3; //高値 optional double openPrice = 4; //始値 optional double lowPrice = 5; //安値 optional double closePrice = 6; //終値 optional double lastClosePrice = 7; //前のローソク足の終値 optional int64 volume = 8; //出来高 optional double turnover = 9; //売買代金 optional double turnoverRate = 10; //売買回転率（パーセントフィールドで小数表示） optional double pe = 11; //PER optional double changeRate = 12; //騰落率（パーセントフィールドでデフォルトで%は表示されません。例：20は実際には20%に相当） optional double timestamp = 13; //タイムスタンプ } ``` ## 基本株価情報のオプション固有フィールド **OptionBasicQotExData** ```protobuf message OptionBasicQotExData { required double strikePrice = 1; //行使価格 required int32 contractSize = 2; //1 契約あたりの株数(整型データ) optional double contractSizeFloat = 17; //1 契約あたりの株数（浮点型データ） required int32 openInterest = 3; //未決済建玉数 required double impliedVolatility = 4; //IV（インプライドボラティリティ）（このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します） required double premium = 5; //プレミアム（このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します） required double delta = 6; //グリークス Delta required double gamma = 7; //グリークス Gamma required double vega = 8; //グリークス Vega required double theta = 9; //グリークス Theta required double rho = 10; //グリークス Rho optional int32 netOpenInterest = 11; //ネット未決済建玉数，香港株オプションのみ適用 optional int32 expiryDateDistance = 12; //距离満期日天数，負の数は満期済みを示します optional double contractNominalValue = 13; //契約想定元本，香港株オプションのみ適用 optional double ownerLotMultiplier = 14; //相等正株手数，指数オプションにはこのフィールドはありません，香港株オプションのみ適用 optional int32 optionAreaType = 15; //OptionAreaType、オプションタイプ（行使時間別） optional double contractMultiplier = 16; //契約乗数 optional int32 indexOptionType = 18; //IndexOptionType、指数オプションタイプ } ``` ## 基本株価情報の先物固有フィールド **FutureBasicQotExData** ```protobuf message FutureBasicQotExData { required double lastSettlePrice = 1; //前日決済値 required int32 position = 2; //建玉数 required int32 positionChange = 3; //日次建玉変動 optional int32 expiryDateDistance = 4; //満期日までの日数 } ``` ## 基本株価情報 **BasicQot** ```protobuf message BasicQot { required Security security = 1; //株式 optional string name = 24; // 銘柄名 required bool isSuspended = 2; //かどうか売買停止 required string listTime = 3; //上場日文字列（このフィールドはメンテナンス停止、非推奨。フォーマット：yyyy-MM-dd） required double priceSpread = 4; //価差 required string updateTime = 5; //最新値の更新時刻文字列（フォーマット：yyyy-MM-dd HH:mm:ss）、他のフィールドには適用されません required double highPrice = 6; //高値 required double openPrice = 7; //始値 required double lowPrice = 8; //安値 required double curPrice = 9; //最新価格 required double lastClosePrice = 10; //前日終値 required int64 volume = 11; //出来高 required double turnover = 12; //売買代金 required double turnoverRate = 13; //売買回転率（このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します） required double amplitude = 14; //振幅（このフィールドはパーセントフィールドで、デフォルトでは % を表示しません。20 は実際には 20% に対応します） optional int32 darkStatus = 15; //DarkStatus、ダークプール取引ステータス optional OptionBasicQotExData optionExData = 16; //オプション固有フィールド optional double listTimestamp = 17; //上場日タイムスタンプ（このフィールドはメンテナンス停止、非推奨） optional double updateTimestamp = 18; //最新値の更新タイムスタンプ、他のフィールドには適用されません optional PreAfterMarketData preMarket = 19; //プレマーケットデータ optional PreAfterMarketData afterMarket = 20; //アフターマーケットデータ optional int32 secStatus = 21; //SecurityStatus, 株式ステータス optional FutureBasicQotExData futureExData = 22; //先物固有フィールド } ``` ## プレ/アフターマーケットデータ **PreAfterMarketData** ```protobuf //米国株はプレ/アフターマーケットデータに対応 //科創板はアフターマーケットデータのみ対応：出来高、売買代金 message PreAfterMarketData { optional double price = 1; // プレ/アフターマーケットの価格 optional double highPrice = 2; // プレ/アフターマーケットの高値 optional double lowPrice = 3; // プレ/アフターマーケットの安値 optional int64 volume = 4; // プレ/アフターマーケットの出来高 optional double turnover = 5; // プレ/アフターマーケットの売買代金 optional double changeVal = 6; // プレ/アフターマーケットの騰落額 optional double changeRate = 7; // プレ/アフターマーケットの騰落率（パーセントフィールド。デフォルトでは%を表示しません。例：20は実際には20%に相当） optional double amplitude = 8; // プレ/アフターマーケットの振幅（パーセントフィールド。デフォルトでは%を表示しません。例：20は実際には20%に相当） } ``` ## 分時データ **TimeShare** ```protobuf message TimeShare { required string time = 1; //時刻文字列（形式：yyyy-MM-dd HH:mm:ss） required int32 minute = 2; //0時からの経過分数 required bool isBlank = 3; //空コンテンツのデータポイントかどうか。trueの場合は時間情報のみ optional double price = 4; //現在値 optional double lastClosePrice = 5; //前日終値 optional double avgPrice = 6; //平均価格 optional int64 volume = 7; //出来高 optional double turnover = 8; //売買代金 optional double timestamp = 9; //タイムスタンプ } ``` ## 証券基本静的情報 **SecurityStaticBasic** ```protobuf message SecurityStaticBasic { required Qot_Common.Security security = 1; //株式 required int64 id = 2; //株式 ID required int32 lotSize = 3; //1ロットの数量。オプションの場合は1契約あたりの株数 required int32 secType = 4; //Qot_Common.SecurityType, 株式タイプ required string name = 5; //銘柄名 required string listTime = 6; //上場日時文字列（このフィールドはメンテナンス停止のため非推奨。形式：yyyy-MM-dd） optional bool delisting = 7; //上場廃止かどうか optional double listTimestamp = 8; //上場タイムスタンプ（このフィールドはメンテナンス停止のため非推奨） optional int32 exchType = 9; //Qot_Common.ExchType, 所属取引所 } ``` ## ワラント追加静的情報 **WarrantStaticExData** ```protobuf message WarrantStaticExData { required int32 type = 1; //Qot_Common.WarrantType, ワラントタイプ required Qot_Common.Security owner = 2; //原資産正株 } ``` ## オプション追加静的情報 **OptionStaticExData** ```protobuf message OptionStaticExData { required int32 type = 1; //Qot_Common.OptionType, オプション required Qot_Common.Security owner = 2; //原資産株 required string strikeTime = 3; //行使日（フォーマット：yyyy-MM-dd） required double strikePrice = 4; //行使価格 required bool suspend = 5; //かどうか売買停止 required string market = 6; //発行市場名 optional double strikeTimestamp = 7; //行使日タイムスタンプ optional int32 indexOptionType = 8; //Qot_Common.IndexOptionType, 指数オプションのタイプ。指数オプションでのみ有効 optional int32 expirationCycle = 9; // ExpirationCycle, 受渡周期 optional int32 optionStandardType = 10; // OptionStandardType, 標準オプション optional int32 optionSettlementMode = 11; // OptionSettlementMode, 決済方式 } ``` ## 先物追加静的情報 **FutureStaticExData** ```protobuf message FutureStaticExData { required string lastTradeTime = 1; //最后取引日，主連以外の先物契約のみこのフィールドあり optional double lastTradeTimestamp = 2; //最終取引日タイムスタンプ，主連以外の先物契約のみこのフィールドあり required bool isMainContract = 3; //かどうか主連契約 } ``` ## 証券静的情報 **SecurityStaticInfo** ```protobuf message SecurityStaticInfo { required SecurityStaticBasic basic = 1; //証券基本静的情報 optional WarrantStaticExData warrantExData = 2; //ワラント追加静的情報 optional OptionStaticExData optionExData = 3; //オプション追加静的情報 optional FutureStaticExData futureExData = 4; //先物追加静的情報 } ``` ## 売買ブローカー **Broker** ```protobuf message Broker { required int64 id = 1; //ブローカー ID required string name = 2; //ブローカー名称 required int32 pos = 3; //ブローカー階層 //以下は香港株SF相場情報固有のフィールド optional int64 orderID = 4; //取引所注文 ID。取引APIが返す注文 ID とは異なる optional int64 volume = 5; //注文株数 } ``` ## ティック約定 **Ticker** ```protobuf message Ticker { required string time = 1; //時刻文字列（形式：yyyy-MM-dd HH:mm:ss） required int64 sequence = 2; // 一意識別子 required int32 dir = 3; //TickerDirection, 売買方向 required double price = 4; //価格 required int64 volume = 5; //出来高 required double turnover = 6; //売買代金 optional double recvTime = 7; //プッシュデータ受信時のローカルタイムスタンプ。遅延の特定に使用 optional int32 type = 8; //TickerType, ティックタイプ optional int32 typeSign = 9; //ティックタイプシンボル optional int32 pushDataType = 10; //プッシュ状況の区別用。プッシュ時のみこのフィールドあり optional double timestamp = 11; //タイムスタンプ } ``` ## 板情報明細 **OrderBookDetail** ```protobuf message OrderBookDetail { required int64 orderID = 1; //取引所注文 ID。取引APIが返す注文 ID とは異なる required int64 volume = 2; //注文株数 } ``` ## 板情報 **OrderBook** ```protobuf message OrderBook { required double price = 1; //委託価格 required int64 volume = 2; //委託数量 required int32 orederCount = 3; //委託注文数 repeated OrderBookDetail detailList = 4; //注文情報。香港株 SF および米国株深層板情報固有 } ``` ## 持株変動 **ShareHoldingChange** ```protobuf message ShareHoldingChange { required string holderName = 1; //保有者名称（機関名 または ファンド名 または 役員名） required double holdingQty = 2; //現在の保有株数 required double holdingRatio = 3; //現在の保有比率（パーセントフィールド。デフォルトでは%を表示しません。例：20は実際には20%に相当） required double changeQty = 4; //前回からの変動数量 required double changeRatio = 5; //前回からの変動比率（パーセントフィールド。デフォルトでは%を表示しません。例：20は実際には20%に相当。自身に対する比率であり全体に対する比率ではありません。例：総株数1万株、保有100株で保有比率1%、50株売却の場合、変動比率は50%であり0.5%ではありません） required string time = 6; //公開時刻（形式：yyyy-MM-dd HH:mm:ss） optional double timestamp = 7; //タイムスタンプ } ``` ## 単一登録タイプ情報 **SubInfo** ```protobuf message SubInfo { required int32 subType = 1; //Qot_Common.SubType, 登録タイプ repeated Qot_Common.Security securityList = 2; //このタイプの相場情報を登録した証券 } ``` ## 単一接続の登録情報 **ConnSubInfo** ```protobuf message ConnSubInfo { repeated SubInfo subInfoList = 1; //この接続の登録情報 required int32 usedQuota = 2; //この接続で使用済みの登録枠 required bool isOwnConnData = 3; //自分の接続のデータかどうかの判別用 optional int32 securityFirm = 4; //証券会社識別子、Trd_Common.SecurityFirm を参照 } ``` ## セクター情報 **PlateInfo** ```protobuf message PlateInfo { required Qot_Common.Security plate = 1; //セクター required string name = 2; //セクター名 optional int32 plateType = 3; //PlateSetType セクタータイプ。3207（株式所属セクター取得）プロトコルのみこのフィールドを返す } ``` ## 復権情報 **Rehab** ```protobuf message Rehab { required string time = 1; //時刻文字列（形式：yyyy-MM-dd） required int64 companyActFlag = 2; //コーポレートアクション(CompanyAct)複合フラグ。特定フィールド値の有効性を示す required double fwdFactorA = 3; //前復権係数 A required double fwdFactorB = 4; //前復権係数 B required double bwdFactorA = 5; //後復権係数 A required double bwdFactorB = 6; //後復権係数 B optional int32 splitBase = 7; //株式分割（例: 1株を5株に分割、Base は1、Ert は5） optional int32 splitErt = 8; optional int32 joinBase = 9; //株式併合（例: 50株を1株に併合、Base は50、Ert は1） optional int32 joinErt = 10; optional int32 bonusBase = 11; //無償交付（例: 10株につき3株交付、Base は10、Ert は3） optional int32 bonusErt = 12; optional int32 transferBase = 13; //株式無償割当（例: 10株につき3株転換、Base は10、Ert は3） optional int32 transferErt = 14; optional int32 allotBase = 15; //株主割当（例: 10株につき2株割当、割当価格6.3元、Base は10、Ert は2、Price は6.3） optional int32 allotErt = 16; optional double allotPrice = 17; optional int32 addBase = 18; //増資（例: 10株につき2株増発、増発価格6.3元、Base は10、Ert は2、Price は6.3） optional int32 addErt = 19; optional double addPrice = 20; optional double dividend = 21; //現金配当（例: 10株あたり0.5元配当の場合、このフィールド値は0.05） optional double spDividend = 22; //特別配当（例: 10株あたり特別配当0.5元の場合、このフィールド値は0.05） optional double timestamp = 23; //タイムスタンプ } ``` > - コーポレートアクション複合フラグは [CompanyAct](./quote.html#7550) を参照 ## コンボレッグ情報 **ComboLeg** ```protobuf message ComboLeg { required Qot_Common.Security security = 1; //株式/オプション optional int32 side = 2; //方向。Trd_Common.TrdSide を参照 optional double qtyRatio = 3; //数量比率 optional uint64 positionID = 4; //ポジションID。moomoo JP のクローズ時のみ入力。showOptionStrategyView=True のオプション戦略ビューポジションの positionID であること。 } ``` ## 受渡周期 >**ExpirationCycle** * `NONE` 不明 * `WEEK` ウィークリーオプション * `MONTH` マンスリーオプション * `END_OF_MONTH` 月末オプション * `QUARTERLY` クォータリーオプション * `WEEKMON` ウィークリーオプション-月曜 * `WEEKTUE` ウィークリーオプション-火曜 * `WEEKWED` ウィークリーオプション-水曜 * `WEEKTHU` ウィークリーオプション-木曜 * `WEEKFRI` ウィークリーオプション-金曜 ## オプション標準タイプ >**OptionStandardType** * `NONE` 不明 * `STANDARD` 標準オプション * `NON_STANDARD` 非標準オプション ## オプション決済方式 >**OptionSettlementMode** * `NONE` 不明 * `AM` アジアンオプション * `PM` パス依存型 ## 株式保有者（廃止済み） > **StockHolder** * `NONE` 不明 * `INSTITUTE` 機関 * `FUND` ファンド * `EXECUTIVE` 役員 ## スクリーニング V2 - SimpleField > [get_stock_screen](./get-stock-screen.md) の `add_simple_field(field, values)` メソッドで使用。すべての数値フィールドは原始値を直接渡し、OpenD が自動的に倍率変換を行います。 field|意味|values の取り得る値 :-|:-|:- 1|MARKET 市場|ScrMarket：HK=1、US=2、CN=3、SG=4、CA=5、AU=6、JA=7、MY=8 2|EXCHANGE 取引所/上場地|[QotMarket](#427) を参照 3|INDEX_ID 指数 ID|指数構成銘柄 ID 4|USE_WATCHLIST お気に入り銘柄を使用|0=いいえ、1=はい 5|HAS_ADR 関連 ADR の有無|0/1 6|HAS_OPTION オプションの有無|0/1 7|HAS_WARRANT ワラントの有無|0/1 8|HAS_FUTURE 先物の有無|0/1 9|HAS_AH_STOCK AH 株の有無|0/1 10|IS_ISLAMIC イスラム株|0/1 11|NORTH_BOUND_ID 北向プレート|滬/深ストックコネクト ID 12|MM_EXCLUSIVE_ID Moomoo 独占プレート|プレート ID > 完全な列挙は SDK の `stock_screen_const.py` の `SimpleField` / `ScrMarket` クラスを参照。 ## スクリーニング V2 - SimpleProperty > `add_simple_property(name, lower, upper)` と `add_retrieve_simple(name)` で使用。よく使う指標は以下のとおり、すべての数値は原始値を渡します。 name|意味 :-|:- 2101|LONG_MARGIN_ALLOWED 信用買い可否 (0/1) 2103|SHORT_MARGIN_ALLOWED 信用売り可否 (0/1) 2201|PRICE 最新値 2202|OPEN_PRICE 始値 2203|LAST_CLOSE 前日終値 2204|HIGH 高値 2205|LOW 安値 2217|VOLUME_RATIO 出来高比率 2218|BID_ASK_RATIO 売買比率 2301|MARKET_CAP 時価総額 2302|PE_ANNUAL 静的 PER 2303|PE_TTM TTM PER 2304|PB PBR 2305|DIVIDEND_RATIO 配当利回り 2306|LISTED_DATE 上場日（タイムスタンプ） 2307|LISTED_DAYS 上場日数 > 完全な列挙は `SimpleProperty` クラスを参照（信用取引、プレ/アフター、夜間、高精度クォートなど計 60+ 項目を含む）。 ## スクリーニング V2 - CumulativeProperty > `add_cumulative_property(name, days, lower, upper)` と `add_retrieve_cumulative(name, days)` で使用。`days` パラメータと組み合わせる必要があります。 name|意味 :-|:- 3101|PRICE_CHANGE 価格変化額 3102|PRICE_CHANGE_PCT 価格変化率 (%) 3103|AMPLITUDE 価格振幅 (%) 3104|AVG_VOLUME 平均出来高 3105|AVG_TURNOVER 平均売買代金 3106|TURNOVER_RATIO 売買回転率 (%) 3107|HIGH_TO_N_DAY_HIGH (高値-N日最高値)/N日最高値 3108|LOW_TO_N_DAY_LOW (安値-N日最安値)/N日最安値 3109|PRICE_CHANGE_HP 高精度変化額 ## スクリーニング V2 - FinancialProperty > `add_financial_property(name, term, year, lower, upper)` と `add_retrieve_financial(name, term, year)` で使用。`term`（決算期）と組み合わせる必要があります。 * **よく使う指標（完全な列挙は `FinancialProperty` クラスを参照、収益性 / 返済能力 / 運営 / 成長性 / キャッシュフロー / 財務サプライズなど計 100+ 項目を含む）** name|意味 :-|:- 4101|NET_PROFIT 純利益 4102|NET_PROFIT_GROWTH 純利益成長率 4105|REVENUE 売上高 4106|REVENUE_GROWTH 売上高成長率 4107|NET_PROFIT_RATIO 純利益率 4108|GROSS_PROFIT_RATIO 売上総利益率 4109|DEBT_TO_ASSETS 負債比率 4110|ROE 自己資本利益率 4202|ROIC 投下資本利益率 4801|BASIC_EPS 基本 1 株あたり利益 4901|TOTAL_SHARE 発行済株式総数 4903|FLOAT_MARKET_CAP 流通時価総額 4904|PS_TTM PSR TTM 4905|PCF_TTM PCFR TTM * **Term 決算期**（`Term` 列挙） term|意味 :-|:- 1 / 2 / 3 / 4|Q1 / Q2 / Q3 / Q4 単四半期決算 6|Q6 中間決算（累積） 9|Q9 第 3 四半期決算（累積） 10|LATEST 最新単四半期 100|ANNUAL 年次決算 FY 200~204|SURPRISE_LATEST シリーズ（決算予想） ## スクリーニング V2 - Indicator / Pattern / Period / Position > `add_indicator_positional` / `add_indicator_pattern` / `add_retrieve_indicator` で使用。 * **`Indicator` テクニカル指標**（`add_indicator_positional` の `first_indicator_name` / `second_indicator`） name|意味 :-|:- 1|PRICE 最新値 11~17|MA5 / MA10 / MA20 / MA30 / MA60 / MA120 / MA250 18|MA 動的単純移動平均（indicator_params の設定が必要） 21~27|EMA5 / EMA10 / EMA20 / EMA30 / EMA60 / EMA120 / EMA250 28|EMA 動的指数移動平均 31~33|KDJ_K / KDJ_D / KDJ_J（KDJ(9,3,3)） 41~43|MACD_DIF / MACD_DEA / MACD_MACD（MACD(12,26,9)） 51|RSI_12 52|RSI 動的 61~63|BOLL_UPPER / BOLL_MIDDLE / BOLL_LOWER（BOLL(20,2)） 71|RVOL 動的相対出来高 * **`Pattern` パターン**（`add_indicator_pattern` の `name`） name|意味 :-|:- 1 / 2|MA 強気 / 弱気配列 3 / 4|EMA 強気 / 弱気配列 11 / 12|KDJ 低位ゴールデンクロス / 高位デッドクロス 13 / 14|KDJ トップダイバージェンス / ボトムダイバージェンス 21 / 22|MACD 低位ゴールデンクロス / 高位デッドクロス 23 / 24|MACD トップダイバージェンス / ボトムダイバージェンス 31 / 32|RSI 低位ゴールデンクロス / 高位デッドクロス 33 / 34|RSI トップダイバージェンス / ボトムダイバージェンス * **`Period` 周期** period|意味 :-|:- 1 / 2 / 3 / 4|1 / 3 / 5 / 15 分 5|HOUR_1 1 時間 6|MINUTE_30 30 分 11 / 21 / 31|DAY 日 / WEEK 週 / MONTH 月 * **`Position` 位置関係** position|意味 :-|:- 1|OVER first が second の上方 2|BELOW first が second の下方 3|CROSS_UP first が second を上抜け 4|CROSS_DOWN first が second を下抜け * **`ScrSortDir` ソート方向**（`set_sort` / `add_sort` の `direction`） direction|意味 :-|:- 1|ASC 昇順 2|DESC 降順 3|ABS_ASC 絶対値昇順 4|ABS_DESC 絶対値降順 ## スクリーニング V2 - BasicProperty / 取得フィールド > `add_retrieve_basic(name)` などの取得メソッドで使用。`add_retrieve_simple` / `add_retrieve_cumulative` / `add_retrieve_financial` など、その他の取得フィールドは上述の SimpleProperty / CumulativeProperty / FinancialProperty などの ID を共用します。 * **`BasicProperty` 基本属性** name|意味|備考 :-|:-|:- 1101|CODE 銘柄コード|sval 1102|NAME 銘柄名称|sval 1103|INDUSTRY 所属業種|sval > 単一の戻り値結果は `value_type` フィールドに応じて `sval(1)` / `ival(2)` / `aval(3)` / `dval(4)` に振り分けられます。`enum_name` は ival が列挙コードのとき SDK によりデコードされます（例：K 線パターンは `'DOUBLE_BOTTOMS'` を返す）。 ## オプションスクリーニング - OptUnderlyingIndicator > [get_option_screen](./get-option-screen.md) の `add_underlying_filter(indicator_type, ...)` と `add_underlying_retrieve(indicator_type)` で使用。 indicator_type|意味|備考 :-|:-|:- 101|STOCK_LIST 原資産範囲を指定|values に証券コード文字列のリストをそのまま渡す（例：["US.AAPL", "HK.00700"]） 103|PLATE プレートを指定|**バックエンド未対応、渡すとエラー** 106|INDEX_LIST 指数タイプを指定| 201|VOLUME 総出来高| 202|OPEN_INTEREST 総建玉| 203|IV 原資産インプライド・ボラティリティ| 204|HV 原資産ヒストリカル・ボラティリティ| 205|IV_RANK| 206|IV_PERCENTILE| 207 / 208|IV_CHANGE / IV_CHANGE_RATIO| 209 / 210|IV_HV_RATIO / IV_HV_SPREAD| 401|MARKET_CAP 原資産時価総額| 402|STOCK_PRICE 原資産最新値| 403|CHANGE_RATIO 変化率| ## オプションスクリーニング - OptIndicator > `add_option_filter(indicator_type, ...)` と `add_option_retrieve(indicator_type)` で使用。 indicator_type|意味|備考 :-|:-|:- 1001|STRIKE_PRICE 権利行使価格| 1002|LEFT_DAY 満期までの日数| 1003|OPTION_TYPE オプションタイプ|1=CALL、2=PUT 1004|EXERCISE_TYPE 権利行使方式|1=アメリカン、2=ヨーロピアン 1005|EXPIRATION_TYPE 満期タイプ|1=週、2=月、3=四半期 1007|STRIKE_DATE_TIMESTAMP 満期日タイムスタンプ（秒）| 2001|IN_THE_MONEY|0=アウト・オブ・ザ・マネー、1=イン・ザ・マネー 2002~2005|PRICE / MID_PRICE / BID_PRICE / ASK_PRICE| 2006~2009|BID_ASK_SPREAD / BID_VOLUME / ASK_VOLUME / BID_ASK_VOLUME_RATIO| 2010|CHANGE_RATIO 変化率| 2011 / 2012|VOLUME / TURNOVER| 2013 / 2014|OPEN_INTEREST / OPEN_INTEREST_MARKET_CAP| 2018|VOL_OI_RATIO| 2021|PREMIUM プレミアム|**sort/retrieve のみ、filter は非対応** 3001 / 3002 / 3003|IMPLIED_VOLATILITY / HISTORY_VOLATILITY / IV_HV_RATIO| 3004~3008|DELTA / GAMMA / VEGA / THETA / RHO| 3009 / 3010|LEVERAGE_RATIO / EFFECTIVE_GEARING| 3011 / 3012|BUY_TO_BEP / SELL_TO_BEP| 3013 / 3014|BUY_PROFIT_PROBABILITY / SELL_PROFIT_PROBABILITY| 3015~3018|INTRINSIC_VALUE_PER / TIME_VALUE_PER / ITM_DEGREE / OTM_DEGREE| 3019 / 3020|ITM_PROBABILITY / OTM_PROBABILITY| ## ワラントスクリーニング V2 - WarrantField > [get_warrant_screen](./get-warrant-screen.md) の `add_interval_filter(field_id, ...)` / `add_choice_filter(field_id, choices)` / `add_sort(field_id, desc)` で使用。すべての数値フィールドは原始値を直接渡します。 field_id|意味|フィルタ方式 :-|:-|:- 1|CODE 証券コード|choice（テキスト） 2|NAME 銘柄名称|choice（テキスト） 4|ISSUER_ID 発行体 ID|choice 5|STOCK_OWNER 原株 ID|choice（"HK.00700" を渡せる） 6|WARRANT_TYPE ワラントタイプ|choice：1=コール、2=プット、3=ブル証、4=ベア証、5=インライン証 7|CONVERSION_RATIO 転換比率|interval 8|CURRENT_PRICE 現在値|interval 9|STREET_RATIO ストリート比率|interval 10|VOLUME 出来高|interval 11|MATURITY_DATE 満期日（タイムスタンプ秒）|interval 12|STRIKE_PRICE 権利行使価格|interval 13|PREMIUM プレミアム|interval（負値可） 14|RECOVERY_PRICE コールバック価格|interval 15|IMPLIED_VOLATILITY インプライド・ボラティリティ|interval 16|LEVERAGE_RATIO レバレッジ比率|interval 17|PRICE_RECOVERY_RATIO 原株からコールバック価格までの距離 %|interval 18|DELTA ヘッジ値|interval 19|STATUS ワラントステータス|choice：0=正常、1=終了、2=上場待ち 20|IPO_TIME 上場日時（タイムスタンプ秒）|interval 21 / 22|BUY_VOL / SELL_VOL 買い/売り数量|interval 23|EFFECTIVE_LEVERAGE 実効レバレッジ|interval 24|LAST_CLOSE_PRICE 前日終値|interval 25|TURNOVER 売買代金|interval 26 / 27|SELL_PRICE / BUY_PRICE|interval 28 / 29|HIGH_PRICE / LOW_PRICE|interval 30|RATIO_ITM_OTM イン・ザ・マネー/アウト・オブ・ザ・マネー|interval（負値可） 31|BREAK_EVEN_POINT 損益分岐点|interval 32|AMPLITUDE 振幅|interval 33|SCORE_FAXING ソシエテ・ジェネラルスコア|interval 34|LAST_TRADE_DATE 最終取引日（タイムスタンプ秒）|interval 35|STREET_VOLUME ストリート出来高|interval 36|LOT_SIZE 単元株数|interval 37|ISSUE_SIZE 発行量|interval 38|IPO_PRICE 発行価格|interval 39 / 40|LOWER_STRIKE_PRICE / UPPER_STRIKE_PRICE|interval（インライン証） 41|IW_PRICE_STATUS インライン/アウトオブライン|choice 42|SENSITIVITY 感応度|interval 43|CONVERSION_PRICE 転換価格|interval 44 / 45|CHANGE_RATE / CHANGE_VALUE 変化率/額|interval 51|SCORE 総合スコア|interval 52|FILTER_NO_TRADE 出来高なしワラントを除外|choice：0=いいえ、1=はい 53|CURRENCY_CODE 通貨|choice 54|STOCK_OWNER_PRICE 原株価格|interval ## ワラントスクリーニング V2 - WarrantMarket / WarrantType / WarrantStatus > `WarrantScreenRequest(warrant_market=...)` と `add_choice_filter` でよく使う列挙。 * **`WarrantMarket` 市場** market|意味 :-|:- 1|HK 香港株 4|SG シンガポール 15|MY マレーシア * **`WarrantType` ワラントタイプ**（field_id=6 の choice の取り得る値） value|意味 :-|:- 1|CALL コール 2|PUT プット 3|BULL ブル証 4|BEAR ベア証 5|INLINE インライン証 * **`WarrantStatus` ワラントステータス**（field_id=19 の choice の取り得る値） value|意味 :-|:- 0|NORMAL 正常 1|SUSPEND 取引終了 2|PRE_IPO 上場待ち ## 期權市場類型 > **OptionMarket** * `UNKNOWN` 未知 * `US_SECURITY` 美股股票期權 * `US_INDEX` 美股指數期權 * `HK_SECURITY` 港股股票期權 * `HK_INDEX` 港股指數期權 ## 期權統計數據類型 > **OptionStatisticDataType** * `UNKNOWN` 未知 * `VOLUME` 成交量 * `OPEN_INTEREST` 持倉量 ## 歷史波動率時間範圍 > **OptionHVTimeRange** * `UNKNOWN` 未知 * `THIRTY_DAY` 30 日 * `SIXTY_DAY` 60 日 * `NINETY_DAY` 90 日 * `ONE_TWENTY_DAY` 120 日 * `THREE_SIXTY_FIVE_DAY` 365 日 ## 期權合約排行類型 > **OptionRankType** * `UNKNOWN` 未知 * `VOLUME` 成交量排行 * `TURNOVER` 成交額排行 * `OI` 持倉量排行 * `OI_INCREMENT` 增倉量(日)排行 * `OI_DECREMENT` 減倉量(日)排行 * `OI_MARKET_CAP` 持倉額排行 * `OI_MARKET_CAP_INCREMENT` 增倉額(日)排行 * `OI_MARKET_CAP_DECREMENT` 減倉額(日)排行 * `CHANGE_RATE` 漲跌幅排行 * `IV` 隱含波動率排行 ## 末日期權標的排序 > **ZeroDteSortType** * `UNKNOWN` 未知 * `VOLUME` 期權成交量 * `IV` 隱含波動率 * `CHANGE_RATE` 漲跌幅 * `OPEN_INTEREST` 持倉量 * `MARKET_CAP` 市值 ## 末日期權標的篩選因子 > **ZeroDteIndicatorType** * `UNKNOWN` 未知 * `OWNER_LIST` 自選股列表 * `HAS_EARNINGS_THIS_WEEK` 本週是否有財報(0=不限,1=有,2=無) * `VOLUME` 期權總成交量 * `OPEN_INTEREST` 期權總持倉量 * `IV` 隱含波動率(%) * `HV` 歷史波動率(%) * `IV_RANK` IV 等級(%) * `IV_PERCENTILE` IV 百分位數(%) * `PRICE` 最新價 * `CHANGE_RATE` 漲跌幅(%) ## 末日期權合約排序 > **ZeroDteContractSortType** * `UNKNOWN` 未知 * `VOLUME` 成交量 * `OPEN_INTEREST` 持倉量 * `IV` 隱含波動率 * `DELTA` Delta ## 末日期權合約篩選因子 > **ZeroDteContractIndicatorType** * `UNKNOWN` 未知 * `OPTION_TYPE` 期權方向(1=Call, 2=Put) * `VOLUME` 成交量 * `OPEN_INTEREST` 未平倉數 * `IV` 隱含波動率(%) * `DELTA` Delta * `GAMMA` Gamma * `THETA` Theta * `VEGA` Vega * `RHO` Rho * `PRICE` 最新價 * `CHANGE_RATE` 漲跌幅(%) * `BREAK_EVEN_POINT` 盈虧平衡點 * `TO_BEP` 到盈虧平衡點(%) * `BUY_PROFIT_PROBABILITY` 買入盈利概率(%) * `SELL_PROFIT_PROBABILITY` 賣出盈利概率(%) ## 財報排序 > **EarningsSortType** * `UNKNOWN` 未知 * `EARNINGS_DATE` 財報日期(默認) * `VOLUME` 期權成交量 * `IV` 隱含波動率 * `MARKET_CAP` 市值 * `CHANGE_RATIO` 漲跌幅 * `PRICE` 最新價 * `IV_RANK` IV 等級 * `IV_PERCENTILE` IV 百分位數 * `HV` 歷史波動率 * `OPEN_INTEREST` 持倉量 * `LAST_REPORT_IV_CRUSH` 上次 IV Crush * `HISTORY_REPORT_IV_CRUSH` 歷史 IV Crush * `LAST_REPORT_CHG_RATIO` 上次財報日漲跌幅 * `HISTORY_REPORT_CHG_RATIO` 歷史財報日漲跌幅 * `ESTIMATE_EPS_YOY` 預測 EPS 同比 * `ESTIMATE_REVENUE_YOY` 預測營收同比 * `EXPECTED_MOVE_RATIO` 預測波動 ## 標的品類 > **StockCategory** * `ALL` 全部 * `EQUITY` 股票 * `ETF` ETF ## 財報發布類型 > **EarningsPubType** * `UNKNOWN` 未知 * `BEFORE` 盤前 * `AFTER` 盤後 ## 財報機會篩選因子 > **EarningsIndicatorType** * `UNKNOWN` 未知 * `OWNER_LIST` 自選股列表 * `INDEX_COMPONENT` 所屬指數 * `PLATE` 所屬行業/板塊 * `MARKET_CAP` 市值 * `EXPIRATION_TYPE` 到期類型 * `IV` 隱含波動率(%) * `LAST_REPORT_IV_CRUSH` 上次 IV Crush(%) * `HISTORY_REPORT_IV_CRUSH` 歷史 IV Crush(%) * `IV_RANK` IV 等級(%) * `IV_PERCENTILE` IV 百分位數(%) * `VOLUME` 期權成交量 * `OPEN_INTEREST` 期權持倉量 * `PRICE` 最新價 * `CHANGE_RATIO` 漲跌幅(%) * `EXPECTED_MOVE_RATIO` 預測波動(%) * `LAST_REPORT_CHG_RATIO` 上次財報日漲跌幅(%) * `HISTORY_REPORT_CHG_RATIO` 歷史財報日漲跌幅(%) * `ESTIMATE_REVENUE_YOY` 預測營收同比(%) * `ESTIMATE_EPS_YOY` 預測 EPS 同比(%) * `EARNINGS_DAY_RANGE` 距財報日天數 ## 賣方策略類型 > **SellerType** * `UNKNOWN` 未知 * `COVERED_CALL` 股票擔保看漲期權 (Covered Call) * `CASH_SECURED_PUT` 現金擔保看跌期權 (Cash Secured Put) ## 賣方專區排序 > **SellerSortType** * `UNKNOWN` 未知 * `ANNUALIZED_RETURN` 年化收益率(默認) * `INTERVAL_RETURN` 區間收益率 * `ITM_PROBABILITY` 行權概率 * `PREMIUM` 權利金 ## 賣方專區篩選因子 > **SellerIndicatorType** * `UNKNOWN` 未知 * `OWNER_LIST` 自選股列表 * `STOCK_CATEGORY` 標的品類 * `VOLUME` 期權總成交量 * `OPEN_INTEREST` 期權總持倉量 * `IV` 標的 IV(%) * `HV` 標的 HV(%) * `IV_RANK` IV 等級(%) * `IV_PERCENTILE` IV 百分位數(%) * `MARKET_CAP` 標的市值 * `PRICE` 標的最新價 * `CHANGE_RATE` 標的漲跌幅(%) * `PLATE` 板塊 * `EXPIRATION_TYPE` 到期類型 * `LEFT_DAYS` 距到期日(天) * `OPTION_TYPE` 期權方向(1=Call, 2=Put) * `OPTION_EXPIRATION_TYPE` 期權到期類型 * `STRIKE_DATE_TIMESTAMP` 到期日時間戳(秒) * `PREMIUM` 權利金 * `ANNUALIZED_RETURN` 年化收益率(%) * `INTERVAL_RETURN` 區間收益率(%) * `OTM_DEGREE` 價外程度(%) * `OTM_PROBABILITY` 價外概率(%) * `OPTION_IV` 期權隱含波動率(%) * `BID_PRICE` 期權買價 * `ASK_PRICE` 期權賣價 * `OPTION_VOLUME` 期權成交量 * `OPTION_OPEN_INTEREST` 期權持倉量 ## 標的排行排序 > **UnderlyingRankSortType** * `UNKNOWN` 未知 * `VOLUME` 總成交量 * `VOLUME_RATIO` Put/Call 成交量比值 * `OPEN_INTEREST` 總持倉量 * `OPEN_INTEREST_RATIO` Put/Call 持倉量比值 * `PRICE` 最新價 * `PRICE_CHANGE` 漲跌幅 * `IV` IV * `IV_CHANGE` IV 變化率 * `HV` HV * `HV_CHANGE` HV 變化率 * `IV_RANK` IV Rank * `IV_PERCENTILE` IV Percentile * `MARKET_CAP` 市值 ## 標的排行篩選因子 > **UnderlyingRankIndicatorType** * `UNKNOWN` 未知 * `OWNER_LIST` 指定標的列表 * `STOCK_CATEGORY` 標的品類 * `VOLUME` 總成交量 * `OPEN_INTEREST` 總持倉量 * `IV` IV(%) * `HV` HV(%) * `IV_RANK` IV Rank(%) * `IV_PERCENTILE` IV Percentile(%) * `IV_CHANGE` IV 變化率(%) * `HV_CHANGE` HV 變化率(%) * `VOLUME_RATIO` 成交量 P/C 比值(%) * `OI_RATIO` 持倉量 P/C 比值(%) * `MARKET_CAP` 市值 * `PRICE` 最新價 * `CHANGE_RATE` 漲跌幅(%) ## 期權合約排行篩選因子 > **OptionRankIndicatorType** * `UNKNOWN` 未知 * `STOCK_CATEGORY` 品類 * `MARKET_CAP` 市值 * `OWNER_LIST` 股票範圍 * `UNDERLYING_IV` 正股 IV(%) * `UNDERLYING_HV` 正股 HV(%) * `IV_RANK` IV 等級(%) * `IV_PERCENTILE` IV 百分位數(%) * `IV` 隱含波動率(%) * `OPTION_TYPE` 方向(Call/Put) * `LEFT_DAYS` 距到期日 * `IN_THE_MONEY` 價內/價外(0=價外, 1=價內) * `VOLUME` 成交量 * `OPEN_INTEREST` 持倉量 * `DELTA` Delta * `GAMMA` Gamma * `THETA` Theta * `VEGA` Vega * `RHO` Rho ## 到期類型 > **ExpirationType** * `UNKNOWN` 未知 * `MONTHLY` 月期權 * `WEEKLY` 週期權 * `END_OF_MONTH` 月末期權 * `QUARTERLY` 季度期權 ## 指數成分類型 > **IndexComponentType** * `UNKNOWN` 未知 * `DJI` 道瓊斯指數 * `IXIC` 納斯達克指數 * `NDX` 納斯達克 100 指數 * `SPX` 標普 500 指數 ## 期權異動成交方向 > **EventTickerType** * `UNKNOWN` 未知 * `BUY` 主動買入 * `SELL` 主動賣出 * `NEUTRAL` 中性盤 ## 期權異動訂單類型 > **AlertOrderType** * `NORMAL` 普通訂單 * `SWEEP` 掃單 * `CROSS` 對敲單 * `FLOOR` 場內單 ## 策略類型 > **TickerStrategy** * `UNKNOWN` 未知 * `SINGLE_LEG` 單腿交易 * `MULTI_LEG` 多腿策略交易 ## 市場情緒 > **MarketSentiment** * `UNKNOWN` 未知 * `BEARISH` 看空 * `BULLISH` 看多 * `NEUTRAL` 中性 ## 公司行動類型 > **CorporateActionType** * `NONE` 無/未知 * `SPLIT` 拆股 * `JOIN` 合股 * `BONUS_STOCK` 送股 * `INTO_SHARES` 轉增股 * `ALLOT` 配股 * `ADD` 增發股 * `DIVIDEND` 普通派息 * `SPECIAL_DIVIDEND` 特別派息 * `SPIN_OFF` 公司分立 ## 價內價外類型 > **InTheMoneyType** * `UNKNOWN` 未知 * `IN` 價內 (ITM) * `OUT` 價外 (OTM) ## 異動篩選因子類型 > **EventIndicatorType** * `OWNER_LIST` 指定標的列表（security_list） * `INDUSTRY_PLATE` 行業板塊列表（security_list） * `CONCEPT_PLATE` 概念板塊列表（security_list） * `CORPORATE_ACTION` 公司行動類型（value_list, CorporateActionType） * `MARKET_CAP` 標的市值（範圍） * `OPTION_TYPE` CALL(1)/PUT(2)（value_list） * `MONEY_TYPE` 價內(1)/價外(2)（value_list） * `STRIKE_PRICE` 行權價（範圍） * `EXPIRY_DAYS` 距到期天數（範圍） * `OTM` 價外比率(%)（範圍） * `TICKER_TYPE` 成交方向（value_list, EventTickerType） * `VOLUME` 成交量（範圍） * `TURNOVER` 成交額（範圍） * `PRICE` 成交價（範圍） * `TIME` 異動時間（範圍，Unix 秒） * `MAX_DAY_NUM` 時間範圍天數（value_list，0=當天, 1=近2天 ...） * `ORDER_TYPE` 訂單類型（value_list, AlertOrderType） * `STRATEGY` 策略類型（value_list, TickerStrategy） * `SENTIMENT` 市場情緒（value_list, MarketSentiment） * `TOTAL_VOLUME` 期權總成交量（範圍） * `TOTAL_OI` 期權總持倉量（範圍） * `VO_RATIO` 量倉比(%)（範圍） * `IV` 隱含波動率(%)（範圍） * `DELTA` Delta（範圍） * `GAMMA` Gamma（範圍） * `VEGA` Vega（範圍） * `THETA` Theta（範圍） * `RHO` Rho（範圍） ## 告警操作類型 > **AlertOpType** * `UNKNOWN` 未知 * `ADD` 新增 * `DELETE` 刪除 * `MODIFY` 修改 * `ENABLE` 啟用 * `DISABLE` 禁用 * `DELETE_ALL` 刪除全部 --- # 取引API一覧
モジュール API名 機能概要
口座 Get Account List 取引口座リストの取得
Unlock Trading 取引ロック解除
資産・ポジション Get Account Financial Information 口座資金データの取得
Get Maximum Tradable Quantity 口座の最大買い/売り可能数量の照会
comboorder_tradinginfo_query コンボ取引可能情報の照会
Get Positions List ポジションリストの取得
Get Margin Trading Data 信用取引データの取得
Get Cash Flow Summary 照会口座現金フロー (最低バージョン要件：9.1.5108)
注文 Place Order 発注
place_combo_order コンボ注文
Modify or Cancel Order 注文変更・注文取消
Get Order list 未完了注文の照会
Get Order Fees 照会注文费用 (最低バージョン要件：8.2.4218)
Get Historical Order List 過去注文の照会
Order Callback 注文コールバック
Trade Data Callback 取引プッシュの登録
約定 Get Today's Executed Trades 当日約定の照会
Get Historical Executed Trades 過去約定の照会
Trade Execution Callback 約定コールバック
--- # 取引オブジェクト ## 接続の作成 `OpenSecTradeContext(filter_trdmarket=TrdMarket.HK, host='127.0.0.1', port=11111, is_encrypt=None, security_firm=SecurityFirm.NONE)` `OpenFutureTradeContext(host='127.0.0.1', port=11111, is_encrypt=None, security_firm=SecurityFirm.NONE)` `OpenCryptoTradeContext(host='127.0.0.1', port=11111, is_encrypt=None, security_firm=SecurityFirm.NONE)` * **概要** 取引カテゴリに応じて口座を選択し、対応する取引オブジェクトを作成します。 実例|口座 :-|:- OpenSecTradeContext|証券口座 (株式、ETFs、ワラント、CBBC、株式および指数のオプションはこの口座を使用します) OpenFutureTradeContext|先物口座 (先物、先物オプションはこの口座を使用します) OpenCryptoTradeContext|暗号資産口座 (- 暗号資産現物取引はこの口座を使用します - FUTUSECURITIES、FUTUINC、FUTUSG の3社のみサポート - 模擬取引は非対応) * **パラメータ** パラメータ|型|説明 :-|:-|:- filter_trdmarket|[TrdMarket](./trade.html#4416)|対応する取引市場権限の口座をフィルタ (- このパラメータは OpenSecTradeContext にのみ適用されます - このパラメータは口座のフィルタにのみ使用され、取引接続には影響しません) host|str|OpenD がリスニングしている IP アドレス port|int|OpenD がリッスンする IP ポート is_encrypt|bool|暗号化を有効にするかどうか (デフォルト None は [enable_proto_encrypt](../ftapi/init.md#1561) の設定を使用することを意味します) security_firm|[SecurityFirm](./trade.md#6462)|所属証券会社 (OpenCryptoTradeContext は FUTUSECURITIES、FUTUINC、FUTUSG のみサポート) * **Example** ```python from moomoo import * trd_ctx = OpenSecTradeContext(filter_trdmarket=TrdMarket.US, host='127.0.0.1', port=11111, is_encrypt=None, security_firm=SecurityFirm.NONE) trd_ctx.close() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。 ``` ```python from moomoo import * future_ctx = OpenFutureTradeContext(host='127.0.0.1', port=11111, security_firm=SecurityFirm.NONE) future_ctx.close() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。 ``` ```python from moomoo import * crypto_ctx = OpenCryptoTradeContext(host='127.0.0.1', port=11111, security_firm=SecurityFirm.NONE) crypto_ctx.close() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。 ``` ## 接続のクローズ `close()` * **概要** 取引オブジェクトを閉じます。デフォルトでは、moomoo API が内部で作成したスレッドがプロセスの終了をブロックするため、すべての Context を close した後にのみプロセスが正常終了できます。ただし、[set_all_thread_daemon](../ftapi/init.md#4694) ですべての内部スレッドを daemon スレッドに設定すると、Context の close を呼び出さなくてもプロセスを正常終了できます。 * **Example** ```python from moomoo import * trd_ctx = OpenSecTradeContext(filter_trdmarket=TrdMarket.US, host='127.0.0.1', port=11111, is_encrypt=None, security_firm=SecurityFirm.NONE) trd_ctx.close() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。 ``` --- # 取引口座リストの取得 `get_acc_list()` * **概要** 取得取引口座リスト。 他の取引APIを呼び出す前に、まずこのリストを取得し、操作対象の取引口座が正しいことを確認してください。 * **パラメータ** * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame 当 ret == RET_OK 时，返す取引口座リスト
str 当 ret != RET_OK 时，返すエラー説明
* 取引口座リストフォーマットは以下の通り： フィールド|タイプ|説明 :-|:-|:- acc_id|int|取引口座 trd_env|[TrdEnv](./trade.md#293)|取引環境 acc_type|[TrdAccType](./trade.md#8134)|口座タイプ uni_card_num|str|総合口座カード番号。モバイルアプリでの表示と同一 card_num|str|業務口座カード番号 (総合口座には1つまたは複数の業務口座（総合証券口座、総合先物口座など）が含まれ、取引商品に関連します) security_firm|[SecurityFirm](./trade.md#6462)|所属証券会社 sim_acc_type|[SimAccType](./trade.md#8134)|デモ口座タイプ (のみデモ口座適用) trdmarket_auth|list|取引市場権限 (list 中元素タイプ是 [TrdMarket](./trade.html#4416)) acc_status|[TrdAccStatus](./trade.md#8392)|口座ステータス acc_role|[TrdAccRole](./trade.md#8134)|口座タイプ (メイン口座とサブ口座を区別するために使用 - MASTER: メイン口座 - NORMAL: 通常口座) jp_acc_type|list|日本口座タイプ (list 中元素タイプ是[SubAccType](./trade.md#6462)，のみ対日本証券会社生效) * **説明** 香港株式の模擬取引口座を取得するには、filter_trdmarketをTrdMarket.HKに指定する必要があります。この場合、2つの模擬取引口座が返されます。sim_acc_type = STOCKは香港株式模擬口座、sim_acc_type = OPTIONは香港オプション模擬口座、sim_acc_type = FUTURESは香港先物模擬口座です。 米国株式の模擬取引口座を取得するには、filter_trdmarketをTrdMarket.USに指定する必要があります。sim_acc_type = STOCK_AND_OPTIONは米国株式信用取引模擬口座を表し、株式とオプションの模擬取引が可能です。sim_acc_type = FUTURESは米国先物模擬口座です。 * **Example** ```python from moomoo import * trd_ctx = OpenSecTradeContext(filter_trdmarket=TrdMarket.US, host='127.0.0.1', port=11111, security_firm=SecurityFirm.FUTUINC) ret, data = trd_ctx.get_acc_list() if ret == RET_OK: print(data) print(data['acc_id'][0]) # 最初のアカウントを取得 print(data['acc_id'].values.tolist()) # list に変換 else: print('get_acc_list error: ', data) trd_ctx.close() ``` * **Output** ```python acc_id trd_env acc_type uni_card_num card_num security_firm sim_acc_type trdmarket_auth acc_status acc_role jp_acc_type 0 281756420273981734 REAL MARGIN 10018561211263256 1001100530724347 FUTUINC N/A [HK, US, HKCC, SG, HKFUND, USFUND, JP] ACTIVE NORMAL [] 1 3450310 SIMULATE CASH N/A N/A N/A STOCK [HK] ACTIVE N/A [] 2 3548732 SIMULATE MARGIN N/A N/A N/A OPTION [HK] ACTIVE N/A [] 281756420273981734 [281756420273981734, 3450310, 3548732] ``` --- # 取引ロック解除 `unlock_trade(password=None, password_md5=None, is_unlock=True)` * **概要** 取引のロック解除またはロック * **パラメータ** パラメータ|型|説明 :-|:-|:- password|str|取引パスワード (password_md5 が空でない場合、指定された password_md5 でロック解除します。それ以外の場合は password を MD5 変換して password_md5 を生成し、ロック解除します) password_md5|str|取引パスワードの32桁 MD5 ハッシュ値（すべて小文字） (取引のロック解除にはパスワードの入力が必須です。取引のロック時は無視されます) is_unlock|bool|ロック解除或ロック (True：ロック解除False：ロック) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
msg NoneType 当 ret == RET_OK 时，返す None
str 当 ret != RET_OK 时，返すエラー説明
* **Example** ```python from moomoo import * pwd_unlock = '123456' trd_ctx = OpenSecTradeContext(filter_trdmarket=TrdMarket.US, host='127.0.0.1', port=11111, security_firm=SecurityFirm.FUTUINC) ret, data = trd_ctx.unlock_trade(pwd_unlock) if ret == RET_OK: print('unlock success!') else: print('unlock_trade failed: ', data) trd_ctx.close() ``` * **Output** ```python unlock success! ``` :::tip ご注意 * 本番口座で[発注](../trade/place-order.md)または[注文変更・注文取消](../trade/modify-order.md) APIを呼び出すには、事前に取引のロック解除が必要です。デモ口座ではロック解除は不要です。 * 取引のロック解除またはロックは OpenD に対する操作です。1つの接続でロック解除すれば、他の接続からも取引APIを呼び出すことができます。 * 外部ネットワーク経由で OpenD に接続して本番取引を行うお客様は、暗号化チャネルの使用を強く推奨します。[プロトコル暗号化の有効化](../ftapi/init.md#1561)を参照してください。 * CLI API は moomoo トークンに対応していません。moomoo トークンを有効にしている場合、ロック解除が失敗します。トークン機能を無効にしてから CLI API でロック解除してください。 ::: :::tip APIレート制限 * 単用户ID 每 30 秒内最多リクエスト 10 次ロック解除取引API ::: --- # 口座資金の照会 `accinfo_query(trd_env=TrdEnv.REAL, acc_id=0, acc_index=0, refresh_cache=False, currency=Currency.HKD, asset_category=AssetCategory.NONE)` * **概要** 取引口座の純資産額、証券時価、現金、購買力などの資金データを照会します。 * **パラメータ** パラメータ|型|説明 :-|:-|:- trd_env|[TrdEnv](./trade.md#293)|取引環境 acc_id|int|取引口座 ID (- acc_id と acc_index はどちらも取引口座の指定に使用でき、いずれか一方を選択してください。acc_id の使用を推奨します。 - acc_id に 0 を指定した場合、acc_index で指定した口座が使用されます - acc_id に ID 番号を指定した場合（0 以外）、acc_id で指定した口座が使用されます) acc_index|int|取引口座リスト内の口座インデックス (- acc_id と acc_index はどちらも取引口座の指定に使用でき、いずれか一方を選択してください。acc_id の使用を推奨します。acc_index は口座の新規開設や解約時に変動するため、指定した口座と実際の取引口座が一致しなくなる可能性があります。 - acc_index のデフォルトは 0 で、最初の取引口座を指定します) refresh_cache|bool|キャッシュを更新するかどうか (- True：moomoo サーバーに即座にデータを再リクエストし、OpenD のキャッシュを使用しません。この場合、APIレート制限の対象となります - False：OpenD のキャッシュを使用します（特殊な状況でキャッシュが適時に更新されない場合にのみ更新が必要です）) currency|[Currency](./trade.md#9629)|資金の表示通貨 (- 先物口座と総合証券口座にのみ適用されます。その他の口座タイプではこのパラメータは無視されます - 返される DataFrame では、通貨が明示的に指定されたフィールドを除き、その他の資金関連フィールドはすべてこのパラメータで換算されます) asset_category|[AssetCategory](./trade.md#2457)|資産類别 (のみ対日本証券会社生效) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame 当 ret == RET_OK 时，返す資金データ
str 当 ret != RET_OK 时，返すエラー説明
* 資金データフォーマットは以下の通り： フィールド|タイプ|説明 :-|:-|:- power|float|最大購買力 (- このフィールドは 50% の信用買い初期証拠金率に基づいて算出された**近似値**です。ただし、実際には銘柄ごとに信用買い初期証拠金率が異なります。実際に購入可能な最大数量を判断するには、[最大売買可能数量照会](./get-max-trd-qtys.md) APIが返す**最大購入可能数**フィールドの使用を推奨します。) max_power_short|float|空売り購買力 (- このフィールドは 60% の信用売り証拠金率に基づいて算出された**近似値**です。ただし、実際には銘柄ごとに信用売り証拠金率が異なります。実際に空売り可能な最大数量を判断するには、[最大売買可能数量照会](./get-max-trd-qtys.md) APIが返す**空売り可能数**フィールドの使用を推奨します。) net_cash_power|float|現金購買力 (廃止済みです。usd_net_cash_power 等のフィールドを使用して通貨別の現金購買力を取得してください) total_assets|float|総資産純資産 (総資産純資産 = 証券資産純資産 + 基金資産純資産 + 债券資産純資産) securities_assets|float|証券資産純資産 (最低OpenDバージョン要件：8.2.4218) fund_assets|float|基金資産純資産 (- 総合口座返す結果為総基金資産純資産，暂时不対応照会港元基金資産和美元基金資産 - 最低OpenDバージョン要件：8.2.4218) bond_assets|float|债券資産純資産 (最低OpenDバージョン要件：8.2.4218) cash|float|現金 (廃止済みです。us_cash 等のフィールドを使用して通貨別の現金を取得してください) market_val|float|証券時価 (のみ証券口座適用) long_mv|float|ロング時価 short_mv|float|ショート時価 pending_asset|float|在途資産 interest_charged_amount|float|计息金额 frozen_cash|float|凍結資金 avl_withdrawal_cash|float|現金可提 (のみ証券口座適用) max_withdrawal|float|最大出金可能額 (moomoo 証券（香港）の証券口座にのみ適用されます) currency|[Currency](./trade.md#9629)|计価通貨 (のみ総合証券口座、先物口座適用) available_funds|float|可用資金 (のみ先物口座適用) unrealized_pl|float|未実现損益 (のみ先物口座適用) realized_pl|float|已実现損益 (のみ先物口座適用) risk_level|[CltRiskLevel](./trade.md#2026)|リスク管理ステータス (先物口座にのみ適用されます。証券口座と先物口座のリスクステータスを統一的に取得するには、exposure_level フィールドの使用を推奨します) risk_status|[CltRiskStatus](./trade.md#5056)|リスクステータス (- 証券口座和先物口座均適用 - 共分 9 個レベル， `LEVEL1`是最安全，`LEVEL9`是最危险) initial_margin|float|初始保証金 margin_call_margin|float|Margin Call 保証金 maintenance_margin|float|维持保証金 hk_cash|float|港元現金 (このフィールドは当該通貨の実際の値であり、当該通貨建ての値ではありません) hk_avl_withdrawal_cash|float|港元可提 (このフィールドは当該通貨の実際の値であり、当該通貨建ての値ではありません) hkd_net_cash_power|float|港元現金購買力 (- このフィールドは当該通貨の実際の値であり、当該通貨建ての値ではありません - 最低バージョン要件：8.7) hkd_assets|float|香港株資産純資産 (- のみ総合証券口座適用 - このフィールドは当該通貨の実際の値であり、当該通貨建ての値ではありません - 最低バージョン要件：9.0.5008) us_cash|float|美元現金 (このフィールドは当該通貨の実際の値であり、当該通貨建ての値ではありません) us_avl_withdrawal_cash|float|美元可提 (このフィールドは当該通貨の実際の値であり、当該通貨建ての値ではありません) usd_net_cash_power|float|美元現金購買力 (- このフィールドは当該通貨の実際の値であり、当該通貨建ての値ではありません - 最低バージョン要件：8.7) usd_assets|float|米国株資産純資産 (- のみ総合証券口座適用 - このフィールドは当該通貨の実際の値であり、当該通貨建ての値ではありません - 最低バージョン要件：9.0.5008) cn_cash|float|人民币現金 (このフィールドは当該通貨の実際の値であり、当該通貨建ての値ではありません) cn_avl_withdrawal_cash|float|人民币可提 (このフィールドは当該通貨の実際の値であり、当該通貨建ての値ではありません) cnh_net_cash_power|float|人民币現金購買力 (- このフィールドは当該通貨の実際の値であり、当該通貨建ての値ではありません - 最低バージョン要件：8.7) cnh_assets|float|A股資産純資産 (- のみ総合証券口座適用 - このフィールドは当該通貨の実際の値であり、当該通貨建ての値ではありません - 最低バージョン要件：9.0.5008) jp_cash|float|日元現金 (- のみ先物口座適用 - このフィールドは当該通貨の実際の値であり、当該通貨建ての値ではありません - 最低moomoo APIバージョン要件：5.8.2008) jp_avl_withdrawal_cash|float|日元可提 (- のみ先物口座適用 - このフィールドは当該通貨の実際の値であり、当該通貨建ての値ではありません - 最低moomoo APIバージョン要件：5.8.2008) jpy_net_cash_power|float|日元現金購買力 (- このフィールドは当該通貨の実際の値であり、当該通貨建ての値ではありません - 最低バージョン要件：8.7) jpy_assets|float|日股資産純資産 (- のみ総合証券口座適用 - このフィールドは当該通貨の実際の値であり、当該通貨建ての値ではありません - 最低バージョン要件：9.0.5008) sg_cash|float|新元現金 (- のみ先物口座適用 - このフィールドは当該通貨の実際の値であり、当該通貨建ての値ではありません) sg_avl_withdrawal_cash|float|新元可提 (- のみ先物口座適用 - このフィールドは当該通貨の実際の値であり、当該通貨建ての値ではありません) sgd_net_cash_power|float|新元現金購買力 (- このフィールドは当該通貨の実際の値であり、当該通貨建ての値ではありません - 最低バージョン要件：8.7) sgd_assets|float|新股資産純資産 (- のみ総合証券口座適用 - このフィールドは当該通貨の実際の値であり、当該通貨建ての値ではありません - 最低バージョン要件：9.0.5008) au_cash|float|澳元現金 (- のみ総合証券口座適用 - このフィールドは当該通貨の実際の値であり、当該通貨建ての値ではありません - 最低moomoo APIバージョン要件：5.8.2008) au_avl_withdrawal_cash|float|澳元可提 (- のみ総合証券口座適用 - このフィールドは当該通貨の実際の値であり、当該通貨建ての値ではありません - 最低moomoo APIバージョン要件：5.8.2008) aud_net_cash_power|float|澳元現金購買力 (- このフィールドは当該通貨の実際の値であり、当該通貨建ての値ではありません - 最低バージョン要件：8.7) aud_assets|float|澳股資産純資産 (- のみ総合証券口座適用 - このフィールドは当該通貨の実際の値であり、当該通貨建ての値ではありません - 最低バージョン要件：9.0.5008) ca_cash|float|加元現金 (- のみ総合証券口座適用 - このフィールドは当該通貨の実際の値であり、当該通貨建ての値ではありません - 最低バージョン要件：10.0.6008) ca_avl_withdrawal_cash|float|加元可提 (- のみ総合証券口座適用 - このフィールドは当該通貨の実際の値であり、当該通貨建ての値ではありません - 最低バージョン要件：10.0.6008) cad_net_cash_power|float|加元現金購買力 (- このフィールドは当該通貨の実際の値であり、当該通貨建ての値ではありません - 最低バージョン要件：10.0.6008) cad_assets|float|加元資産純資産 (- のみ総合証券口座適用 - このフィールドは当該通貨の実際の値であり、当該通貨建ての値ではありません - 最低バージョン要件：10.0.6008) my_cash|float|令吉現金 (- のみ総合証券口座適用 - このフィールドは当該通貨の実際の値であり、当該通貨建ての値ではありません - 最低バージョン要件：10.0.6008) my_avl_withdrawal_cash|float|令吉可提 (- のみ総合証券口座適用 - このフィールドは当該通貨の実際の値であり、当該通貨建ての値ではありません - 最低バージョン要件：10.0.6008) myr_net_cash_power|float|令吉現金購買力 (- このフィールドは当該通貨の実際の値であり、当該通貨建ての値ではありません - 最低バージョン要件：10.0.6008) myr_assets|float|令吉資産純資産 (- のみ総合証券口座適用 - このフィールドは当該通貨の実際の値であり、当該通貨建ての値ではありません - 最低バージョン要件：10.0.6008) is_pdt|bool|是否為 PDT 口座 (True：是 PDT 口座，False：不是 PDT 口座のみmoomoo証券(美国)口座適用最低OpenDバージョン要件：5.8.2008) pdt_seq|string|剩余日内取引次数 (のみmoomoo証券(美国)口座適用最低OpenDバージョン要件：5.8.2008) beginning_dtbp|float|初期デイトレード購買力 (PDT として指定された moomoo 証券（米国）口座にのみ適用されます最低 OpenD バージョン要件：5.8.2008) remaining_dtbp|float|残りデイトレード購買力 (PDT として指定された moomoo 証券（米国）口座にのみ適用されます最低 OpenD バージョン要件：5.8.2008) dt_call_amount|float|デイトレード未払い金額 (PDT として指定された moomoo 証券（米国）口座にのみ適用されます最低 OpenD バージョン要件：5.8.2008) dt_status|[DtStatus](./trade.html#7098)|デイトレード制限状況 (PDT として指定された moomoo 証券（米国）口座にのみ適用されます最低 OpenD バージョン要件：5.8.2008) crypto_mv|float|暗号通貨時価総額 exposure_level|[ExposureLevel](./trade.md#8117)|ポジション限度額ステータス (仮想通貨口座はポジション制限状態に戻り、証券／先物口座はリスク管理状態に戻ります。) exposure_limit|float|ポジション限度額（単位 USD） (暗号通貨口座のみ) used_limit|float|使用済みポジション限度額（単位 USD） (暗号通貨口座のみ) remaining_limit|float|残りポジション限度額（単位 USD） (暗号通貨口座のみ) * **Example** ```python from moomoo import * trd_ctx = OpenSecTradeContext(filter_trdmarket=TrdMarket.US, host='127.0.0.1', port=11111, security_firm=SecurityFirm.FUTUINC) ret, data = trd_ctx.accinfo_query() if ret == RET_OK: print(data) print(data['power'][0]) # 最初の行の購買力を取得 print(data['power'].values.tolist()) # list に変換 else: print('accinfo_query error: ', data) trd_ctx.close() # この接続をクローズ ``` * **Output** ```python power max_power_short net_cash_power total_assets securities_assets fund_assets bond_assets cash market_val long_mv short_mv pending_asset interest_charged_amount frozen_cash avl_withdrawal_cash max_withdrawal currency available_funds unrealized_pl realized_pl risk_level risk_status initial_margin margin_call_margin maintenance_margin hk_cash hk_avl_withdrawal_cash hkd_net_cash_power hkd_assets us_cash us_avl_withdrawal_cash usd_net_cash_power usd_assets cn_cash cn_avl_withdrawal_cash cnh_net_cash_power cnh_assets jp_cash jp_avl_withdrawal_cash jpy_net_cash_power jpy_assets sg_cash sg_avl_withdrawal_cash sgd_net_cash_power sgd_assets au_cash au_avl_withdrawal_cash aud_net_cash_power aud_assets ca_cash ca_avl_withdrawal_cash cad_net_cash_power cad_assets my_cash my_avl_withdrawal_cash myr_net_cash_power myr_assets is_pdt pdt_seq beginning_dtbp remaining_dtbp dt_call_amount dt_status 0 465453.903307 465453.903307 0.0 289932.0404 197028.2204 92903.82 0.0 25.18 197003.0448 211960.7568 -14957.712 0.0 0.0 25.930845 0.0 0.0 HKD N/A N/A N/A N/A LEVEL3 219346.648525 288656.787955 181250.967601 0.0 0.0 13225.7955 0.0 3.24 0.0 9656.4365 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 N/A N/A N/A 0.0 N/A N/A N/A 0.0 N/A N/A N/A 0.0 N/A N/A N/A 0.0 N/A N/A N/A N/A N/A N/A 465453.903307 [465453.903307] ``` :::tip APIレート制限 * 同一口座ID(acc_id) 每 30 秒内最多リクエスト 10 次照会口座資金API * このAPIの呼び出しは、キャッシュを更新する場合のみレート制限の対象となります ::: --- # 最大買い/売り可能数量の照会 `acctradinginfo_query(order_type, code, price, order_id=None, adjust_limit=0, trd_env=TrdEnv.REAL, acc_id=0, acc_index=0, session=Session.NONE, jp_acc_type=SubAccType.JP_GENERAL, position_id=NONE)` * **概要** 指定取引口座の最大買い/売り可能数量を照会します。また、指定注文の最大変更可能数量も照会できます。 現金口座によるオプションのリクエストは非対応です。 * **パラメータ** パラメータ|型|説明 :-|:-|:- order_type|[OrderType](./trade.md#1851)|注文タイプ code|str|証券コード (先物取引で code が先物つなぎ足コードの場合、自動的に対応する実際の限月コードに変換されます) price|float|価格 (証券口座は小数点以下3桁、超過分は切り捨てられます先物口座は小数点以下9桁、超過分は切り捨てられます) order_id|str|注文番号 (- デフォルトは None で、新規発注の最大売買可能数量を照会します - 注文変更の場合は注文番号を指定してください。この場合、最大売買可能数量の計算時に、この注文を変更可能な最大数量が返されます - このパラメータで特定の注文の最大変更可能数量を照会する場合は、発注後 0.5 秒以上の間隔をあけてこのAPIを呼び出してください) adjust_limit|float|価格微調整幅 (OpenD は入力された価格を自動的に有効な価格に調整します（先物ではこのパラメータは無視されます） - 正数は上方調整、負数は下方調整を示します - 例：0.015 は上方調整で幅が 1.5% 以内、-0.01 は下方調整で幅が 1% 以内。デフォルトの 0 は調整なしを示します) trd_env|[TrdEnv](./trade.md#293)|取引環境 acc_id|int|取引口座 ID (- acc_id と acc_index はどちらも取引口座の指定に使用でき、いずれか一方を選択してください。acc_id の使用を推奨します。 - acc_id に 0 を指定した場合、acc_index で指定した口座が使用されます - acc_id に ID 番号を指定した場合（0 以外）、acc_id で指定した口座が使用されます) acc_index|int|取引口座リスト内の口座インデックス (- acc_id と acc_index はどちらも取引口座の指定に使用でき、いずれか一方を選択してください。acc_id の使用を推奨します。acc_index は口座の新規開設や解約時に変動するため、指定した口座と実際の取引口座が一致しなくなる可能性があります。 - acc_index のデフォルトは 0 で、最初の取引口座を指定します) session|[Session](../quote/quote.md#7928)|米国株取引時間帯 (米国株にのみ有効です。RTH、ETH、OVERNIGHT、ALL を指定可能です) jp_acc_type|[SubAccType](./trade.md#2662)|日本口座タイプ (のみ日本証券会社適用) position_id|int|ポジションID (- 日本のデリバティブ口座でポジション売却可能数と決済に必要な買い戻し数を照会する際に適用されます - [ポジション照会](./get-position-list.md) APIで取得可能です) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame 当 ret == RET_OK 时，返すアカウントリスト
str 当 ret != RET_OK 时，返すエラー説明
* アカウントリストフォーマットは以下の通り： フィールド|タイプ|説明 :-|:-|:- max_cash_buy|float|現金購入可能数 (- オプションの単位は「枚」です - 先物口座には適用されません) max_cash_and_margin_buy|float|最大購入可能数 (- オプションの単位は「枚」です - 先物口座には適用されません) max_position_sell|float|ポジション売却可能数 (オプションの単位は「枚」です) max_sell_short|float|空売り可能数 (- オプションの単位は「枚」です - 先物口座には適用されません) max_buy_back|float|決済に必要な買い戻し数 (- ネットショートポジションを保有している場合、ショートポジションの株数を先に買い戻してからでないと、追加の買い注文を出せません - 先物、オプションの単位は「枚」です) long_required_im|float|1枚の買い注文による初期証拠金変動額。 (- 現在、先物とオプションにのみ適用されます。 - ポジションなしの場合、**買い** 1枚の初期証拠金占有額（正数）を返します。 - ロングポジションありの場合、**買い** 1枚の初期証拠金占有額（正数）を返します。 - ショートポジションありの場合、**買い戻し** 1枚の初期証拠金解放額（負数）を返します。) short_required_im|float|1枚の売り注文による初期証拠金変動額。 (- 現在、先物とオプションにのみ適用されます。 - ポジションなしの場合、**空売り** 1枚の初期証拠金占有額（正数）を返します。 - ロングポジションありの場合、**売り** 1枚の初期証拠金解放額（負数）を返します。 - ショートポジションありの場合、**空売り** 1枚の初期証拠金占有額（正数）を返します。) session|[Session](../quote/quote.md#7928)|取引注文時間帯（米国株にのみ使用） * **Example** ```python from moomoo import * trd_ctx = OpenSecTradeContext(filter_trdmarket=TrdMarket.US, host='127.0.0.1', port=11111, security_firm=SecurityFirm.FUTUINC) ret, data = trd_ctx.acctradinginfo_query(order_type=OrderType.NORMAL, code='US.AAPL', price=400) if ret == RET_OK: print(data) print(data['max_cash_and_margin_buy'][0]) # 最大信用買い可能数量 else: print('acctradinginfo_query error: ', data) trd_ctx.close() # この接続をクローズ ``` * **Output** ```python max_cash_buy max_cash_and_margin_buy max_position_sell max_sell_short max_buy_back long_required_im short_required_im session 0 0.0 1500.0 0.0 0.0 0.0 N/A N/A N/A 1500.0 ``` :::tip APIレート制限 * 同一口座ID(acc_id)で30秒以内に最大10回まで最大売買可能数量照会APIをリクエスト可能 ::: :::tip ご注意 * 現金取引口座はデリバティブ取引に対応していないため、現金取引口座でのオプションの最大売買可能数量の照会には対応していません。 * 先物の最大購入可能数は自分で計算する必要があります。計算式：floor（最大購買力 / 1枚の買い注文による初期証拠金変動額）。最大購買力は[口座資金照会](./get-funds.md)から、1枚の買い注文による初期証拠金変動額は本APIから取得できます。 ::: --- # コンボ注文の取引可能情報照会 `comboorder_tradinginfo_query(combo_leg_list, price, qty, order_type=OrderType.NORMAL, order_id=None, trd_env=TrdEnv.REAL, acc_id=0, acc_index=0)` * **概要** 指定価格・数量におけるコンボ注文の取引可能情報（証拠金・買付余力などの変動）を照会します。注文番号を指定して、注文変更シナリオの取引可能情報も照会できます。 * **パラメータ** パラメータ|型|説明 :-|:-|:- combo_leg_list|list|コンボレッグリスト (- リスト要素は ComboLeg オブジェクト。フィールド説明は [place_combo_order](./place-combo-order.md) の ComboLeg 表を参照) price|float|提示価格 (オークション注文または成行注文の場合も、サーバーが計算できるよう現在価格を入力してください) qty|float|数量 (コンボ数量。各レッグの実際数量は qty × 当該レッグの qty_ratio) order_type|[OrderType](./trade.md#4181)|注文タイプ order_id|str|注文番号 (- デフォルト None の場合、新規注文の取引可能情報を照会 - 注文変更時はサーバー注文番号 orderIDEx を指定し、変更可能な関連情報を取得) trd_env|[TrdEnv](./trade.md#6374)|取引環境 acc_id|int|取引口座 ID (- acc_id と acc_index はいずれか一方を指定。acc_id の使用を推奨 - acc_id に 0 を指定した場合、acc_index で指定した口座を使用) acc_index|int|取引口座リスト内の口座インデックス (デフォルト 0 で、最初の取引口座を指定) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、取引可能情報を返す
str ret != RET_OK の場合、エラー説明を返す
* 取引可能情報フォーマットは以下の通り： フィールド|型|説明 :-|:-|:- nlv_change|float|純資産変動 initial_margin_change|float|初期証拠金変動 maintenance_margin_change|float|維持証拠金変動 option_bp|float|オプション買付余力 max_withdraw_change|float|最大引出可能額変動 bp_decrease|float|買付余力消費 * **Example** ```python from moomoo import * trd_ctx = OpenSecTradeContext(filter_trdmarket=TrdMarket.US, host='127.0.0.1', port=11111, security_firm=SecurityFirm.FUTUINC) leg1 = ComboLeg() leg1.code = 'US.AAPL260529C302500' leg1.trd_side = TrdSide.BUY leg1.qty_ratio = 1 leg2 = ComboLeg() leg2.code = 'US.AAPL' leg2.trd_side = TrdSide.SELL leg2.qty_ratio = 100 combo_legs = [leg1, leg2] ret, data = trd_ctx.comboorder_tradinginfo_query(combo_legs, price=100, qty=1, order_type=OrderType.NORMAL, trd_env=TrdEnv.SIMULATE) if ret == RET_OK: print(data) else: print('comboorder_tradinginfo_query error: ', data) trd_ctx.close() ``` * **Output** ```python nlv_change initial_margin_change maintenance_margin_change option_bp max_withdraw_change bp_decrease 0 ... ... ... ... ... ... ``` :::tip APIレート制限 * 同一口座 ID（acc_id）につき、30 秒以内に最大売買可能数量照会系 API を 10 回までリクエスト可能です。 ::: --- # 照会ポジション `position_list_query(code='', position_market=TrdMarket.NONE, pl_ratio_min=None, pl_ratio_max=None, trd_env=TrdEnv.REAL, acc_id=0, acc_index=0, refresh_cache=False, asset_category=AssetCategory.NONE, currency=Currency.USD, show_option_strategy_view=False)` * **概要** 取引口座のポジションリストを照会します * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|銘柄コードフィルタ (- このコードに対応するポジションデータのみを返します。未指定の場合はすべて返します - 注意：先物ポジションのコードフィルタには、具体的な限月を含む限月コードを指定する必要があります。つなぎ足コードではフィルタできません) position_market| [TrdMarket](./trade.md#4416)|ポジション所属市場フィルタ (- 指定市場のポジションデータを返します - デフォルトの場合、すべての市場のポジションデータを返します) pl_ratio_min|float|現在の損益率下限フィルタ。この比率を超えるポジションのみ返します (証券口座は希薄化取得原価の損益率、先物口座は平均取得原価の損益率を使用します例：10 を指定すると、損益率が +10% を超えるポジションを返します) pl_ratio_max|float|現在の損益率上限フィルタ。この比率を下回るポジションを返します (証券口座は希薄化取得原価の損益率、先物口座は平均取得原価の損益率を使用します例：20 を指定すると、損益率が +20% 未満のポジションを返します) trd_env|[TrdEnv](./trade.md#293)|取引環境 acc_id|int|取引口座 ID (- acc_id と acc_index はどちらも取引口座の指定に使用でき、いずれか一方を選択してください。acc_id の使用を推奨します。 - acc_id に 0 を指定した場合、acc_index で指定した口座が使用されます - acc_id に ID 番号を指定した場合（0 以外）、acc_id で指定した口座が使用されます) acc_index|int|取引口座リスト内の口座インデックス (- acc_id と acc_index はどちらも取引口座の指定に使用でき、いずれか一方を選択してください。acc_id の使用を推奨します。acc_index は口座の新規開設や解約時に変動するため、指定した口座と実際の取引口座が一致しなくなる可能性があります。 - acc_index のデフォルトは 0 で、最初の取引口座を指定します) refresh_cache|bool|キャッシュを更新するかどうか (- True：moomoo サーバーに即座にデータを再リクエストし、OpenD のキャッシュを使用しません。この場合、APIレート制限の対象となります - False：OpenD のキャッシュを使用します（特殊な状況でキャッシュが適時に更新されない場合にのみ更新が必要です）) asset_category|[AssetCategory](./trade.md#2457)|資産類别 (のみ対日本証券会社生效) currency|[Currency](./trade.md#9629)|ポジションの通貨単位 (暗号通貨口座のみ使用) show_option_strategy_view|bool|オプション戦略ビューのポジションを返すかどうか (- True：オプション戦略次元のポジションを返します（コンボ戦略フィールドを含む） - False：銘柄次元のポジションを返します（デフォルト）) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame 当 ret == RET_OK 时，返すポジションリスト
str 当 ret != RET_OK 时，返すエラー説明
* ポジションリスト フィールド|タイプ|説明 :-|:-|:- position_side|[PositionSide](./trade.md#4049)|ポジション方向 code|str|銘柄コード stock_name|str|銘柄名 position_market|[TrdMarket](./trade.md#4416)|ポジション所属市場 qty|float|保有数量 (オプションと先物の単位は「枚」です) can_sell_qty|float|売却可能数量 (売却可能数量とは、保有しているうち決済可能な数量です。売却可能数量 = 保有数量 - 凍結数量オプションと先物の単位は「枚」です。) currency|[Currency](./trade.md#9629)|取引通貨 nominal_price|float|市価 (小数点以下3桁、超過分は四捨五入されます) cost_price|float|希薄化取得原価（証券口座）、平均建値（先物口座） (ポジションの取得原価を取得するには average_cost、diluted_cost フィールドの使用を推奨します) cost_price_valid|bool|成本価是否有効 (True：有効False：無効) average_cost|float|平均成本価 (デモ証券口座不適用最低OpenDバージョン要件：9.2.5208) diluted_cost|float|摊薄成本価 (先物口座不適用最低OpenDバージョン要件：9.2.5208) market_val|float|時価 (精度：3 位小数（A株 2 位小数，先物 0 位小数）) pl_ratio|float|損益率（希薄化取得原価モード） (先物には適用されませんこのフィールドはパーセント値で、デフォルトでは % を表示しません。例: 20 は実際には 20% に対応) pl_ratio_valid|bool|損益比例是否有効 (True：有効False：無効) pl_ratio_avg_cost|float|損益率（平均取得原価モード） (デモ証券口座には適用されませんこのフィールドはパーセント値で、デフォルトでは % を表示しません。例: 20 は実際には 20% に対応最低 OpenD バージョン要件：9.2.5208) pl_val|float|損益金额 (精度：3 位小数（A株 2 位小数）) pl_val_valid|bool|損益金额是否有効 (True：有効False：無効) today_pl_val|float|今日損益金额 (只在本番取引環境下有効精度：3 位小数（A株 2 位小数，先物 2 位小数）) today_trd_val|float|今日取引金额 (只在本番取引環境下有効精度：3 位小数（A株 2 位小数）先物不適用) today_buy_qty|float|今日買い総数量 (只在本番取引環境下有効精度：3 位小数（A株 2 位小数）先物不適用) today_buy_val|float|今日買い総額 (只在本番取引環境下有効精度：3 位小数（A株 2 位小数）先物不適用) today_sell_qty|float|今日売り総数量 (只在本番取引環境下有効精度：3 位小数（A株 2 位小数）先物不適用) today_sell_val|float|今日売り総額 (只在本番取引環境下有効精度：3 位小数（A株 2 位小数）先物不適用) unrealized_pl|float|未実現損益 (デモ証券口座には適用されません総合証券口座では、平均取得原価モードでの未実現損益金額を返します) realized_pl|float|実現損益 (デモ証券口座には適用されません総合証券口座では、平均取得原価モードでの実現損益金額を返します) position_id|int|ポジションID combo_id|int|コンボ ID (show_option_strategy_view=True の場合に有効) strategy_type|[OptionStrategyType](../quote/quote.md#2931)|コンボ戦略タイプ (show_option_strategy_view=True の場合に有効) position_type|[PositionType](./trade.md#2116)|ポジションタイプ (show_option_strategy_view=True の場合に有効) acc_id|int|取引口座 ID jp_acc_type|[SubAccType](./trade.md#2662)|日本口座タイプ (のみ日本証券会社適用) * **Example** ```python from futu import * trd_ctx = OpenSecTradeContext(filter_trdmarket=TrdMarket.US, host='127.0.0.1', port=11111, security_firm=SecurityFirm.FUTUINC) ret, data = trd_ctx.position_list_query() if ret == RET_OK: print(data) if data.shape[0] > 0: # ポジションリストが空でない場合 print(data['stock_name'][0]) # ポジションの最初の銘柄名を取得 print(data['stock_name'].values.tolist()) # list に変換 else: print('position_list_query error: ', data) trd_ctx.close() # この接続をクローズ ``` * **Output** ```python code stock_name position_market qty can_sell_qty cost_price cost_price_valid average_cost diluted_cost market_val nominal_price pl_ratio pl_ratio_valid pl_ratio_avg_cost pl_val pl_val_valid today_buy_qty today_buy_val today_pl_val today_trd_val today_sell_qty today_sell_val position_side unrealized_pl realized_pl currency asset_category position_id 0 US.AAPL 苹果 HK 400.0 400.0 53.975 True N/A 53.975 19720.0 49.3 -8.661417 True N/A -1870.0 True N/A N/A N/A N/A N/A N/A LONG N/A N/A HKD N/A 6596101776329286054 苹果 ['苹果'] ``` :::tip APIレート制限 * 同一口座ID(acc_id) 每 30 秒内最多リクエスト 10 次照会ポジションAPI * このAPIの呼び出しは、キャッシュを更新する場合のみレート制限の対象となります ::: --- # 信用取引データの取得 `get_margin_ratio(code_list)` * **概要** 株式の信用取引データを照会します。 * **パラメータ** パラメータ|型|説明 :-|:-|:- code_list|list|銘柄コードリスト (1回のリクエストにつき最大100銘柄まで指定可能ですリスト内の要素タイプは str です) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame 当 ret == RET_OK 时，返す信用買い信用売りデータ
str 当 ret != RET_OK 时，返すエラー説明
* 信用買い信用売りデータフォーマットは以下の通り： フィールド|タイプ|説明 :-|:-|:- code| str| 銘柄コード is_long_permit|bool|是否許可信用買い is_short_permit | bool | 是否許可信用売り short_pool_remain | float | 空売り池剩余 (単位：股) short_fee_rate | float | 信用売りを参照利率 (このフィールドはパーセント値で、デフォルトでは % を表示しません。例: 20 は実際には 20% に対応) alert_long_ratio | float | 信用買い警告比率 (このフィールドはパーセント値で、デフォルトでは % を表示しません。例: 20 は実際には 20% に対応) alert_short_ratio | float | 信用売り警告比率 (このフィールドはパーセント値で、デフォルトでは % を表示しません。例: 20 は実際には 20% に対応) im_long_ratio | float | 信用買い初期証拠金率 (このフィールドはパーセント値で、デフォルトでは % を表示しません。例: 20 は実際には 20% に対応) im_short_ratio | float | 信用売り初期証拠金率 (このフィールドはパーセント値で、デフォルトでは % を表示しません。例: 20 は実際には 20% に対応) mcm_long_ratio | float | 信用買い margin call 証拠金率 (このフィールドはパーセント値で、デフォルトでは % を表示しません。例: 20 は実際には 20% に対応) mcm_short_ratio | float | 信用売り margin call 証拠金率 (このフィールドはパーセント値で、デフォルトでは % を表示しません。例: 20 は実際には 20% に対応) mm_long_ratio |float | 信用買い維持証拠金率 (このフィールドはパーセント値で、デフォルトでは % を表示しません。例: 20 は実際には 20% に対応) mm_short_ratio |float | 信用売り維持証拠金率 (このフィールドはパーセント値で、デフォルトでは % を表示しません。例: 20 は実際には 20% に対応) * **Example** ```python from moomoo import * trd_ctx = OpenSecTradeContext(filter_trdmarket=TrdMarket.US, host='127.0.0.1', port=11111, security_firm=SecurityFirm.FUTUINC) ret, data = trd_ctx.get_margin_ratio(code_list=['US.AAPL','US.FUTU']) if ret == RET_OK: print(data) print(data['is_long_permit'][0]) # 最初のレコードの信用買い許可状況を取得 print(data['im_short_ratio'].values.tolist()) # list に変換 else: print('error:', data) trd_ctx.close() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。 ``` * **Output** ```python code is_long_permit is_short_permit short_pool_remain short_fee_rate alert_long_ratio alert_short_ratio im_long_ratio im_short_ratio mcm_long_ratio mcm_short_ratio mm_long_ratio mm_short_ratio 0 US.AAPL True True 1826900.0 0.89 33.0 56.0 35.0 60.0 32.0 53.0 25.0 40.0 1 US.FUTU True True 1150600.0 0.95 48.0 46.0 50.0 50.0 47.0 43.0 40.0 30.0 True [60.0, 50.0] ``` :::tip APIレート制限 * 単用户ID 每 30 秒内最多リクエスト 10 次取得信用買い信用売りデータAPI。 * 1回のリクエストにつき、APIパラメータの銘柄コードリストには最大100銘柄まで指定可能です。 * 米国、香港、A株市場の株式とETFに対応しています。 ::: --- # 口座キャッシュフローの照会 `get_acc_cash_flow(clearing_date='', trd_env=TrdEnv.REAL, acc_id=0, acc_index=0, cashflow_direction=CashFlowDirection.NONE, start='', end='')` * **概要** 取引口座の指定日付における現金フローデータを照会します。入出金、振替、通貨両替、金融資産の売買、信用買い・信用売り利息など、現金変動が発生するすべての取引を含みます。 * **パラメータ** パラメータ|型|説明 :-|:-|:- clearing_date|str|清算日付 (- 証券口座における資金フロー記録を確認するために必要なパラメータ。如需照会多日，需逐日リクエスト - 形式：yyyy-MM-dd，例如："2017-06-20") trd_env|TrdEnv|取引環境 acc_id|int|取引口座 ID (- acc_id と acc_index はどちらも取引口座の指定に使用でき、いずれか一方を選択してください。acc_id の使用を推奨します。 - acc_id に 0 を指定した場合、acc_index で指定した口座が使用されます - acc_id に ID 番号を指定した場合（0 以外）、acc_id で指定した口座が使用されます) acc_index|int|取引口座リスト内の口座インデックス cashflow_direction|[CashFlowDirection](./trade.md#8152)|キャッシュフロー方向フィルタ start_time|str|開始時間 (暗号通貨口座のみ使用、形式：yyyy-MM-dd HH:mm:ss) end_time|str|終了時間 (暗号通貨口座のみ使用、形式：yyyy-MM-dd HH:mm:ss) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame 当 ret == RET_OK 时，返す取引口座現金フローリスト形式
str 当 ret != RET_OK 时，返すエラー説明
* 取引口座現金フローリストフォーマットは以下の通り： フィールド|タイプ|説明 :-|:-|:- cashflow_id|int|現金流唯一識別子 clearing_date|str|清算日付 settlement_date|str|交收日付 currency|[Currency](./trade.md#9629)|币种 cashflow_type|str|現金流タイプ cashflow_direction|[CashFlowDirection](./trade.md#8152)|キャッシュフロー方向 cashflow_amount|float|金額（正数は流入、負数は流出を示します） cashflow_remark|str|備考 * **Example** ```python from futu import * trd_ctx = OpenSecTradeContext(filter_trdmarket=TrdMarket.US, host='127.0.0.1', port=11111, security_firm=SecurityFirm.FUTUINC) ret, data = trd_ctx.get_acc_cash_flow(clearing_date='2025-02-18', trd_env=TrdEnv.REAL, acc_id=0, acc_index=0, cashflow_direction=CashFlowDirection.NONE) if ret == RET_OK: print(data) if data.shape[0] > 0: # 現金フローリストが空でない場合 print(data['cashflow_type'][0]) # 最初のフローの現金フロータイプを取得 print(data['cashflow_amount'].values.tolist()) # list に変換 else: print('get_acc_cash_flow error: ', data) trd_ctx.close() ``` * **Output** ```python cashflow_id clearing_date settlement_date currency cashflow_type cashflow_direction cashflow_amount cashflow_remark 0 16308 2025-02-27 2025-02-28 HKD 其他 N/A 0.00 Opt ASS-P-JXC250227P13000-20250227 1 16357 2025-02-27 2025-03-03 HKD 其他 OUT -104000.00 2 16360 2025-02-27 2025-02-27 USD 基金赎回 IN 23000.00 Fund Redemption#Taikang Kaitai US Dollar Money... 3 16384 2025-02-27 2025-02-27 HKD 基金赎回 IN 104108.96 Fund Redemption#Taikang Kaitai Hong Kong Dolla... 其他 [0.00, -104000.00, 23000.00, 104108.96] ``` :::tip APIレート制限 * 同一口座ID(acc_id) 每 30 秒内最多リクエスト 20 次現金フローAPI。 * 現金フローは時刻の「昇順」で並べられます。 * デモ取引および moomoo US 口座は現在、現金フローの照会に対応していません。 ::: --- # 発注 `place_order(price, qty, code, trd_side, order_type=OrderType.NORMAL, adjust_limit=0, trd_env=TrdEnv.REAL, acc_id=0, acc_index=0, remark=None, time_in_force=TimeInForce.DAY, fill_outside_rth=False, aux_price=None, trail_type=None, trail_value=None, trail_spread=None, session=Session.NONE, jp_acc_type=SubAccType.JP_GENERAL, position_id=NONE)` * **概要** 発注 :::tip 提示 Python API は同期的ですが、ネットワークの送受信は非同期です。place_order の応答データパケットと[約定プッシュコールバック](../trade/update-order-fill.md)または[注文プッシュコールバック](../trade/update-order.md)の間隔が非常に短い場合、place_order のデータパケットが先に返されるにもかかわらず、コールバック関数が先に呼び出されることがあります。例：[注文プッシュコールバック](../trade/update-order.md)が先に呼び出され、その後に place_order API が返されることがあります。 ::: * **パラメータ** パラメータ|型|説明 :-|:-|:- price|float|注文価格 (- 成行注文またはオークション注文タイプの場合も price パラメータは必要です。任意の値を指定可能です - 精度： - 先物：整数8桁、小数9桁、負数価格に対応 - 米国株オプション：小数2桁 - 米国株：$1以下の場合、小数4桁まで許可。1ドル以上、小数2桁まで許可。 - その他：小数3桁、超過分は四捨五入されます) qty|float|注文数量 (オプション・先物の単位は「枚」) code|str|銘柄コード (code が先物つなぎ足コードの場合、自動的に実際の限月コードに変換されます) trd_side|[TrdSide](./trade.md#9032)|取引方向 order_type|[OrderType](./trade.md#1851)|注文タイプ adjust_limit|float|価格微調整幅 (OpenD は入力された価格を自動的に有効な価格に調整します - 正数は上方調整、負数は下方調整を示します - 例：0.015 は上方調整で幅が 1.5% 以内、-0.01 は下方調整で幅が 1% 以内。デフォルトの 0 は調整なしを示します) trd_env|[TrdEnv](./trade.md#293)|取引環境 acc_id|int|取引口座 ID (- acc_id と acc_index はどちらも取引口座の指定に使用でき、いずれか一方を選択してください。acc_id の使用を推奨します。 - acc_id に 0 を指定した場合、acc_index で指定した口座が使用されます - acc_id に ID 番号を指定した場合（0 以外）、acc_id で指定した口座が使用されます) acc_index|int|取引口座リスト内の口座インデックス (- acc_id と acc_index はどちらも取引口座の指定に使用でき、いずれか一方を選択してください。acc_id の使用を推奨します。acc_index は口座の新規開設や解約時に変動するため、指定した口座と実際の取引口座が一致しなくなる可能性があります。 - acc_index のデフォルトは 0 で、最初の取引口座を指定します) remark|str|備考 (- 注文にこの備考フィールドが付与され、注文の識別に使用できます - UTF-8 変換後の長さは最大 64 バイトです) time_in_force|[TimeInForce](./trade.md#6063)|有効期限 (香港市場、A株市場およびグローバル先物の成行注文は、当日有効にのみ対応しています) fill_outside_rth|bool|プレ/アフターマーケットを許可するかどうか（廃止） (このフィールドは廃止されました。Session（取引時間帯）を使用して注文することを推奨します。香港株プレマーケットオークションおよび米国株プレ/アフターマーケットに使用します。プレ/アフターマーケット時間帯では成行注文に対応していません) aux_price|float|トリガー価格 (- 注文がストップロス成行注文、ストップロス指値注文、トリガー指値注文（利確）、トリガー成行注文（利確）の場合、aux_price は必須パラメータ - priceと同精度、超過分は四捨五入されます) trail_type|[TrailType](./trade.md#9391)|トレーリングタイプ (注文がトレーリングストップロス成行注文またはトレーリングストップロス指値注文の場合、trail_type は必須パラメータ) trail_value|float|トレーリング金額/パーセント (- 注文がトレーリングストップロス成行注文、トレーリングストップロス指値注文の場合、trail_value は必須パラメータです - トレーリングタイプが比率の場合、このフィールドはパーセントフィールドで、20 を指定すると実際には 20% に対応します - トレーリングタイプが金額の場合、整数部は price と同じ。小数部は米国株オプションが2桁固定、米国株が4桁、その他は price と同じ。超過分は四捨五入されます - トレーリングタイプが比率の場合、小数点以下2桁、整数部は price と同じ、超過分は四捨五入されます) trail_spread|float|指定スプレッド (- 注文がトレーリングストップロス指値注文の場合、trail_spread は必須パラメータです - 証券口座は小数点以下3桁、先物口座は小数点以下9桁、超過分は四捨五入されます) session|[Session](../quote/quote.md#7928)|米国株取引時間帯 (米国株にのみ有効です。RTH、ETH、OVERNIGHT、ALL を指定可能です) jp_acc_type|[SubAccType](./trade.md#2662)|日本口座タイプ (のみ日本証券会社適用) position_id|int|ポジションID (- 日本の証券会社で決済する際に入力が必要です - [ポジション照会](./get-position-list.md) APIで取得可能です) expire_time|str|注文有効期限、time_in_forceがGTDの場合のみ有効 * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、注文リストを返す
str ret != RET_OK の場合、エラー説明を返す
* 注文リストフォーマットは以下の通り： フィールド|タイプ|説明 :-|:-|:- trd_side|[TrdSide](./trade.md#9032)|取引方向 order_type|[OrderType](./trade.md#1851)|注文タイプ order_status|[OrderStatus](./trade.md#1624)|注文ステータス order_id|str|注文番号 code|str|銘柄コード stock_name|str|銘柄名 qty|float|注文数量 (オプション・先物の単位は「枚」) price|float|注文価格 (小数点以下3桁、超過分は四捨五入されます) create_time|str|作成日時 (形式：yyyy-MM-dd HH:mm:ss 先物のタイムゾーン指定は [OpenD 設定](../quick/opend-base.md#8384) を参照) updated_time|str|最終更新日時 (形式：yyyy-MM-dd HH:mm:ss 先物のタイムゾーン指定は [OpenD 設定](../quick/opend-base.md#8384) を参照) dealt_qty|float|約定数量 (オプション・先物の単位は「枚」) dealt_avg_price|float|約定平均価格 (精度制限なし) last_err_msg|str|最新のエラー説明 (エラーがある場合、最後のエラーの原因を返しますエラーがない場合、空文字列を返します) remark|str|発注時の備考識別子 (詳細は [place_order](./place-order.md) APIパラメータの remark を参照してください) time_in_force|[TimeInForce](./trade.md#6063)|有効期限 fill_outside_rth|bool|プレ/アフターマーケットを許可するかどうか（香港株プレマーケットオークションおよび米国株プレ/アフターマーケットに使用） (True：許可False：不許可) aux_price|float|トリガー価格 trail_type|[TrailType](./trade.md#9391)|トレーリングタイプ trail_value|float|トレーリング金额/パーセント trail_spread|float|指定スプレッド session|[Session](../quote/quote.md#7928)|取引注文時間帯（米国株にのみ使用） * **Example** ```python from moomoo import * pwd_unlock = '123456' trd_ctx = OpenSecTradeContext(filter_trdmarket=TrdMarket.US, host='127.0.0.1', port=11111, security_firm=SecurityFirm.FUTUINC) ret, data = trd_ctx.unlock_trade(pwd_unlock) # 本番口座で発注する場合は先にロック解除が必要です。ここではデモ口座での発注のため、ロック解除を省略できます。 if ret == RET_OK: ret, data = trd_ctx.place_order(price=510.0, qty=100, code="US.AAPL", trd_side=TrdSide.BUY, trd_env=TrdEnv.SIMULATE, session=Session.NONE) if ret == RET_OK: print(data) print(data['order_id'][0]) # 発注の注文番号を取得 print(data['order_id'].values.tolist()) # list に変換 else: print('place_order error: ', data) else: print('unlock_trade failed: ', data) trd_ctx.close() ``` * **Output** ```python code stock_name trd_side order_type order_status order_id qty price create_time updated_time dealt_qty dealt_avg_price last_err_msg remark time_in_force fill_outside_rth session aux_price trail_type trail_value trail_spread currency 0 US.AAPL 苹果 BUY NORMAL SUBMITTING 38196006548709500 100.0 420.0 2021-11-04 11:38:19 2021-11-04 11:38:19 0.0 0.0 DAY N/A N/A N/A N/A N/A N/A USD 38196006548709500 ['38196006548709500'] ``` :::tip APIレート制限 * 同一口座 ID（acc_id）につき、30秒以内に発注APIを最大15回までリクエスト可能です。また、連続するリクエストの間隔は 0.02 秒以上必要です。[組み合わせ注文](./place-combo-order.md) とレート制限を共有します。 * 本番口座で発注APIを呼び出す前に、[ロック解除](./unlock.md)が必要です。デモ口座ではロック解除は不要です。 ::: :::tip ご注意 * 各注文タイプに対応する必須パラメータ：[こちら](../qa/trade.html#4465)をご覧ください * 各証券会社は取引品目ごとに1回の注文の株数を制限しており、制限を超えると発注が失敗します。[こちら](../qa/trade.html#4465)をご覧ください * **空売り可能な銘柄**について、現在ロック機能に対応していないため、同一銘柄のロングポジションとショートポジションを同時に保有することはできません。 * **空売り可能な銘柄**の**決済**操作を行う場合、ポジションの方向を自分で判断し、反対方向の同数量の注文を提出して決済を完了する必要があります。 * **空売り可能な銘柄**の**ドテン**操作を行う場合、2つのステップが必要です：1. まずポジションの方向を判断し、反対方向の同数量の注文を提出して決済を完了します。2. 反対方向の注文を提出し、逆方向の注文を完了します。 例：A が現在 HK.HSI2012 先物契約の買いポジションを1枚保有している場合、ドテンするには、まず HK.HSI2012 を1枚売って決済し、さらに HK.HSI2012 を1枚売ってショートポジションを建てる必要があります。 * 米国株の全時間帯取引は指値注文にのみ対応しており、注文期限は当日有効または取消まで有効を選択できます。全時間帯を選択すると、1回の指値注文で複数の時間帯（夜間取引、プレマーケット、立会時間中、アフターマーケット）の取引に参加できます。全時間帯の取引時間は日曜日から木曜日の 20:00 ～ 翌日 20:00（米国東部時間）です。 * 米国株デモ取引不対応プレ/アフターマーケット与夜間取引。 ::: --- # 組み合わせ注文 `place_combo_order(combo_leg_list, price, qty, order_type=OrderType.NORMAL, trd_env=TrdEnv.REAL, acc_id=0, acc_index=0, remark="", time_in_force=TimeInForce.DAY, expire_time=None)` * **概要** コンボオプション/コンボ戦略の注文を提出します。 :::tip 提示 Python API は同期的ですが、ネットワークの送受信は非同期です。place_combo_order の応答データパケットと[約定プッシュコールバック](../trade/update-order-fill.md)または[注文プッシュコールバック](../trade/update-order.md)の間隔が非常に短い場合、place_combo_order のデータパケットが先に返されるにもかかわらず、コールバック関数が先に呼び出されることがあります。 ::: * **パラメータ** パラメータ|型|説明 :-|:-|:- combo_leg_list|list|コンボレッグリスト (- リスト要素は ComboLeg オブジェクトで、各レッグはコンボ内の銘柄と取引方向を表します - ComboLeg フィールドは下表を参照) price|float|注文価格 (- 成行注文またはオークション注文タイプの場合も price パラメータは必要です。任意の値を指定可能です - 精度ルールは [place_order](./place-order.md) の price パラメータと同じです) qty|float|注文数量 (コンボ注文数量。各レッグの実際数量は qty × 当該レッグの qty_ratio) order_type|[OrderType](./trade.md#4181)|注文タイプ trd_env|[TrdEnv](./trade.md#6374)|取引環境 acc_id|int|取引口座 ID (- acc_id と acc_index はどちらも取引口座の指定に使用でき、いずれか一方を選択してください。acc_id の使用を推奨します - acc_id に 0 を指定した場合、acc_index で指定した口座が使用されます - acc_id に ID 番号を指定した場合（0 以外）、acc_id で指定した口座が使用されます) acc_index|int|取引口座リスト内の口座インデックス (- acc_id と acc_index はどちらも取引口座の指定に使用でき、いずれか一方を選択してください。acc_id の使用を推奨します - acc_index のデフォルトは 0 で、最初の取引口座を指定します) remark|str|備考 (- 注文にこの備考フィールドが付与され、注文の識別に使用できます - UTF-8 変換後の長さは最大 64 バイトです) time_in_force|[TimeInForce](./trade.md#4241)|有効期限 expire_time|str|注文有効期限 (time_in_force が GTD の場合に有効。形式：yyyy-MM-dd) * ComboLeg オブジェクトフィールド： フィールド|型|説明 :-|:-|:- code|str|銘柄コード。形式例： US.AAPL、US.AAPL260529C302500 trd_side|[TrdSide](./trade.md#5815)|当該レッグの取引方向 qty_ratio|float|数量比率 (当該レッグの実際数量 = 注文 qty × qty_ratio) position_id|int|ポジションID (決済時に入力が必要です。[ポジション照会](./get-position-list.md) で show_option_strategy_view=True を指定して取得したオプション戦略ビューのポジションに含まれる position_id を指定してください。) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame ret == RET_OK の場合、注文リストを返す
str ret != RET_OK の場合、エラー説明を返す
* 注文リストフォーマットは以下の通り： フィールド|型|説明 :-|:-|:- order_id|str|注文番号 code|str|コンボ戦略コード strategy_type|[OptionStrategyType](../quote/quote.md#2931)|コンボ戦略タイプ trd_side|[TrdSide](./trade.md#5815)|取引方向 order_type|[OrderType](./trade.md#4181)|注文タイプ order_status|[OrderStatus](./trade.md#797)|注文ステータス qty|float|注文数量 price|float|注文価格 amount|float|注文金額 time_in_force|[TimeInForce](./trade.md#4241)|有効期限 expire_time|str|有効期限 dealt_qty|float|約定数量 dealt_avg_price|float|約定平均価格 create_time|str|作成日時 updated_time|str|最終更新日時 last_err_msg|str|最新のエラー説明 remark|str|備考 combo_legs|list|コンボレッグリスト (要素は ComboLeg オブジェクト) * **Example** ```python from moomoo import * trd_ctx = OpenSecTradeContext(filter_trdmarket=TrdMarket.US, host='127.0.0.1', port=11111, security_firm=SecurityFirm.FUTUINC) leg1 = ComboLeg() leg1.code = 'US.AAPL260529C302500' leg1.trd_side = TrdSide.BUY leg1.qty_ratio = 1 leg2 = ComboLeg() leg2.code = 'US.AAPL' leg2.trd_side = TrdSide.SELL leg2.qty_ratio = 100 combo_legs = [leg1, leg2] ret, data = trd_ctx.place_combo_order(combo_legs, price=9.9, qty=1, order_type=OrderType.NORMAL, trd_env=TrdEnv.SIMULATE) if ret == RET_OK: print(data) print(data['order_id'][0]) else: print('place_combo_order error: ', data) trd_ctx.close() ``` * **Output** ```python order_id code strategy_type trd_side order_type order_status qty price ... 0 FH1C79E90941477000 ... ... ... NORMAL SUBMITTING 1.0 9.9 ... FH1C79E90941477000 ``` :::tip APIレート制限 * 同一口座 ID（acc_id）につき、30秒以内に発注APIを最大15回までリクエスト可能です。また、連続するリクエストの間隔は 0.02 秒以上必要です。[発注](./place-order.md) とレート制限を共有します。 * 本番口座で発注APIを呼び出す前に、[ロック解除](./unlock.md)が必要です。デモ口座ではロック解除は不要です。 ::: :::tip 提示 * combo_leg_list の各レッグ銘柄は同一取引市場に属する必要があります。システムは最初のレッグの市場に基づいて trd_market を決定します。 * 各レッグの qty_ratio と qty が合わさって、各レッグの実際の注文数量を決定します。 ::: --- # 注文変更・注文取消 `modify_order(modify_order_op, order_id, qty, price, adjust_limit=0, trd_env=TrdEnv.REAL, acc_id=0, acc_index=0, aux_price=None, trail_type=None, trail_value=None, trail_spread=None)` * **概要** 注文の価格と数量の変更、注文取消、注文の失効・生効の操作、注文の削除など。 A株通市場の場合は注文変更に非対応です。注文取消は可能です。注文削除はOpenDのローカル操作です。 * **パラメータ** パラメータ|型|説明 :-|:-|:- modify_order_op|[ModifyOrderOp](./trade.md#5834)|注文変更操作タイプ order_id|str|注文番号 qty|float|注文変更後の数量 (オプションと先物の単位は「枚」です小数点以下0桁、超過分は切り捨てられます) price|float|注文変更後の価格 (証券口座は小数点以下3桁、超過分は切り捨てられます先物口座は小数点以下9桁、超過分は切り捨てられます) adjust_limit|float|価格微調整幅 (OpenD は入力された価格を自動的に有効な価格に調整します（先物ではこのパラメータは無視されます） - 正数は上方調整、負数は下方調整を示します - 例：0.015 は上方調整で幅が 1.5% 以内、-0.01 は下方調整で幅が 1% 以内。デフォルトの 0 は調整なしを示します) trd_env|[TrdEnv](./trade.md#293)|取引環境 acc_id|int|取引口座 ID (- acc_id と acc_index はどちらも取引口座の指定に使用でき、いずれか一方を選択してください。acc_id の使用を推奨します。 - acc_id に 0 を指定した場合、acc_index で指定した口座が使用されます - acc_id に ID 番号を指定した場合（0 以外）、acc_id で指定した口座が使用されます) acc_index|int|取引口座リスト内の口座インデックス (- acc_id と acc_index はどちらも取引口座の指定に使用でき、いずれか一方を選択してください。acc_id の使用を推奨します。acc_index は口座の新規開設や解約時に変動するため、指定した口座と実際の取引口座が一致しなくなる可能性があります。 - acc_index のデフォルトは 0 で、最初の取引口座を指定します) aux_price|float|トリガー価格 (- 注文がストップロス成行注文、ストップロス指値注文、トリガー指値注文（利確）、トリガー成行注文（利確）の場合、aux_price は必須パラメータです - 証券口座は小数点以下3桁、先物口座は小数点以下9桁、超過分は四捨五入されます) trail_type|[TrailType](./trade.md#9391)|トレーリングタイプ (注文がトレーリングストップロス成行注文またはトレーリングストップロス指値注文の場合、trail_type は必須パラメータ) trail_value|float|トレーリング金額/パーセント (- 注文がトレーリングストップロス成行注文、トレーリングストップロス指値注文の場合、trail_value は必須パラメータです - トレーリングタイプが比率の場合、このフィールドはパーセントフィールドで、20 を指定すると実際には 20% に対応します - トレーリングタイプが金額の場合、証券口座は小数点以下3桁、先物口座は小数点以下9桁、超過分は四捨五入されます - トレーリングタイプが比率の場合、小数点以下2桁、超過分は四捨五入されます) trail_spread|float|指定スプレッド (- 注文がトレーリングストップロス指値注文の場合、trail_spread は必須パラメータです - 証券口座は小数点以下3桁、先物口座は小数点以下9桁、超過分は四捨五入されます) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame 当 ret == RET_OK 时，返す注文変更情報
str 当 ret != RET_OK 时，返すエラー説明
* 注文変更情報フォーマットは以下の通り： フィールド|タイプ|説明 :-|:-|:- trd_env|[TrdEnv](./trade.md#293)|取引環境 order_id|str|注文番号 * **Example** ```python from moomoo import * pwd_unlock = '123456' trd_ctx = OpenSecTradeContext(filter_trdmarket=TrdMarket.US, host='127.0.0.1', port=11111, security_firm=SecurityFirm.FUTUINC) ret, data = trd_ctx.unlock_trade(pwd_unlock) # 本番口座で注文変更/取消する場合は先にロック解除が必要です。ここではデモ口座での注文取消のため、ロック解除を省略できます。 if ret == RET_OK: order_id = "8851102695472794941" ret, data = trd_ctx.modify_order(ModifyOrderOp.CANCEL, order_id, 0, 0) if ret == RET_OK: print(data) print(data['order_id'][0]) # 注文変更の注文番号を取得 print(data['order_id'].values.tolist()) # list に変換 else: print('modify_order error: ', data) else: print('unlock_trade failed: ', data) trd_ctx.close() ``` * **Output** ```python trd_env order_id 0 REAL 8851102695472794941 8851102695472794941 ['8851102695472794941'] ``` `cancel_all_order(trd_env=TrdEnv.REAL, acc_id=0, acc_index=0, trdmarket=TrdMarket.NONE)` * **概要** 全注文を取消します。デモ取引およびA株通口座では一括注文取消は現在ご利用いただけません。 * **パラメータ** パラメータ|型|説明 :-|:-|:- trd_env|[TrdEnv](./trade.md#293)|取引環境 acc_id|int|取引口座 ID (acc_id に 0 を指定した場合、acc_index で指定した口座が使用されますacc_id に ID 番号を指定した場合（0 以外）、acc_id で指定した口座が使用されます) acc_index|int|取引口座リスト内の口座インデックス (- acc_id と acc_index はどちらも取引口座の指定に使用でき、いずれか一方を選択してください。acc_id の使用を推奨します。acc_index は口座の新規開設や解約時に変動するため、指定した口座と実際の取引口座が一致しなくなる可能性があります。 - acc_index のデフォルトは 0 で、最初の取引口座を指定します) trdmarket|[TrdMarket](./trade.html#4416)|指定取引市場 (指定口座の指定市場の注文を取り消しますデフォルトの場合、指定口座のすべての市場の注文を取り消します) * **戻り値**
パラメータ 型 説明
ret str API呼び出し結果。ret == RET_OK 代表API呼び出し正常，ret != RET_OK 代表API呼び出し失败
data str 当 ret == RET_OK，返す"success"
ret != RET_OK の場合、エラーの説明を返す
* 全注文取消情報フォーマットは以下の通り： フィールド|タイプ|説明 :-|:-|:- trd_env|[TrdEnv](./trade.md#293)|取引環境 order_id|str|注文番号 * **Example** ```python from moomoo import * pwd_unlock = '123456' trd_ctx = OpenSecTradeContext(filter_trdmarket=TrdMarket.US, host='127.0.0.1', port=11111, security_firm=SecurityFirm.FUTUINC) ret, data = trd_ctx.unlock_trade(pwd_unlock) # 本番口座で注文変更/取消する場合は先にロック解除が必要です。ここではデモ口座での一括注文取消のため、ロック解除を省略できます。 if ret == RET_OK: ret, data = trd_ctx.cancel_all_order() if ret == RET_OK: print(data) else: print('cancel_all_order error: ', data) else: print('unlock_trade failed: ', data) trd_ctx.close() ``` * **Output** ```python success ``` :::tip APIレート制限 * 同一口座 ID（acc_id）につき、30秒以内に注文変更・注文取消APIを最大20回までリクエスト可能です。また、連続するリクエストの間隔は 0.04 秒以上必要です。 * 本番口座で注文変更・注文取消APIを呼び出す前に、[ロック解除](./unlock.md)が必要です。デモ口座ではロック解除は不要です。 ::: :::tip ご注意 * **注文変更**操作を実行する場合、各注文タイプに対応する必須パラメータについては[こちら](../qa/trade.html#4465)をご覧ください。 * **注文変更操作**で**注文数量を変更**する場合、このAPIの入力パラメータの注文数量 **qty** は、期待する約定の合計数量に等しくする必要があります。 例： 注文数量が N 株で、すでに n 株が一部約定済みの場合。未約定の (N-n) 株のうち x 株を取り消したい場合、**modify_order_op** は NORMAL を選択し、**qty** には (N-x) を指定してください。 ![order_quantity](../../img/order_quantity_en.png) * **注文取消操作**を実行する場合、このAPIの入力パラメータ **modify_order_op** は CANCEL を選択してください。 例： 注文数量が N 株で、すでに n 株が一部約定済みの場合。未約定の (N-n) 株をすべて取り消したい場合、modify_order_op は CANCEL を選択してください。この場合、qty と price の入力パラメータは無視されます。 ::: --- # 未完了注文の照会 `order_list_query(order_id="", order_market=TrdMarket.NONE, status_filter_list=[], code='', start='', end='', trd_env=TrdEnv.REAL, acc_id=0, acc_index=0, refresh_cache=False)` * **概要** 指定した取引口座の未完了注文リストを照会します（未処理の注文、および24時間以内に処理またはキャンセルされた注文を含む） * **パラメータ** パラメータ|型|説明 :-|:-|:- order_id|str|注文番号フィルタ (- 指定した注文番号のデータを返します - デフォルトの場合、すべてのデータを返します) order_market|[TrdMarket](./trade.md#4416)|注文銘柄の所属市場フィルタ (- 注文銘柄の市場フィルタで、該当市場の銘柄注文を返します - デフォルト値は NONE で、口座内のすべての市場の注文データを返します) status_filter_list|list|注文ステータスフィルタ (- 指定ステータスの注文データを返します - デフォルトの場合、すべてのデータを返します - リスト内の要素タイプは [OrderStatus](./trade.md#1624) です) code|str|銘柄コードフィルタ (- 指定コードのデータを返します - デフォルトの場合、すべてのデータを返します) start|str|開始時刻 (- 严格按 YYYY-MM-DD HH:MM:SS 或 YYYY-MM-DD HH:MM:SS.MS 形式传 - 先物时区指定，請を参照 [OpenD 設定](../quick/opend-base.md#8384)) end|str|結束時刻 (- 严格按 YYYY-MM-DD HH:MM:SS 或 YYYY-MM-DD HH:MM:SS.MS 形式传 - 先物时区指定，請を参照 [OpenD 設定](../quick/opend-base.md#8384)) trd_env|[TrdEnv](./trade.md#293)|取引環境 acc_id|int|取引口座 ID (- acc_id と acc_index はどちらも取引口座の指定に使用でき、いずれか一方を選択してください。acc_id の使用を推奨します。 - acc_id に 0 を指定した場合、acc_index で指定した口座が使用されます - acc_id に ID 番号を指定した場合（0 以外）、acc_id で指定した口座が使用されます) acc_index|int|取引口座リスト内の口座インデックス (- acc_id と acc_index はどちらも取引口座の指定に使用でき、いずれか一方を選択してください。acc_id の使用を推奨します。acc_index は口座の新規開設や解約時に変動するため、指定した口座と実際の取引口座が一致しなくなる可能性があります。 - acc_index のデフォルトは 0 で、最初の取引口座を指定します) refresh_cache|bool|キャッシュを更新するかどうか (- True：moomoo サーバーに即座にデータを再リクエストし、OpenD のキャッシュを使用しません。この場合、APIレート制限の対象となります - False：OpenD のキャッシュを使用します（特殊な状況でキャッシュが適時に更新されない場合にのみ更新が必要です）) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame 当 ret == RET_OK 时，返す注文リスト
str 当 ret != RET_OK 时，返すエラー説明
* 注文リストフォーマットは以下の通り： フィールド|タイプ|説明 :-|:-|:- trd_side|[TrdSide](./trade.md#9032)|取引方向 order_type|[OrderType](./trade.md#1851)|注文タイプ order_status|[OrderStatus](./trade.md#1624)|注文ステータス order_id|str|注文番号 code|str|銘柄コード stock_name|str|銘柄名 order_market|[TrdMarket](./trade.md#4416)|注文銘柄の所属市場 qty|float|注文数量 (オプション先物単位是"张") price|float|注文価格 (小数点以下3桁、超過分は四捨五入されます) currency|[Currency](./trade.md#9629)|取引通貨 create_time|str|作成時刻 (先物时区指定，請を参照 [OpenD 設定](../quick/opend-base.md#8384)) updated_time|str|最后更新時刻 (先物时区指定，請を参照 [OpenD 設定](../quick/opend-base.md#8384)) dealt_qty|float|約定数量 (オプション先物単位是"张") dealt_avg_price|float|約定平均価格 (精度制限なし) last_err_msg|str|最新のエラー説明 (エラーがある場合、最後のエラーの原因を返しますエラーがない場合、空文字列を返します) remark|str|発注時の備考識別子 (詳細は [place_order](./place-order.md) APIパラメータの remark を参照してください) time_in_force|[TimeInForce](./trade.md#6063)|有効期限 fill_outside_rth|bool|プレ/アフターマーケットを許可するかどうか（香港株プレマーケットオークションおよび米国株プレ/アフターマーケットに使用） (True：許可False：不許可) session|[Session](../quote/quote.md#7928)|取引注文時間帯（米国株にのみ使用） aux_price|float|トリガー価格 trail_type|[TrailType](./trade.md#9391)|トレーリングタイプ trail_value|float|トレーリング金额/パーセント trail_spread|float|指定価差 jp_acc_type|[SubAccType](./trade.md#2662)|日本口座タイプ (のみ対日本証券会社生效) expire_time|str|注文失効時刻 (time_in_force が GTD の場合に有効) amount|float|注文金額 strategy_type|[OptionStrategyType](../quote/quote.md#2931)|コンボ戦略タイプ combo_legs|list|コンボレッグリスト (項目説明は [place_combo_order](./place-combo-order.md) の ComboLeg 表を参照) * **Example** ```python from moomoo import * trd_ctx = OpenSecTradeContext(filter_trdmarket=TrdMarket.US, host='127.0.0.1', port=11111, security_firm=SecurityFirm.FUTUINC) ret, data = trd_ctx.order_list_query() if ret == RET_OK: print(data) if data.shape[0] > 0: # 注文リストが空でない場合 print(data['order_id'][0]) # 未完了注文の最初の注文番号を取得 print(data['order_id'].values.tolist()) # list に変換 else: print('order_list_query error: ', data) trd_ctx.close() ``` * **Output** ```python code stock_name order_amrket trd_side order_type order_status order_id qty price create_time updated_time dealt_qty dealt_avg_price last_err_msg remark time_in_force fill_outside_rth session aux_price trail_type trail_value trail_spread currency jp_acc_type 0 US.AAPL US BUY NORMAL CANCELLED_ALL 6644468615272262086 100.0 520.0 2021-09-06 10:17:52.465 2021-09-07 16:10:22.806 0.0 0.0 asdfg+=@@@ GTC N/A N/A 560 N/A N/A N/A USD N/A 6644468615272262086 ['6644468615272262086'] ``` :::tip APIレート制限 * 同一口座ID(acc_id) 每 30 秒内最多リクエスト 10 次照会未完成注文API * このAPIの呼び出しは、キャッシュを更新する場合のみレート制限の対象となります ::: :::tip ご注意 * 未完了注文は時刻の「昇順」で並べられます。つまり、先に提出した注文が先頭、後に提出した注文が末尾になります ::: --- # 過去注文の照会 `history_order_list_query(status_filter_list=[], code='', order_market=TrdMarket.NONE, start='', end='', trd_env=TrdEnv.REAL, acc_id=0, acc_index=0)` * **概要** 指定した取引口座の過去注文リストを照会します * **パラメータ** パラメータ|型|説明 :-|:-|:- status_filter_list|list|注文ステータスフィルタ (- 指定ステータスの注文データを返します - デフォルトの場合、すべてのデータを返します - リスト内の要素タイプは [OrderStatus](./trade.md#1624) です) code|str|銘柄コードフィルタ (- 指定コードのデータを返します - デフォルトの場合、すべてのデータを返します) order_market|[TrdMarket](./trade.md#4416)|注文銘柄の所属市場フィルタ (- 注文銘柄の市場フィルタで、該当市場の銘柄注文を返します - デフォルト値は NONE で、口座内のすべての市場の注文データを返します) start|str|開始時刻 (- 严格按 YYYY-MM-DD HH:MM:SS 或 YYYY-MM-DD HH:MM:SS.MS 形式传 - 先物时区指定，請を参照 [OpenD 設定](../quick/opend-base.md#8384)) end|str|結束時刻 (- 严格按 YYYY-MM-DD HH:MM:SS 或 YYYY-MM-DD HH:MM:SS.MS 形式传 - 先物时区指定，請を参照 [OpenD 設定](../quick/opend-base.md#8384)) trd_env|[TrdEnv](./trade.md#293)|取引環境 acc_id|int|取引口座 ID (- acc_id と acc_index はどちらも取引口座の指定に使用でき、いずれか一方を選択してください。acc_id の使用を推奨します。 - acc_id に 0 を指定した場合、acc_index で指定した口座が使用されます - acc_id に ID 番号を指定した場合（0 以外）、acc_id で指定した口座が使用されます) acc_index|int|取引口座リスト内の口座インデックス (- acc_id と acc_index はどちらも取引口座の指定に使用でき、いずれか一方を選択してください。acc_id の使用を推奨します。acc_index は口座の新規開設や解約時に変動するため、指定した口座と実際の取引口座が一致しなくなる可能性があります。 - acc_index のデフォルトは 0 で、最初の取引口座を指定します) * startとendの組み合わせは以下の通り Start タイプ|End タイプ|説明 :-|:-|:- str|str|start と end がそれぞれ指定された日付 None|str|start 為 end 往前 90 天 str|None|end 為 start 往后 90 天 None|None|start 為往前 90 天，end 現在の日付 * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame 当 ret == RET_OK 时，返す注文リスト
str 当 ret != RET_OK 时，返すエラー説明
* 注文リストフォーマットは以下の通り： フィールド|タイプ|説明 :-|:-|:- trd_side|[TrdSide](./trade.md#9032)|取引方向 order_type|[OrderType](./trade.md#1851)|注文タイプ order_status|[OrderStatus](./trade.md#1624)|注文ステータス order_id|str|注文番号 code|str|銘柄コード stock_name|str|銘柄名 order_market|[TrdMarket](./trade.md#4416)|注文銘柄の所属市場 qty|float|注文数量 (オプション先物単位是"张") price|float|注文価格 (小数点以下3桁、超過分は四捨五入されます) currency|[Currency](./trade.md#9629)|取引通貨 create_time|str|作成時刻 (先物时区指定，請を参照 [OpenD 設定](../quick/opend-base.md#8384)) updated_time|str|最后更新時刻 (先物时区指定，請を参照 [OpenD 設定](../quick/opend-base.md#8384)) dealt_qty|float|約定数量 (オプション先物単位是"张") dealt_avg_price|float|約定平均価格 (精度制限なし) last_err_msg|str|最新のエラー説明 (エラーがある場合、最後のエラーの原因を返しますエラーがない場合、空文字列を返します) remark|str|発注時の備考識別子 (詳細は [place_order](./place-order.md) APIパラメータの remark を参照してください) time_in_force|[TimeInForce](./trade.md#6063)|有効期限 fill_outside_rth|bool|プレ/アフターマーケットを許可するかどうか（香港株プレマーケットオークションおよび米国株プレ/アフターマーケットに使用） (True：許可False：不許可) session|[Session](../quote/quote.md#7928)|取引注文時間帯（米国株にのみ使用） aux_price|float|トリガー価格 trail_type|[TrailType](./trade.md#9391)|トレーリングタイプ trail_value|float|トレーリング金额/パーセント trail_spread|float|指定価差 jp_acc_type|[SubAccType](./trade.md#2662)|日本口座タイプ (のみ対日本証券会社生效) expire_time|str|注文失効時刻 (time_in_force が GTD の場合に有効) amount|float|注文金額 strategy_type|[OptionStrategyType](../quote/quote.md#2931)|コンボ戦略タイプ combo_legs|list|コンボレッグリスト (項目説明は [place_combo_order](./place-combo-order.md) の ComboLeg 表を参照) * **Example** ```python from moomoo import * trd_ctx = OpenSecTradeContext(filter_trdmarket=TrdMarket.HK, host='127.0.0.1', port=11111, security_firm=SecurityFirm.FUTUSECURITIES) ret, data = trd_ctx.history_order_list_query() if ret == RET_OK: print(data) if data.shape[0] > 0: # 注文リストが空でない場合 print(data['order_id'][0]) # ポジションの最初の注文番号を取得 print(data['order_id'].values.tolist()) # list に変換 else: print('history_order_list_query error: ', data) trd_ctx.close() ``` * **Output** ```python code stock_name order_market trd_side order_type order_status order_id qty price create_time updated_time dealt_qty dealt_avg_price last_err_msg remark time_in_force fill_outside_rth session aux_price trail_type trail_value trail_spread currency jp_acc_type 0 HK.00700 HK BUY NORMAL CANCELLED_ALL 6644468615272262086 100.0 520.0 2021-09-06 10:17:52.465 2021-09-07 16:10:22.806 0.0 0.0 asdfg+=@@@ GTC N/A N/A 560 N/A N/A N/A HKD N/A 6644468615272262086 ['6644468615272262086'] ``` :::tip APIレート制限 * 同一口座ID(acc_id) 每 30 秒内最多リクエスト 10 次照会過去注文API ::: :::tip ご注意 * 過去注文は時刻の「降順」で並べられます。つまり、後に提出した注文が先頭、先に提出した注文が末尾になります ::: --- # 注文プッシュレスポンスコールバック `on_recv_rsp(self, rsp_pb)` * **概要** 注文プッシュのレスポンス。OpenD からプッシュされた注文ステータス情報を非同期処理します。 OpenD からプッシュされた注文ステータス情報の受信時にこの関数がコールバックされます。派生クラスで on_recv_rsp をオーバーライドしてください。 * **パラメータ** パラメータ|型|説明 :-|:-|:- rsp_pb|Trd_UpdateOrder_pb2.Response|派生クラスでは直接処理不要 * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame 当 ret == RET_OK 时，返す注文リスト
str 当 ret != RET_OK 时，返すエラー説明
* 注文リストフォーマットは以下の通り： フィールド|タイプ|説明 :-|:-|:- trd_side|[TrdSide](./trade.md#9032)|取引方向 order_type|[OrderType](./trade.md#1851)|注文タイプ order_status|[OrderStatus](./trade.md#1624)|注文ステータス order_id|str|注文番号 code|str|銘柄コード stock_name|str|銘柄名 qty|float|注文数量 (オプション先物単位是"张") price|float|注文価格 (小数点以下3桁、超過分は四捨五入されます) currency|[Currency](./trade.md#9629)|取引通貨 create_time|str|作成時刻 (先物时区指定，請を参照 [OpenD 設定](../quick/opend-base.md#8384)) updated_time|str|最后更新時刻 (先物时区指定，請を参照 [OpenD 設定](../quick/opend-base.md#8384)) dealt_qty|float|約定数量 (オプション先物単位是"张") dealt_avg_price|float|約定平均価格 (精度制限なし) last_err_msg|str|最新のエラー説明 (エラーがある場合、最後のエラーの原因を返しますエラーがない場合、空文字列を返します) remark|str|発注時の備考識別子 (詳細は [place_order](./place-order.md) APIパラメータの remark を参照してください) time_in_force|[TimeInForce](./trade.md#6063)|有効期限 fill_outside_rth|bool|プレ/アフターマーケットを許可するかどうか（米国株にのみ使用） (True：許可False：不許可) session|[Session](../quote/quote.md#7928)|取引注文時間帯（米国株にのみ使用） aux_price|float|トリガー価格 trail_type|[TrailType](./trade.md#9391)|トレーリングタイプ trail_value|float|トレーリング金额/パーセント trail_spread|float|指定価差 expire_time|str|注文失効時刻 (time_in_force が GTD の場合に有効) amount|float|注文金額 strategy_type|[OptionStrategyType](../quote/quote.md#2931)|コンボ戦略タイプ combo_legs|list|コンボレッグリスト (項目説明は [place_combo_order](./place-combo-order.md) の ComboLeg 表を参照) * **Example** ```python from moomoo import * from time import sleep class TradeOrderTest(TradeOrderHandlerBase): """ order update push""" def on_recv_rsp(self, rsp_pb): ret, content = super(TradeOrderTest, self).on_recv_rsp(rsp_pb) if ret == RET_OK: print("* TradeOrderTest content={}\n".format(content)) return ret, content trd_ctx = OpenSecTradeContext(filter_trdmarket=TrdMarket.US, host='127.0.0.1', port=11111, security_firm=SecurityFirm.FUTUINC) trd_ctx.set_handler(TradeOrderTest()) print(trd_ctx.place_order(price=518.0, qty=100, code="US.AAPL", trd_side=TrdSide.SELL)) sleep(15) trd_ctx.close() ``` * **Output** ```python * TradeOrderTest content= trd_env code stock_name dealt_avg_price dealt_qty qty order_id order_type price order_status create_time updated_time trd_side last_err_msg trd_market remark time_in_force fill_outside_rth session aux_price trail_type trail_value trail_spread currency 0 REAL US.AAPL 苹果 0.0 0.0 100.0 72625263708670783 NORMAL 518.0 SUBMITTING 2021-11-04 11:26:27 2021-11-04 11:26:27 BUY US DAY N/A N/A N/A N/A N/A N/A USD ``` --- # 注文手数料の照会 `order_fee_query(order_id_list=[], acc_id=0, acc_index=0, trd_env=TrdEnv.REAL)` * **概要** 指定注文の手数料明細を照会します（最低バージョン要件：8.2.4218） * **パラメータ** パラメータ|型|説明 :-|:-|:- order_id_list|list|注文番号リスト (- 每次リクエスト最多照会 400 件の注文 - list 内元素タイプ為 str) trd_env|[TrdEnv](./trade.md#293)|取引環境 acc_id|int|取引口座 ID (- acc_id と acc_index はどちらも取引口座の指定に使用でき、いずれか一方を選択してください。acc_id の使用を推奨します。 - acc_id に 0 を指定した場合、acc_index で指定した口座が使用されます - acc_id に ID 番号を指定した場合（0 以外）、acc_id で指定した口座が使用されます) acc_index|int|取引口座リスト内の口座インデックス (- acc_id と acc_index はどちらも取引口座の指定に使用でき、いずれか一方を選択してください。acc_id の使用を推奨します。acc_index は口座の新規開設や解約時に変動するため、指定した口座と実際の取引口座が一致しなくなる可能性があります。 - acc_index のデフォルトは 0 で、最初の取引口座を指定します) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame 当 ret == RET_OK 时，返す注文手数料リスト
str 当 ret != RET_OK 时，返すエラー説明
* 注文リストフォーマットは以下の通り： フィールド|タイプ|説明 :-|:-|:- order_id|str|注文番号 fee_amount|float|総费用 fee_details|list|手数料明細 (- 形式：[('手数料項目1', 項目1の金額), ('手数料項目2', 項目2の金額), ('手数料項目3', 項目3の金額)……] - 一般的な手数料項目：取引手数料、プラットフォーム使用料、オプション規制料、オプション清算料、オプション決済料、決済料、証監会規制料、取引活動費) * **Example** ```python from moomoo import * trd_ctx = OpenSecTradeContext(filter_trdmarket=TrdMarket.US, host='127.0.0.1', port=11111, security_firm=SecurityFirm.FUTUINC) ret1, data1 = trd_ctx.history_order_list_query(status_filter_list=[OrderStatus.FILLED_ALL]) if ret1 == RET_OK: if data1.shape[0] > 0: # 注文リストが空でない場合 ret2, data2 = trd_ctx.order_fee_query(data1['order_id'].values.tolist()) # 注文 ID を list に変換し、注文手数料を照会 if ret2 == RET_OK: print(data2) print(data2['fee_details'][0]) # 最初の注文の手数料明細を出力 else: print('order_fee_query error: ', data2) else: print('order_list_query error: ', data1) trd_ctx.close() ``` * **Output** ```python order_id fee_amount fee_details 0 v3_20240314_12345678_MTc4NzA5NzY5OTA3ODAzMzMwN 10.46 [(佣金, 5.85), (平台使用费, 2.7), (期權监管费, 0.11), (期權清... 1 v3_20240318_12345678_MTM5Nzc5MDYxNDY1NDM1MDI1M 2.25 [(佣金, 0.99), (平台使用费, 1.0), (交收费, 0.15), (证监会规费... [('佣金', 5.85), ('平台使用费', 2.7), ('期權监管费', 0.11), ('期權清算费', 0.18), ('期權交收费', 1.62)] ``` :::tip APIレート制限 * 同一口座ID(acc_id) 每 30 秒内最多リクエスト 10 次照会注文费用API。 * 2018-01-01 以降の注文の照会にのみ対応しています。 * デモ口座不対応照会注文费用。 * 加拿大証券会社口座不対応照会注文费用。 ::: --- # 取引プッシュの登録 Pythonでは取引プッシュの登録は不要です --- # 当日約定の照会 `deal_list_query(code="", deal_market=TrdMarket.NONE, trd_env=TrdEnv.REAL, acc_id=0, acc_index=0, refresh_cache=False)` * **概要** 指定した取引口座の当日約定リストを照会します。 このAPIは本番取引のみ対応しており、デモ取引には非対応です。 * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|銘柄コードフィルタ (このコードに対応する約定データのみを返します未指定の場合はすべて返します) deal_market|[TrdMarket](./trade.md#4416)|約定銘柄の所属市場フィルタ (- 約定銘柄の市場フィルタで、該当市場の約定データを返します - デフォルト値は NONE で、口座内のすべての市場の約定データを返します) trd_env|[TrdEnv](./trade.md#293)|取引環境 (TrdEnv.REAL（本番環境）にのみ対応しています。デモ環境は現在、約定データの照会に対応していません) acc_id|int|取引口座 ID (- acc_id と acc_index はどちらも取引口座の指定に使用でき、いずれか一方を選択してください。acc_id の使用を推奨します。 - acc_id に 0 を指定した場合、acc_index で指定した口座が使用されます - acc_id に ID 番号を指定した場合（0 以外）、acc_id で指定した口座が使用されます) acc_index|int|取引口座リスト内の口座インデックス (- acc_id と acc_index はどちらも取引口座の指定に使用でき、いずれか一方を選択してください。acc_id の使用を推奨します。acc_index は口座の新規開設や解約時に変動するため、指定した口座と実際の取引口座が一致しなくなる可能性があります。 - acc_index のデフォルトは 0 で、最初の取引口座を指定します) refresh_cache|bool|キャッシュを更新するかどうか (- True：moomoo サーバーに即座にデータを再リクエストし、OpenD のキャッシュを使用しません。この場合、APIレート制限の対象となります - False：OpenD のキャッシュを使用します（特殊な状況でキャッシュが適時に更新されない場合にのみ更新が必要です）) * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame 当 ret == RET_OK 时，返す取引約定リスト
str 当 ret != RET_OK 时，返すエラー説明
* 取引約定リストフォーマットは以下の通り： フィールド|タイプ|説明 :-|:-|:- trd_side|[TrdSide](./trade.md#9032)|取引方向 deal_id|str|約定号 order_id|str|注文番号 code|str|銘柄コード stock_name|str|銘柄名 deal_market|[TrdMarket](./trade.md#4416)|約定銘柄の所属市場 qty|float|約定数量 (オプション先物単位是"张") price|float|約定価格 (小数点以下3桁、超過分は四捨五入されます) create_time|str|作成時刻 (先物时区指定，請を参照 [OpenD 設定](../quick/opend-base.md#8384)) counter_broker_id|int|対手ブローカー号 (のみ香港株有効) counter_broker_name|str|相手方ブローカー名称 (香港株のみ有効) status|[DealStatus](./trade.md#3206)|約定ステータス jp_acc_type|[SubAccType](./trade.md#2662)|日本口座タイプ (のみ対日本証券会社生效) * **Example** ```python from moomoo import * trd_ctx = OpenSecTradeContext(filter_trdmarket=TrdMarket.US, host='127.0.0.1', port=11111, security_firm=SecurityFirm.FUTUINC) ret, data = trd_ctx.deal_list_query() if ret == RET_OK: print(data) if data.shape[0] > 0: # 約定リストが空でない場合 print(data['order_id'][0]) # 当日約定の最初の注文番号を取得 print(data['order_id'].values.tolist()) # list に変換 else: print('deal_list_query error: ', data) trd_ctx.close() ``` * **Output** ```python code stock_name deal_market deal_id order_id qty price trd_side create_time counter_broker_id counter_broker_name status jp_acc_type 0 US.AAPL 苹果 US 5056208452274069375 4665291631090960915 100.0 370.0 BUY 2020-09-17 21:15:59.979 5 OK N/A 4665291631090960915 ['4665291631090960915'] ``` :::tip APIレート制限 * 同一口座ID(acc_id) 每 30 秒内最多リクエスト 10 次照会当日約定API * このAPIの呼び出しは、キャッシュを更新する場合のみレート制限の対象となります ::: :::tip ご注意 * 当日約定は時刻の「昇順」で並べられます。つまり、先に約定した記録が先頭、後に約定した記録が末尾になります ::: --- # 過去約定の照会 `history_deal_list_query(code='', deal_market=TrdMarket.NONE, start='', end='', trd_env=TrdEnv.REAL, acc_id=0, acc_index=0)` * **概要** 指定した取引口座の過去約定リストを照会します。 このAPIは本番取引のみ対応しており、デモ取引には非対応です。 * **パラメータ** パラメータ|型|説明 :-|:-|:- code|str|銘柄コードフィルタ (このコードに対応する約定データのみを返します未指定の場合はすべて返します) deal_market|[TrdMarket](./trade.md#4416)|約定銘柄の所属市場フィルタ (- 約定銘柄の市場フィルタで、該当市場の約定データを返します - デフォルト値は NONE で、口座内のすべての市場の約定データを返します) start|str|開始時刻 (- 严格按 YYYY-MM-DD HH:MM:SS 或 YYYY-MM-DD HH:MM:SS.MS 形式传 - 先物时区指定，請を参照 [OpenD 設定](../quick/opend-base.md#8384)) end|str|結束時刻 (- 严格按 YYYY-MM-DD HH:MM:SS 或 YYYY-MM-DD HH:MM:SS.MS 形式传 - 先物时区指定，請を参照 [OpenD 設定](../quick/opend-base.md#8384)) trd_env|[TrdEnv](./trade.md#293)|取引環境 (TrdEnv.REAL（本番環境）にのみ対応しています。デモ環境は現在、約定データの照会に対応していません) acc_id|int|取引口座 ID (- acc_id と acc_index はどちらも取引口座の指定に使用でき、いずれか一方を選択してください。acc_id の使用を推奨します。 - acc_id に 0 を指定した場合、acc_index で指定した口座が使用されます - acc_id に ID 番号を指定した場合（0 以外）、acc_id で指定した口座が使用されます) acc_index|int|取引口座リスト内の口座インデックス (- acc_id と acc_index はどちらも取引口座の指定に使用でき、いずれか一方を選択してください。acc_id の使用を推奨します。acc_index は口座の新規開設や解約時に変動するため、指定した口座と実際の取引口座が一致しなくなる可能性があります。 - acc_index のデフォルトは 0 で、最初の取引口座を指定します) * startとendの組み合わせは以下の通り Start タイプ|End タイプ|説明 :-|:-|:- str|str|start と end がそれぞれ指定された日付 None|str|start 為 end 往前 90 天 str|None|end 為 start 往后 90 天 None|None|start 為往前 90 天，end 現在の日付 * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame 当 ret == RET_OK 时，返す取引約定リスト
str 当 ret != RET_OK 时，返すエラー説明
* 取引約定リストフォーマットは以下の通り： フィールド|タイプ|説明 :-|:-|:- trd_side|[TrdSide](./trade.md#9032)|取引方向 deal_id|str|約定号 order_id|str|注文番号 code|str|銘柄コード stock_name|str|銘柄名 deal_market|[TrdMarket](./trade.md#4416)|約定銘柄の所属市場 qty|float|約定数量 (オプション先物単位是"张") price|float|約定価格 (小数点以下3桁、超過分は四捨五入されます) create_time|str|作成時刻 (先物时区指定，請を参照 [OpenD 設定](../quick/opend-base.md#8384)) counter_broker_id|int|対手ブローカー号 (のみ香港株有効) counter_broker_name|str|相手方ブローカー名称 (香港株のみ有効) status|[DealStatus](./trade.md#3206)|約定ステータス jp_acc_type|[SubAccType](./trade.md#2662)|日本口座タイプ (のみ対日本証券会社生效) * **Example** ```python from moomoo import * trd_ctx = OpenSecTradeContext(filter_trdmarket=TrdMarket.US, host='127.0.0.1', port=11111, security_firm=SecurityFirm.FUTUINC) ret, data = trd_ctx.history_deal_list_query() if ret == RET_OK: print(data) if data.shape[0] > 0: # 約定リストが空でない場合 print(data['deal_id'][0]) # 過去約定の最初の約定番号を取得 print(data['deal_id'].values.tolist()) # list に変換 else: print('history_deal_list_query error: ', data) trd_ctx.close() ``` * **Output** ```python code stock_name deal_market deal_id order_id qty price trd_side create_time counter_broker_id counter_broker_name status jp_acc_type 0 US.AAPL 苹果 US 5056208452274069375 4665291631090960915 100.0 370.0 BUY 2020-09-17 21:15:59.979 5 OK N/A 5056208452274069375 ['5056208452274069375'] ``` :::tip APIレート制限 * 同一口座ID(acc_id) 每 30 秒内最多リクエスト 10 次照会過去約定API ::: :::tip ご注意 * 過去約定は時刻の「降順」で並べられます。つまり、後に約定した記録が先頭、先に約定した記録が末尾になります ::: --- # 約定プッシュレスポンスコールバック `on_recv_rsp(self, rsp_pb)` * **概要** 約定プッシュのレスポンス。OpenD からプッシュされた約定ステータス情報を非同期処理します。 OpenD からプッシュされた約定ステータス情報の受信時にこの関数がコールバックされます。派生クラスで on_recv_rsp をオーバーライドしてください。 このAPIは本番取引のみ対応しており、デモ取引には非対応です。 * **パラメータ** パラメータ|型|説明 :-|:-|:- rsp_pb|Trd_UpdateOrderFill_pb2.Response|派生クラスでは直接処理不要 * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data pd.DataFrame 当 ret == RET_OK 时，返す取引約定リスト
str 当 ret != RET_OK 时，返すエラー説明
* 取引約定リストフォーマットは以下の通り： フィールド|タイプ|説明 :-|:-|:- trd_side|[TrdSide](./trade.md#9032)|取引方向 deal_id|str|約定号 order_id|str|注文番号 code|str|銘柄コード stock_name|str|銘柄名 qty|float|約定数量 (オプション先物単位是"张") price|float|約定価格 create_time|str|作成時刻 (先物时区指定，請を参照 [OpenD 設定](../quick/opend-base.md#8384)) counter_broker_id|int|対手ブローカー号 (のみ香港株有効) counter_broker_name|str|相手方ブローカー名称 (香港株のみ有効) status|[DealStatus](./trade.md#3206)|約定ステータス * **Example** ```python from moomoo import * from time import sleep class TradeDealTest(TradeDealHandlerBase): """ order update push""" def on_recv_rsp(self, rsp_pb): ret, content = super(TradeDealTest, self).on_recv_rsp(rsp_pb) if ret == RET_OK: print("TradeDealTest content={}".format(content)) return ret, content trd_ctx = OpenSecTradeContext(filter_trdmarket=TrdMarket.US, host='127.0.0.1', port=11111, security_firm=SecurityFirm.FUTUINC) trd_ctx.set_handler(TradeDealTest()) print(trd_ctx.place_order(price=595.0, qty=100, code="US.AAPL", trd_side=TrdSide.BUY)) sleep(15) trd_ctx.close() ``` * **Output** ```python TradeDealTest content= trd_env code stock_name deal_id order_id qty price trd_side create_time counter_broker_id counter_broker_name trd_market status 0 REAL US.AAPL 苹果 2511067564122483295 8561504228375901919 100.0 518.0 BUY 2021-11-04 11:29:41.595 5 5 US OK ``` --- # 取引定義 ## 口座リスク管理ステータス > **CltRiskLevel** * `NONE` 不明 * `SAFE` 安全 * `WARNING` 警告 * `DANGER` 危険 * `ABSOLUTE_SAFE` 絶対安全 * `OPT_DANGER` 危険 (オプション関連) :::tip ご注意 * 先物口座のリスクステータスを照会する場合、risk_status フィールドの使用を推奨します。返される結果の詳細は [CltRiskStatus](./trade.md#5056) を参照してください ::: ## 通貨タイプ > **Currency** * `NONE` 不明な通貨 * `HKD` 香港ドル * `USD` 米ドル * `CNH` オフショア人民元 * `JPY` 日本円 * `SGD` シンガポールドル * `AUD` 豪ドル * `CAD` カナダドル * `MYR` マレーシアリンギット ## トレーリングタイプ **TrailType** * `NONE` 不明 * `RATIO` 比率 * `AMOUNT` 金額 ## 注文変更操作 > **ModifyOrderOp** * `NONE` 不明な操作 * `NORMAL` 注文変更 * `CANCEL` 注文取消 (未約定の注文は取引所のマッチングキューから直接取り消されます) * `DISABLE` 無効化 (- 注文を無効化することを指します。取引所にとって、DISABLE の効果は CANCEL と同等です。 - 注文が「無効化」されると、未約定の注文は取引所のマッチングキューから直ちに取り下げられますが、注文情報（価格や数量など）は moomoo サーバーに引き続き保持され、いつでも再度 ENABLE できます。) * `ENABLE` 有効化 (- 無効化ステータスの注文を再度有効化することを指します。取引所にとって、ENABLE は新規注文の発注と同等です。 - 注文が再度「有効化」されると、元の価格・数量で取引所に再提出され、価格優先・時間優先の順序で再度キューに入ります。) * `DELETE` 削除 (取消済み/発注失敗の注文を非表示にする操作を指します。) ## 約定ステータス > **DealStatus** * `OK` 正常 * `CANCELLED` 約定取消済み * `CHANGED` 約定変更済み ## 注文ステータス > **OrderStatus** * `NONE` 不明なステータス * `WAITING_SUBMIT` 提出待ち (moomoo サーバーが注文指示を受領し、上流の取引所への提出を準備中です) * `SUBMITTING` 送信中 (moomooサーバーが上流の取引所に指令を送信済み、取引所で処理中です) * `SUBMITTED` 提出済み、約定待ち (上流の取引所への提出が完了しました) * `FILLED_PART` 一部約定 (残りの一部はまだ取消されていません。注文取消を実行するか、すべて約定するまで待つことができます) * `FILLED_ALL` すべて約定済み * `CANCELLED_PART` 一部約定、残りは注文取消済み * `CANCELLED_ALL` すべて注文取消済み、約定なし * `FAILED` 発注失敗、サーバー拒否 * `DISABLED` 無効化済み (無効化操作を実行した後の注文ステータスです。無効化された注文は上流の取引所に提出されません) * `DELETED` 削除済み（約定のない注文のみ削除可能） (削除操作を実行した後の注文ステータスです) ## 注文タイプ :::tip ご注意 * [本番取引における各品目に対応する注文タイプ](../qa/trade.md#3623) * デモ取引では、指値注文(NORMAL)と成行注文(MARKET)のみ対応しています。 ::: > **OrderType** * `NONE` 不明なタイプ * `NORMAL` 指値注文 * `MARKET` 成行注文 * `ABSOLUTE_LIMIT` 絶対指値注文 (価格が完全に一致した場合のみ約定し、それ以外は発注失敗となります - 例：5元の絶対指値買い注文を出した場合、売り手の価格も5元でなければ約定しません。売り手が5元未満でも約定せず、発注失敗となります。売りも同様です) * `AUCTION` オークション成行注文 (香港株のプレマーケットオークションおよびクロージングオークションでのみ有効) * `AUCTION_LIMIT` オークション指値注文 (プレマーケットオークションおよびクロージングオークションでのみ有効。オークションに参加し、指定価格を満たす場合のみ約定) * `SPECIAL_LIMIT` 特別指値注文 (約定ルールは増強指値注文と同じ。一部約定後、取引所が自動的に注文を取り消す) * `SPECIAL_LIMIT_ALL` 特別指値全量約定注文 (すべて約定しない場合、自動的に注文取消されます) * `STOP` ストップロス成行注文 * `STOP_LIMIT` ストップロス指値注文 * `MARKET_IF_TOUCHED` トリガー成行注文（利確） * `LIMIT_IF_TOUCHED` トリガー指値注文（利確） * `TRAILING_STOP` トレーリングストップ成行注文 * `TRAILING_STOP_LIMIT` トレーリングストップ指値注文 * `TWAP_LIMIT ` 時間加重指値アルゴリズム注文（香港株および米国株） (アルゴリズム注文は注文照会のみ対応、取引には非対応。) * `TWAP` 時間加重成行アルゴリズム注文（米国株のみ） (アルゴリズム注文は注文照会のみ対応、取引には非対応。) * `VWAP_LIMIT ` 出来高加重指値アルゴリズム注文（香港株および米国株） (アルゴリズム注文は注文照会のみ対応、取引には非対応。) * `VWAP ` 出来高加重成行アルゴリズム注文（米国株のみ） (アルゴリズム注文は注文照会のみ対応、取引には非対応。) ## ポジション方向 > **PositionSide** * `NONE` 不明な方向 * `LONG` ロングポジション (デフォルトはロングポジションです) * `SHORT` ショートポジション ## オプションコンボポジションタイプ > **PositionType** * `NONE` 不明 * `COMBINED` コンボ集計ポジション * `LEG` 単一レッグポジション ## 口座タイプ > **TrdAccType** * `NONE` 不明なタイプ * `CASH` 現金口座 * `MARGIN` 保証金口座 * `TFSA` カナダ非課税口座 * `RRSP` カナダ登録退職口座 * `SRRSP` カナダ配偶者退職口座 * `DERIVATIVE` 日本デリバティブ口座 ## 取引環境 > **TrdEnv** * `SIMULATE` デモ環境 * `REAL` 本番環境 ## 取引市場 > **TrdMarket** * `NONE` 不明な市場 * `HK` 香港市場 * `US` 米国市場 * `CN` A株市場 (A株市場はデモ取引のみ対応、本番取引には非対応) * `HKCC` 香港 A株コネクト市場 (- A株コネクト市場は本番取引にのみ対応しており、デモ取引には対応していません - A株コネクトでは上海・深圳ストックコネクト対象株式のみ取引可能です。詳細は香港取引所の [A株コネクト対象銘柄一覧](https://www.hkex.com.hk/mutual-market/stock-connect/eligible-stocks/view-all-eligible-securities?sc_lang=zh-HK) を参照してください) * `FUTURES` 先物市場 * `FUTURES_SIMULATE_US` 美国先物デモ市場 (最低OpenDバージョン要件：7.7.3908) * `FUTURES_SIMULATE_HK` 香港先物デモ市場 (最低OpenDバージョン要件：7.7.3908) * `FUTURES_SIMULATE_SG` 新加坡先物デモ市場 (最低OpenDバージョン要件：7.7.3908) * `FUTURES_SIMULATE_JP` 日本先物デモ市場 (最低OpenDバージョン要件：7.7.3908) * `HKFUND` 香港基金市場 (最低OpenDバージョン要件：8.2.4218) * `USFUND` 美国基金市場 (最低OpenDバージョン要件：8.2.4218) * `SG` 新加坡市場 (最低OpenDバージョン要件：9.0.5008) * `JP` 日本市場 (最低OpenDバージョン要件：9.0.5008) * `AU` 澳大利亚市場 (最低OpenDバージョン要件：9.0.5008) * `MY` マレーシア市場 (最低OpenDバージョン要件：9.0.5008) * `CA` 加拿大市場 (最低OpenDバージョン要件：9.0.5008) ## 口座ステータス > **TrdAccStatus** * `ACTIVE` 有効口座 * `DISABLED` 無効口座 ## 口座構成 > **TrdAccRole** * `NONE` 不明 * `MASTER` マスター口座 * `NORMAL` 通常口座 * `IPO` マレーシアIPO口座 ## 取引証券市場 ## 取引方向 > **TrdSide** * `NONE` 不明な方向 * `BUY` 買い * `SELL` 売り * `SELL_SHORT` 空売り (- 日本の証券会社に適用されます - その他の証券会社では注文リストの表示にのみ使用され、発注の方向としての使用は推奨されません) * `BUY_BACK` 買い戻し (- 日本の証券会社に適用されます - その他の証券会社では注文リストの表示にのみ使用され、発注の方向としての使用は推奨されません) :::tip ご注意 **発注** APIの取引方向は、`買い` と `売り` の2つの方向のみを入力パラメータとして使用することを推奨します。 `空売り` と `買い戻し` は日本の証券会社にのみ適用されます。その他の証券会社では、**今日の注文照会**、**過去の注文照会**、**注文プッシュコールバック**、**当日約定照会**、**過去約定照会**、**約定プッシュコールバック** APIの返却フィールド表示にのみ使用されます。 ::: ## 注文有効期間 > **TimeInForce** * `DAY` 当日有効 * `GTC` 注文取消まで有効 * `IOC` 即時執行、さもなければキャンセル (暗号通貨の成行注文にのみ適用) * `GTD` GTD(期間指定) ## 口座所属証券会社 > **SecurityFirm** * `NONE` 不明 * `FUTUSECURITIES` moomoo証券（香港） * `FUTUINC` moomoo証券（米国） * `FUTUSG` moomoo証券（シンガポール） * `FUTUAU` moomoo証券（オーストラリア） * `FUTUCA` moomoo証券（カナダ） * `FUTUMY` moomoo証券（マレーシア） * `FUTUJP` moomoo証券（日本） ## デモ取引口座タイプ **SimAccType** * `NONE` 不明 * `STOCK` 株式デモ口座 * `OPTION` オプションデモ口座 * `FUTURES` 先物デモ口座 * `STOCK_AND_OPTION` 米国株式信用取引シミュレーション口座 ## リスクステータス > **CltRiskStatus** * `NONE` 不明 * `LEVEL1` 非常に安全 * `LEVEL2` 安全 * `LEVEL3` 比較的安全 * `LEVEL4` 比較的低リスク * `LEVEL5` 中程度リスク * `LEVEL6` やや高リスク * `LEVEL7` 警告 * `LEVEL8` 危険 * `LEVEL9` 危険 ## ポジション限度額ステータス > **ExposureLevel** * `NONE` 不明 * `NORMAL` 正常 (残り限度額/ポジション限度額 > 10%、仮想資産の購入が可能) * `NEAR_LIMIT` 間もなく上限 (10% >= 残り限度額/ポジション限度額 > 0%、残り限度額に注意が必要) * `RESTRICTED` 制限中 (残り限度額/ポジション限度額 = 0%、仮想資産の購入が禁止されています) * `SAFE` 安全 (ローン含み株式価値 >= 初期証拠金要件、リスクなし) * `MODERATE` 適度 (残り流動性 >= 10% * ローン含み株式価値、レバレッジ取引あり、リスク小) * `WARNING` 警告 (残り流動性 < 10% * ローン含み株式価値、リスク増大の可能性) * `MARGIN_CALL` マージンコール (ローン含み株式価値 <= 維持証拠金要件) ## デイトレード制限状況 > **DtStatus** * `NONE` 不明 * `Unlimited` 無制限 (現在、無制限にデイトレードが可能です。残りのデイトレード購買力にご注意ください) * `EM_Call` EM-Call (現在のステータスでは新規ポジションを建てられません。純資産を $25,000 以上に補充する必要があります。補充しない場合、90日間新規ポジションの建立が禁止されます) * `DT_Call` DT-Call (現在のステータスでは未補填のデイトレード追加証拠金（DT Call）があります。5営業日以内に十分な入金で DT Call を補填する必要があります。補填しない場合、十分な資金が入金されるまで新規ポジションの建立が禁止されます) ## キャッシュフロー方向 > **CashFlowDirection** * `NONE` 不明 * `IN` キャッシュ流入 * `OUT` キャッシュ流出 ## 日本サブ口座タイプ > **SubAccType** * `NONE` 不明 * `JP_GENERAL` 一般-Long * `JP_TOKUTEI` 特定-Long * `JP_NISA_GENERAL` 一般NISA * `JP_NISA_TSUMITATE` つみたてNISA * `JP_GENERAL_SHORT` 一般-Short * `JP_TOKUTEI_SHORT` 特定-Short * `JP_HONPO_GENERAL` 国内信用取引担保品-一般 * `JP_GAIKOKU_GENERAL` 外国信用取引担保品-一般 * `JP_HONPO_TOKUTEI` 国内信用取引担保品-特定 * `JP_GAIKOKU_TOKUTEI` 外国信用取引担保品-特定 * `JP_DERIVATIVE_LONG` デリバティブサブ口座-Long * `JP_DERIVATIVE_SHORT` デリバティブサブ口座-Short * `JP_HONPO_DERIVATIVE_GENERAL` 国内デリバティブ証拠金サブ口座-一般 * `JP_GAIKOKU_DERIVATIVE_GENERAL` 外国デリバティブ証拠金サブ口座-一般 * `JP_HONPO_DERIVATIVE_TOKUTEI` 国内デリバティブ証拠金サブ口座-特定 * `JP_GAIKOKU_DERIVATIVE_TOKUTEI` 外国デリバティブ証拠金サブ口座-特定 ## 資産クラス > **AssetCategory** * `NONE` 不明 * `JP` 国内 * `US` 外国 ## 取引カテゴリ **TrdCategory** ```protobuf enum TrdCategory { TrdCategory_Unknown = 0; //不明なカテゴリ TrdCategory_Security = 1; //銘柄 TrdCategory_Future = 2; //先物 } ``` ## 口座現金情報 **AccCashInfo** ```protobuf message AccCashInfo { optional int32 currency = 1; // 通貨タイプ。Currency を参照 optional double cash = 2; // 現金残高 optional double availableBalance = 3; // 出金可能額 optional double netCashPower = 4; // 現金購買力 } ``` ## 市場別資産情報 **AccMarketInfo** ```protobuf message AccCashInfo { optional int32 trdMarket = 1; // 取引市場, を参照TrdMarketの列挙定義 optional double assets = 2; // 市場別資産情報 } ``` ## 取引プロトコル共通パラメータヘッダー **TrdHeader** ```protobuf message TrdHeader { required int32 trdEnv = 1; //取引環境, を参照 TrdEnv の列挙定義 required uint64 accID = 2; //取引口座番号。取引口座番号は取引環境および市場権限と一致する必要があり、一致しない場合はエラーが返されます required int32 trdMarket = 3; //取引市場, を参照 TrdMarket の列挙定義 optional int32 jpAccType = 4; //日本サブ口座タイプ。TrdSubAccType を参照 } ``` ## 取引口座 **TrdAcc** ```protobuf message TrdAcc { required int32 trdEnv = 1; //取引環境，を参照 TrdEnv の列挙定義 required uint64 accID = 2; //取引口座番号 repeated int32 trdMarketAuthList = 3; //業務口座に対応する取引市場権限（この口座で取引可能な市場）。複数の取引市場権限を持つことが可能ですが、現在は1つのみ。値は TrdMarket の列挙定義を参照 optional int32 accType = 4; //口座タイプ。TrdAccType を参照 optional string cardNum = 5; //カード番号 optional int32 securityFirm = 6; //所属証券会社。SecurityFirm を参照 optional int32 simAccType = 7; //デモ取引口座タイプ。SimAccType を参照 optional string uniCardNum = 8; //所属総合口座カード番号 optional int32 accStatus = 9; //口座ステータス。TrdAccStatus を参照 optional int32 accRole = 10; //口座分類（マスター口座かどうか）。TrdAccRole を参照 repeated int32 jpAccType = 11; //日本サブ口座タイプ。TrdSubAccType を参照 } ``` ## 口座資金 **Funds** ```protobuf message Funds { required double power = 1; //最大購買力（このフィールドは 50% の信用買い初期証拠金率に基づいて算出された近似値。ただし実際には銘柄ごとに信用買い初期証拠金率が異なります。実際に購入可能な最大数量を判断するには、最大売買可能数量照会 API が返す最大購入可能数フィールドの使用を推奨） required double totalAssets = 2; //純資産 required double cash = 3; //現金（単一通貨口座でのみこのフィールドを使用。総合口座では cashInfoList を使用して通貨別の現金を取得してください） required double marketVal = 4; //証券時価, のみ証券口座適用 required double frozenCash = 5; //凍結資金 required double debtCash = 6; //利息計算金額 required double avlWithdrawalCash = 7; //出金可能現金（単一通貨口座でのみこのフィールドを使用。総合口座では cashInfoList を使用して通貨別の出金可能現金を取得してください） optional int32 currency = 8; //通貨。本構造体の資金関連の通貨タイプ。値は Currency を参照。先物口座と総合証券口座に適用 optional double availableFunds = 9; //利用可能資金、先物に適用 optional double unrealizedPL = 10; //未実現損益、先物に適用 optional double realizedPL = 11; //実現済み損益、先物に適用 optional int32 riskLevel = 12; //リスク管理ステータス。CltRiskLevel を参照。先物に適用。証券口座と先物口座のリスクステータスは riskStatus フィールドで統一的に取得することを推奨 optional double initialMargin = 13; //初期証拠金 optional double maintenanceMargin = 14; //維持証拠金 repeated AccCashInfo cashInfoList = 15; //通貨別の現金、出金可能現金、現金購買力（総合口座にのみ適用） optional double maxPowerShort = 16; //空売り購買力（このフィールドは 60% の信用売り証拠金率に基づいて算出された近似値。ただし実際には銘柄ごとに信用売り証拠金率が異なります。実際に空売り可能な最大数量を判断するには、最大売買可能数量照会 API が返す空売り可能数フィールドの使用を推奨） optional double netCashPower = 17; //現金購買力（単一通貨口座でのみこのフィールドを使用。総合口座では cashInfoList を使用して通貨別の現金購買力を取得してください） optional double longMv = 18; //ロング時価 optional double shortMv = 19; //ショート時価 optional double pendingAsset = 20; //在途資産 optional double maxWithdrawal = 21; //信用買い可提，のみ証券口座適用 optional int32 riskStatus = 22; //リスクステータス，を参照 CltRiskStatus，共分 9 個レベル，LEVEL1是最安全，LEVEL9是最危险 optional double marginCallMargin = 23; // Margin Call 保証金 optional bool isPdt = 24; //是否PDT口座，のみmoomoo証券(美国)口座適用 optional string pdtSeq = 25; //残りデイトレード回数。PDT として指定された moomoo 証券（米国）口座にのみ適用 optional double beginningDTBP = 26; //初期デイトレード購買力。PDT として指定された moomoo 証券（米国）口座にのみ適用 optional double remainingDTBP = 27; //残りデイトレード購買力。PDT として指定された moomoo 証券（米国）口座にのみ適用 optional double dtCallAmount = 28; //デイトレード未払い金額。PDT として指定された moomoo 証券（米国）口座にのみ適用 optional int32 dtStatus = 29; //デイトレード制限状況。値は DTStatus を参照。PDT として指定された moomoo 証券（米国）口座にのみ適用 optional double securitiesAssets = 30; // 証券資産純資産 optional double fundAssets = 31; // 基金資産純資産 optional double bondAssets = 32; // 债券資産純資産 repeated AccMarketInfo marketInfoList = 33; //市場別資産情報 } ``` ## 口座ポジション **Position** ```protobuf message Position { required uint64 positionID = 1; //ポジション ID。ポジションの一意識別子 required int32 positionSide = 2; //ポジション方向。PositionSide の列挙定義を参照 required string code = 3; //コード required string name = 4; //名前 required double qty = 5; //保有数量、小数点以下2桁精度、オプションの単位は「枚」、以下同様 required double canSellQty = 6; //売却可能数量。保有しているうち決済可能な数量を指す。売却可能数量 = 保有数量 - 凍結数量。オプションと先物の単位は「枚」。 required double price = 7; //市場価格、小数点以下3桁精度、先物は2桁精度 optional double costPrice = 8; //希薄化取得原価（証券口座）、平均建値（先物口座）。証券は精度制限なし、先物は2桁精度。未送信の場合、この値は無効 required double val = 9; //時価、小数点以下3桁精度、先物はこのフィールド値が0 required double plVal = 10; //損益金額、小数点以下3桁精度、先物は2桁精度 optional double plRatio = 11; //損益率（平均取得原価モード）。精度制限なし。未送信の場合、この値は無効 optional int32 secMarket = 12; //証券所属市場，を参照 TrdSecMarket の列挙定義 //以下はこのポジションの本日の統計 optional double td_plVal = 21; //今日の損益金額、小数点以下3桁精度、以下同様、先物は2桁精度 optional double td_trdVal = 22; //今日の取引額、先物は非適用 optional double td_buyVal = 23; //今日の買い総額、先物は非適用 optional double td_buyQty = 24; //今日の買い総数量、先物は非適用 optional double td_sellVal = 25; //今日の売り総額、先物は非適用 optional double td_sellQty = 26; //今日の売り総数量、先物は非適用 optional double unrealizedPL = 28; //未実現損益（先物口座のみ適用） optional double realizedPL = 29; //実現済み損益（先物口座のみ適用） optional int32 currency = 30; // 通貨タイプ。Currency を参照 optional int32 trdMarket = 31; //取引市場, を参照 TrdMarket の列挙定義 optional double dilutedCostPrice = 32; //希薄化取得原価。証券口座でのみ使用可能 optional double averageCostPrice = 33; //平均取得原価、デモ取引の証券口座には非適用 optional double averagePlRatio = 34; //損益率（平均取得原価モード）。精度制限なし。未送信の場合、この値は無効 optional uint64 comboID = 35; //オプションコンボ ID optional int32 strategyType = 36; //オプション戦略タイプ。Qot_Common.OptionStrategyType を参照 optional int32 positionType = 37; //オプションコンボポジションタイプ。PositionType を参照 optional uint64 accID = 38; //取引口座 ID optional int32 jpAccType = 39; //日本サブ口座タイプ。TrdSubAccType を参照 } ``` ## 注文 **Order** ```protobuf message Order { required int32 trdSide = 1; //取引方向。TrdSide の列挙定義を参照 required int32 orderType = 2; //注文タイプ, を参照 OrderType の列挙定義 required int32 orderStatus = 3; //注文ステータス, を参照 OrderStatus の列挙定義 required uint64 orderID = 4; //注文番号 required string orderIDEx = 5; //拡張注文番号（問題調査時のみ使用） required string code = 6; //コード required string name = 7; //名前 required double qty = 8; //注文数量、小数点以下2桁精度、オプション単位は「枚」 optional double price = 9; //注文価格。3桁精度 required string createTime = 10; //作成日時。YYYY-MM-DD HH:MM:SS または YYYY-MM-DD HH:MM:SS.MS 形式 required string updateTime = 11; //最終更新日時。YYYY-MM-DD HH:MM:SS または YYYY-MM-DD HH:MM:SS.MS 形式 optional double fillQty = 12; //約定数量、小数点以下2桁精度、オプション単位は「枚」 optional double fillAvgPrice = 13; //約定平均価格。精度制限なし optional string lastErrMsg = 14; //最後のエラー説明。エラーがある場合は最後のエラー原因を返す。エラーなしの場合は空 optional int32 secMarket = 15; //証券所属市場，を参照 TrdSecMarket の列挙定義 optional double createTimestamp = 16; //作成タイムスタンプ optional double updateTimestamp = 17; //最終更新タイムスタンプ optional string remark = 18; //ユーザー備考文字列。最大長64バイト optional double auxPrice = 21; //トリガー価格 optional int32 trailType = 22; //トレーリングタイプ, を参照Trd_Common.TrailTypeの列挙定義 optional double trailValue = 23; //トレーリング金額/パーセント optional double trailSpread = 24; //指定スプレッド optional int32 currency = 25; // 通貨タイプ。Currency を参照 optional int32 trdMarket = 26; //取引市場, を参照TrdMarketの列挙定義 optional int32 session = 27; //米国株注文時間帯、Common.Session の列挙定義を参照 optional int32 jpAccType = 28; //日本サブ口座タイプ。TrdSubAccType を参照 optional string expireTime = 29; //timeInForce が GTD の場合、注文有効期限を示す optional double orderAmount = 30; // 注文金額 optional int32 strategyType = 31; // オプション戦略タイプ。Qot_Common.OptionStrategyType を参照 repeated Qot_Common.ComboLeg comboLegs = 32; //コンボオプションの各レッグデータ } ``` ## 注文手数料項目 **OrderFeeItem** ```protobuf message OrderFeeItem { optional string title = 1; //手数料名 optional double value = 2; //手数料金額 } ``` ## 注文手数料 **OrderFee** ```protobuf message OrderFee { required string orderIDEx = 1; //拡張注文番号 optional double feeAmount = 2; //手数料合計 repeated OrderFeeItem feeList = 3; //手数料明細 } ``` ## 約定 **OrderFill** ```protobuf message OrderFill { required int32 trdSide = 1; //取引方向。TrdSide の列挙定義を参照 required uint64 fillID = 2; //約定番号 required string fillIDEx = 3; //拡張約定番号（問題調査時のみ使用） optional uint64 orderID = 4; //注文番号 optional string orderIDEx = 5; //拡張注文番号（問題調査時のみ使用） required string code = 6; //コード required string name = 7; //名前 required double qty = 8; //約定数量、小数点以下2桁精度、オプション単位は「枚」 required double price = 9; //約定価格。3桁精度 required string createTime = 10; //作成日時（約定日時）。YYYY-MM-DD HH:MM:SS または YYYY-MM-DD HH:MM:SS.MS 形式 optional int32 counterBrokerID = 11; //相手方ブローカー番号、香港株のみ有効 optional string counterBrokerName = 12; //相手方ブローカー名称、香港株のみ有効 optional int32 secMarket = 13; //証券所属市場，を参照 TrdSecMarket の列挙定義 optional double createTimestamp = 14; //作成タイムスタンプ optional double updateTimestamp = 15; //最終更新タイムスタンプ optional int32 status = 16; //約定ステータス, を参照 OrderFillStatus の列挙定義 optional int32 trdMarket = 17; //取引市場, を参照TrdMarketの列挙定義 optional int32 jpAccType = 18; //日本サブ口座タイプ。TrdSubAccType を参照 } ``` ## 最大取引可能数量 **MaxTrdQtys** ```protobuf message MaxTrdQtys { //現在のサーバー実装上の制約により、空売りはまずロングポジションを売却してから空売りする必要があり、2ステップに分けて売る形になります。買い戻しも同様に逆方向の2ステップです。一方、買い（ロング）は現金と信用買いを合わせて1ステップで購入可能です。この違いにご注意ください required double maxCashBuy = 1; //現金購入可能数（オプションの単位は「枚」、先物口座には適用なし） optional double maxCashAndMarginBuy = 2; //最大購入可能数（オプションの単位は「枚」、先物口座には適用なし） required double maxPositionSell = 3; //ポジション売却可能数（オプションの単位は「枚」） optional double maxSellShort = 4; //空売り可能数（オプションの単位は「枚」、先物口座には適用なし） optional double maxBuyBack = 5; //決済に必要な買い戻し数（ネットショートポジション保有時は、ショートポジションの株数を先に買い戻してからでないと追加の買い注文を出せません。先物・オプションの単位は「枚」） optional double longRequiredIM = 6; //1枚の買い注文による初期証拠金変動額。先物とオプションにのみ適用。ポジションなし：買い1枚の初期証拠金占有額（正数）を返す。ロングポジションあり：買い1枚の初期証拠金占有額（正数）を返す。ショートポジションあり：買い戻し1枚の初期証拠金解放額（負数）を返す。 optional double shortRequiredIM = 7; //1枚の売り注文による初期証拠金変動額。先物とオプションにのみ適用。ポジションなし：空売り1枚の初期証拠金占有額（正数）を返す。ロングポジションあり：売り1枚の初期証拠金解放額（正数）を返す。ショートポジションあり：空売り1枚の初期証拠金占有額（正数）を返す。 } ``` ## コンボ取引可能情報 **ComboMaxTrdQtys** ```protobuf message ComboMaxTrdQtys { optional double nlvChange = 1; //総純資産変動 optional double initialMarginChange = 2; //初期証拠金変動 optional double maintenanceMarginChange = 3; //維持証拠金変動 optional double optionBuyPower = 4; //オプション購買力 optional double maxWithDrawChange = 5; //最大出金可能額変動 optional double buyPowerDecrease = 6; //購買力消費 } ``` ## コンボレッグ **ComboLeg** ```protobuf message ComboLeg { required Qot_Common.Security security = 1; //株式/オプション optional int32 side = 2; //方向、Trd_Common.TrdSide を参照 optional double qtyRatio = 3; //数量比率 optional uint64 positionID = 4; //ポジションID、moomoo JP 決済時のみ } ``` ## キャッシュフローデータ **FlowSummaryInfo** ```protobuf message FlowSummaryInfo { optional string clearingDate = 1; //清算日付 optional string settlementDate = 2; //決済日付 optional int32 currency = 3; //通貨 optional string cashFlowType = 4; //キャッシュフロータイプ optional int32 cashFlowDirection = 5; //キャッシュフロー方向 TrdCashFlowDirection optional double cashFlowAmount = 6; //金額 optional string cashFlowRemark = 7; //備考 optional uint64 cashFlowID = 8; //キャッシュフロー ID } ``` ## フィルタ条件 **TrdFilterConditions** ```protobuf message TrdFilterConditions { repeated string codeList = 1; //銘柄コードフィルタ。指定した銘柄のデータのみ返す。未入力の場合はフィルタなし repeated uint64 idList = 2; //ID プライマリキーフィルタ。これらの ID を含むデータのみを返す。未指定の場合はフィルタなし。注文は orderID、約定は fillID、ポジションは positionID optional string beginTime = 3; //開始日時。YYYY-MM-DD HH:MM:SS または YYYY-MM-DD HH:MM:SS.MS 形式。ポジションには無効。過去データ取得時は必須 optional string endTime = 4; //終了日時。YYYY-MM-DD HH:MM:SS または YYYY-MM-DD HH:MM:SS.MS 形式。ポジションには無効。過去データ取得時は必須 repeated string orderIDExList = 5; // サーバー注文IDリスト。orderID リストの代わりに使用可能。いずれか一方を選択 optional int32 filterMarket = 6; //指定取引市場, を参照TrdMarketの列挙定義 } ``` --- # 基本機能 ## API情報の設定 `set_client_info(client_id, client_ver)` * **概要** API呼び出し情報の設定。任意呼び出しAPI * **パラメータ** - client_id: クライアントの識別子 - client_ver: クライアントのバージョン番号 * **Example** ```python from moomoo import * SysConfig.set_client_info("MymoomooAPI", 0) quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) quote_ctx.close() ``` ## プロトコル形式の設定 `set_proto_fmt(proto_fmt)` * **概要** 通信プロトコル body の形式を設定。現在 Protobuf|Json の2形式をサポート。デフォルトは ProtoBuf。任意呼び出しAPI * **パラメータ** - proto_fmt: プロトコル形式。[ProtoFMT](./common.md#2820) を参照 ```python from moomoo import * SysConfig.set_proto_fmt(ProtoFMT.Protobuf) quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) quote_ctx.close() ``` * **Example** ## 全接続のプロトコル暗号化設定 `enable_proto_encrypt(is_encrypt)` * **概要** 全接続のリクエストとレスポンスの内容を暗号化します。プロトコル暗号化の流れについては[こちら](../qa/other.md#1150)をご覧ください。 * **パラメータ** パラメータ|型|説明 :-|:-|:- is_encrypt|bool|暗号化を有効にするか| * **Example** ```python from moomoo import * SysConfig.enable_proto_encrypt(is_encrypt = True) SysConfig.set_init_rsa_file("conn_key.txt") # RSA 秘密鍵ファイルパス quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) quote_ctx.close() ``` ## 秘密鍵パスの設定 `set_init_rsa_file(file)` * **概要** RSA 秘密鍵ファイルパスを設定します。プロトコル暗号化の流れについては[こちら](../qa/other.md#1150)をご覧ください。 * **パラメータ** パラメータ|型|説明 :-|:-|:- file|str|秘密鍵ファイルパス| * **Example** ```python from moomoo import * SysConfig.enable_proto_encrypt(is_encrypt = True) SysConfig.set_init_rsa_file("conn_key.txt") # RSA 秘密鍵ファイルパス quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) quote_ctx.close() ``` ## スレッドモードの設定 `set_all_thread_daemon(all_daemon)` * **概要** 内部で作成されるすべてのスレッドを daemon スレッドに設定するかどうか。 - daemon スレッドに設定した場合：メインスレッド終了後、プロセスも終了します。 例：リアルタイムコールバックAPIを使用する場合、メインスレッドの存続を自分で保証する必要があります。メインスレッド終了後はプロセスも終了し、プッシュデータを受信できなくなります。 - 非 daemon スレッドに設定した場合：メインスレッド終了後も、プロセスは終了しません。 例：相場または取引オブジェクト作成後、close() で接続をクローズしなければ、メインスレッドが終了してもプロセスは終了しません。 * **パラメータ** パラメータ|型|説明 :-|:-|:- all_daemon|bool|daemon スレッドに設定するか (- True：daemon スレッドに設定 - False：非 daemon スレッドに設定 - デフォルトは False) * **Example** ```python from moomoo import * SysConfig.set_all_thread_daemon(True) quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) # quote_ctx.close() を呼び出さなくてもプロセスが終了する ``` ## コールバックの設定 `set_handler(handler)` * **概要** 非同期コールバック処理オブジェクトの設定 * **パラメータ** - handler: コールバック処理オブジェクト クラス|説明 :-|:- SysNotifyHandlerBase|[OpenD 通知処理基底クラス](./init.md#6075) StockQuoteHandlerBase|[株価情報処理基底クラス](../quote/update-stock-quote.md) OrderBookHandlerBase|[板情報処理基底クラス](../quote/update-order-book.md) CurKlineHandlerBase|[リアルタイムローソク足処理基底クラス](../quote/update-kl.md) TickerHandlerBase|[ティック処理基底クラス](../quote/update-ticker.md) RTDataHandlerBase|[分時データ処理基底クラス](../quote/update-rt.md) BrokerHandlerBase|[ブローカーキュー処理基底クラス](../quote/update-broker.md) PriceReminderHandlerBase|[到達価格アラート処理基底クラス](../quote/update-price-reminder.md) TradeOrderHandlerBase|[注文処理基底クラス](../trade/update-order.md) TradeDealHandlerBase|[約定処理基底クラス](../trade/update-order-fill.md) ```python import time from moomoo import * class OrderBookTest(OrderBookHandlerBase): def on_recv_rsp(self, rsp_str): ret_code, data = super(OrderBookTest,self).on_recv_rsp(rsp_str) if ret_code != RET_OK: print("OrderBookTest: error, msg: %s" % data) return RET_ERROR, data print("OrderBookTest ", data) # OrderBookTest 独自の処理ロジック return RET_OK, data quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) handler = OrderBookTest() quote_ctx.set_handler(handler) # リアルタイム板情報コールバックの設定 quote_ctx.subscribe(['HK.00700'], [SubType.ORDER_BOOK]) # 板情報タイプを登録すると、OpenD はサーバーからのプッシュを継続的に受信開始 time.sleep(15) # スクリプトが OpenD のプッシュを受信する時間を15秒に設定 quote_ctx.close() # 接続をクローズすると、OpenD は1分後に対応銘柄の登録を自動解除 ``` ## 接続 ID の取得 `get_sync_conn_id()` * **概要** 接続 ID を取得。接続の初期化成功後に値が設定される * **戻り値** - conn_id: 接続 ID * **Example** ```python from moomoo import * quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) quote_ctx.get_sync_conn_id() quote_ctx.close() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。 ``` ## イベント通知コールバック `SysNotifyHandlerBase` * **概要** 接続切断などの重要メッセージを OpenD に通知 * **プロトコル ID** 1003 * **戻り値**
パラメータ 型 説明
ret RET_CODE API呼び出し結果
data tuple ret == RET_OK の場合、イベント通知データを返す
str ret != RET_OK の場合、エラーの説明を返す
* **イベント通知データ** の形式は以下の通りです。
パラメータ 型 説明
notify_type [SysNotifyType](./common.md#9808) 通知タイプ
sub_type [ProgramStatusType](./common.md#7462) サブタイプ。notify_type == SysNotifyType.PROGRAM_STATUS の場合、sub_type はプログラム状態タイプを返す
[GtwEventType](./common.md#1593) サブタイプ。notify_type == SysNotifyType.GTW_EVENT の場合、sub_type は OpenD イベント通知タイプを返す
0 notify_type != SysNotifyType.PROGRAM_STATUS かつ notify_type != SysNotifyType.GTW_EVENT の場合、sub_type は 0 を返す
msg dict イベント情報。notify_type == SysNotifyType.CONN_STATUS の場合、msg は 接続状態イベント情報 辞書を返す
イベント情報。notify_type == SysNotifyType.QOT_RIGHT の場合、msg は 相場情報の利用権限イベント情報 辞書を返す
* **接続状態イベント情報** の辞書構造は以下の通りです（接続状態の型は bool。True は接続正常、False は接続切断）: ```protobuf { 'qot_logined': bool1, 'trd_logined': bool2, } ``` * **相場情報の利用権限イベント情報** の辞書構造は以下の通りです（[相場情報の利用権限](../quote/quote.md#7726)の詳細はこちら）: ```protobuf { 'hk_qot_right': value1, 'hk_option_qot_right': value2, 'hk_future_qot_right': value3, 'us_qot_right': value4, 'us_option_qot_right': value5, 'us_future_qot_right': value6, // 廃止済み 'cn_qot_right': value7, 'us_index_qot_right': value8, 'us_otc_qot_right': value9, 'sg_future_qot_right': value10, 'jp_future_qot_right': value11, 'us_future_qot_right_cme': value12, 'us_future_qot_right_cbot': value13, 'us_future_qot_right_nymex': value14, 'us_future_qot_right_comex': value15, 'us_future_qot_right_cboe': value16, } ``` * **Example** ```python import time from moomoo import * class SysNotifyTest(SysNotifyHandlerBase): def on_recv_rsp(self, rsp_str): ret_code, data = super(SysNotifyTest, self).on_recv_rsp(rsp_str) notify_type, sub_type, msg = data if ret_code != RET_OK: logger.debug("SysNotifyTest: error, msg: {}".format(msg)) return RET_ERROR, data if notify_type == SysNotifyType.GTW_EVENT: # OpenD イベント通知 print("GTW_EVENT, type: {} msg: {}".format(sub_type, msg)) elif notify_type == SysNotifyType.PROGRAM_STATUS: # プログラム状態変化通知 print("PROGRAM_STATUS, type: {} msg: {}".format(sub_type, msg)) elif notify_type == SysNotifyType.CONN_STATUS: ## 接続状態変化通知 print("CONN_STATUS, qot: {}".format(msg['qot_logined'])) print("CONN_STATUS, trd: {}".format(msg['trd_logined'])) elif notify_type == SysNotifyType.QOT_RIGHT: # 相場情報の利用権限変化通知 print("QOT_RIGHT, hk: {}".format(msg['hk_qot_right'])) print("QOT_RIGHT, hk_option: {}".format(msg['hk_option_qot_right'])) print("QOT_RIGHT, hk_future: {}".format(msg['hk_future_qot_right'])) print("QOT_RIGHT, us: {}".format(msg['us_qot_right'])) print("QOT_RIGHT, us_option: {}".format(msg['us_option_qot_right'])) print("QOT_RIGHT, cn: {}".format(msg['cn_qot_right'])) print("QOT_RIGHT, us_index: {}".format(msg['us_index_qot_right'])) print("QOT_RIGHT, us_otc: {}".format(msg['us_otc_qot_right'])) print("QOT_RIGHT, sg_future: {}".format(msg['sg_future_qot_right'])) print("QOT_RIGHT, jp_future: {}".format(msg['jp_future_qot_right'])) print("QOT_RIGHT, us_future_cme: {}".format(msg['us_future_qot_right_cme'])) print("QOT_RIGHT, us_future_cbot: {}".format(msg['us_future_qot_right_cbot'])) print("QOT_RIGHT, us_future_nymex: {}".format(msg['us_future_qot_right_nymex'])) print("QOT_RIGHT, us_future_comex: {}".format(msg['us_future_qot_right_comex'])) print("QOT_RIGHT, us_future_cboe: {}".format(msg['us_future_qot_right_cboe'])) return RET_OK, data quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) handler = SysNotifyTest() quote_ctx.set_handler(handler) # コールバックの設定 time.sleep(15) # スクリプトが OpenD のプッシュを受信する時間を15秒に設定 quote_ctx.close() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。` ``` ## コンソールへの接続状態出力の設定 `enable_console_log(enable)` * **概要** Python スクリプトと OpenD 間の接続状態をコンソールに出力するかどうかを設定します。任意呼び出しAPI。 スレッドセーフではありません。必要に応じて、プログラムの先頭で呼び出してください。 * **パラメータ** パラメータ|型|説明 :-|:-|:- enable|bool|接続状態をコンソールに出力するかどうか (- True：出力する - False：出力しない - デフォルトは True) * **Example** ```python from moomoo import * SysConfig.enable_console_log(True) quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111) quote_ctx.close() ``` --- # 共通定義 ## API呼び出し結果 > **RET_CODE** * `RET_OK` 成功 * `RET_ERROR` 失敗 ## プロトコル形式 > **ProtoFMT** * `Protobuf` Google Protobuf 形式 * `Json` Json 形式 ## パケット暗号化アルゴリズム ## プログラム状態タイプ > **ProgramStatusType** * `NONE` 不明 * `LOADED` 必要なモジュールの読み込み完了 * `LOGING` ログイン中 * `NEED_PIC_VERIFY_CODE` 画像認証コードが必要 * `NEED_PHONE_VERIFY_CODE` SMS認証コードが必要 * `LOGIN_FAILED` ログイン失敗 * `FORCE_UPDATE` クライアントのバージョンが古い * `NESSARY_DATA_PREPARING` 必要な情報を取得中 * `NESSARY_DATA_MISSING` 必要な情報が不足 * `UN_AGREE_DISCLAIMER` 免責事項に同意していない * `READY` 正常に利用可能な状態 * `FORCE_LOGOUT` OpenD ログイン後に強制ログアウトされた ## ゲートウェイイベント通知タイプ > **GtwEventType** * `LocalCfgLoadFailed` ローカル設定ファイルの読み込み失敗 * `APISvrRunFailed` ゲートウェイリスニングサービスの起動失敗 * `ForceUpdate` ゲートウェイの強制アップグレード * `LoginFailed` moomoo サーバーへのログイン失敗 * `UnAgreeDisclaimer` 免責事項に同意していないため実行不可 * `LOGIN_FAILED` ログイン失敗 * `NetCfgMissing` ネットワーク接続設定が不足 * `KickedOut` ログインがキックアウトされた * `LoginPwdChanged` ログインパスワードの変更 * `BanLogin` moomoo バックエンドがこのアカウントのログインを許可しない * `NeedPicVerifyCode` ログイン時に画像認証コードの入力が必要 * `NeedPhoneVerifyCode` ログイン時にSMS認証コードの入力が必要 * `AppDataNotExist` プログラムパッケージデータの欠落 * `NessaryDataMissing` 必要なデータの同期に失敗 * `TradePwdChanged` 取引パスワード変更通知 * `EnableDeviceLock` デバイスロックの有効化が必要 ## システム通知タイプ > **SysNotifyType** * `GTW_EVENT` ゲートウェイイベント * `PROGRAM_STATUS` プログラム状態変化 * `CONN_STATUS` バックエンドサービスとの接続状態変化 * `QOT_RIGHT` 相場情報の利用権限変化 ## パケット一意識別子 **PacketID** ```protobuf message PacketID { required uint64 connID = 1; //現在の TCP 接続の接続 ID。接続の一意識別子。InitConnect プロトコルで返される required uint32 serialNo = 2; //自動インクリメントシーケンス番号 } ``` ## プログラム状態 **ProgramStatus** ```protobuf message ProgramStatus { required ProgramStatusType type = 1; //現在の状態 optional string strExtDesc = 2; // 補足説明 } ``` --- # ネイティブプロトコル概要 moomoo API は、moomoo が主要プログラミング言語（Python、Java、C#、C++、JavaScript）向けに提供する API SDK です。呼び出しを容易にし、戦略開発の難易度を下げます。 このセクションでは、戦略スクリプトと OpenD サービス間の通信に使用する低レベルプロトコルについて説明します。上記5種類以外のプログラミング言語のユーザーがネイティブプロトコルを実装する際に参考にしてください。 :::tip ご注意 * お使いのプログラミング言語が上記5種類に含まれる場合は、このセクションをスキップしてください。 ::: ## プロトコルリクエストフロー * 接続の確立 * 接続の初期化 * データリクエストまたはプッシュデータの受信 * 定期的に KeepAlive を送信して接続を維持 ![proto-process](../img/proto_mmprocess.png) ## プロトコル設計 プロトコルデータにはプロトコルヘッダーとプロトコルボディが含まれます。ヘッダーは固定フィールド、ボディは具体的なプロトコルに依存します。 ### プロトコルヘッダー ``` struct APIProtoHeader { u8_t szHeaderFlag[2]; u32_t nProtoID; u8_t nProtoFmtType; u8_t nProtoVer; u32_t nSerialNo; u32_t nBodyLen; u8_t arrBodySHA1[20]; u8_t arrReserved[8]; }; ``` フィールド|説明 :-|:- szHeaderFlag|パケットヘッダー開始フラグ。固定値 "FT" nProtoID|プロトコル ID nProtoFmtType|プロトコル形式タイプ。0 は Protobuf 形式、1 は Json 形式 nProtoVer|プロトコルバージョン。互換性のためのイテレーション用。現在は 0 を指定 nSerialNo|パケットシーケンス番号。リクエストとレスポンスの対応に使用。インクリメントが必要 nBodyLen|パケットボディの長さ arrBodySHA1|パケットボディの元データ（復号後）の SHA1 ハッシュ値 arrReserved|8バイト拡張予約 ::: tip ご注意 * u8_t は8ビット符号なし整数、u32_t は32ビット符号なし整数を表します * OpenD の内部処理は Protobuf を使用するため、Json 変換のオーバーヘッドを減らすために Protobuf 形式の使用を推奨します * nProtoFmtType フィールドでボディのデータ型を指定すると、レスポンスは対応する型で返されます。プッシュプロトコルのデータ型は OpenD の設定ファイルで指定します * **arrBodySHA1 はリクエストデータのネットワーク転送前後の整合性検証に使用されます。正しく入力する必要があります** * **プロトコルヘッダーのバイナリストリームはリトルエンディアンバイトオーダーを使用します。ntohl 等の関数でのデータ変換は通常不要です** ::: ### プロトコルボディ #### Protobuf プロトコルリクエストボディ構造 ``` message C2S { required int64 req = 1; } message Request { required C2S c2s = 1; } ``` #### Protobuf プロトコルレスポンスボディ構造 ``` message S2C { required int64 data = 1; } message Response { required int32 retType = 1 [default = -400]; //RetType、戻り値 optional string retMsg = 2; optional int32 errCode = 3; optional S2C s2c = 4; } ``` フィールド|説明 :-|:- c2s|リクエストパラメータ構造 req|リクエストパラメータ。実際にはプロトコル定義に従う retType|リクエスト結果 retMsg|リクエスト失敗時の失敗理由 errCode|リクエスト失敗時の対応エラーコード s2c|レスポンスデータ構造。一部のプロトコルはデータを返さないためこのフィールドなし data|レスポンスデータ。実際にはプロトコル定義に従う ::: tip ご注意 * パケットボディ形式はリクエストのプロトコルヘッダー nProtoFmtType で指定し、OpenD のプッシュ形式は [InitConnect](../ftapi/init.md#2864) で設定します。 * 元のプロトコルファイル形式は Protobuf で定義されています。JSON 形式での転送が必要な場合は、protobuf3 のインターフェースで直接 JSON に変換することを推奨します。 * 列挙値フィールドは符号付き整数で定義され、コメントで対応する列挙を示します。列挙は通常 Common.proto、Qot_Common.proto、Trd_Common.proto ファイルで定義されています。 * プロトコル内の価格・パーセンテージ等のデータは浮動小数点型で転送されるため、直接使用すると精度の問題が発生します。精度（プロトコルで未指定の場合はデフォルト小数点以下3桁）に基づいて四捨五入してから使用してください。 ::: ## ハートビート保持 ```protobuf syntax = "proto2"; package KeepAlive; option java_package = "com.moomoo.openapi.pb"; option go_package = "github.com/moomooopen/mmapi4go/pb/keepalive"; import "Common.proto"; message C2S { required int64 time = 1; //クライアントがパケット送信時のUTCタイムスタンプ（秒） } message S2C { required int64 time = 1; //サーバーがレスポンス送信時のUTCタイムスタンプ（秒） } message Request { required C2S c2s = 1; } message Response { required int32 retType = 1 [default = -400]; //RetType、戻り値 optional string retMsg = 2; optional int32 errCode = 3; optional S2C s2c = 4; } ``` * **概要** ハートビート保持 * **プロトコル ID** 1004 * **使用方法** [初期化接続](./init.md#3691)で返されるハートビート間隔に基づいて、OpenD にハートビートプロトコルを送信します ## 暗号化通信フロー * OpenD で暗号化が設定されている場合、[InitConnect](../ftapi/init.md#2864) 初期化接続プロトコルは [RSA](../qa/other.md#3969) 公開鍵で暗号化する必要があります。後続の他のプロトコルは InitConnect が返すランダム鍵を使用して AES 暗号化通信を行います。 * OpenD の暗号化フローは SSL プロトコルを参考にしていますが、一般的にローカルデプロイであることを考慮し、関連フローを簡略化しています。OpenD と接続クライアントは同一の [RSA](../qa/other.md#3969) 秘密鍵ファイルを共有します。秘密鍵ファイルの保管・配布には十分注意してください。 * この[サイト](http://web.chacuo.net/netrsakeypair)でランダムな [RSA](../qa/other.md#3969) 鍵ペアをオンライン生成できます。鍵形式は PCKS#1、鍵長 512 または 1024、パスワードは未設定とし、生成された秘密鍵をファイルにコピー保存して、[OpenD 設定](../opend/opend-cmd.md#9467)の **rsa_private_key** 項目に秘密鍵ファイルパスを設定してください。 * **本番取引を行うユーザーは暗号化の設定を推奨します。アカウントおよび取引情報の漏洩を防止します。** ![encrypt](../img/mmencrypt.png) ## RSA 暗号化・復号 * [OpenD 設定](../opend/opend-cmd.md#9467)で **rsa_private_key** に秘密鍵ファイルパスを指定 * OpenD と接続クライアントは同一の秘密鍵ファイルを共有 * RSA 暗号化・復号は InitConnect リクエストにのみ使用し、他のリクエストの対称暗号化 Key を安全に取得するために使用 * OpenD の [RSA](../qa/other.md#3969) 鍵は 1024 ビット。パディング方式 PKCS1、公開鍵で暗号化・秘密鍵で復号。公開鍵は秘密鍵から生成可能 * Python API 参考実装：[RsaCrypt](https://github.com/FutunnOpen/py-futu-api/tree/master/futu/common/sys_config.py) クラスの encrypt / decrypt インターフェース ### 送信データの暗号化 * RSA 暗号化ルール：鍵ビット数が key_size の場合、1回の暗号化文字列の最大長は (key_size)/8 - 11 です。現在 1024 ビットのため、1回の暗号化長は 100 に設定できます。 * 平文データを最大100バイトの小セグメントに分割して暗号化し、各セグメントの暗号化データを連結したものが最終的な Body 暗号化データになります。 ### 受信データの復号 * RSA 復号も同様にセグメント分割ルールに従います。1024 ビット鍵の場合、各セグメントの復号データ長は 128 バイトです。 * 暗号文データを128バイトの小セグメントに分割して復号し、各セグメントの復号データを連結したものが最終的な Body 復号データになります。 ## AES 暗号化・復号 * 暗号化 Key は InitConnect プロトコルから返される * デフォルトでは AES の ECB 暗号化モードを使用 * Python API 参考実装: [ConnMng](https://github.com/FutunnOpen/py-futu-api/tree/master/futu/common/conn_mng.py) クラスの encrypt_conn_data / decrypt_conn_data インターフェース ### 送信データの暗号化 * AES 暗号化はソースデータ長が16の倍数である必要があるため、'0'でパディングしてから暗号化し、mod_len をソースデータ長と16の剰余として記録します。 * 暗号化前にソースデータを変更する可能性があるため、暗号化データの末尾に16バイトのパディングブロックを追加します。最後の1バイトに mod_len を、残りのバイトに'0'を設定し、暗号化データとパディングブロックを連結して最終的な送信プロトコルの body データとします。 ### 受信データの復号 * プロトコル body データの最後の1バイトを取り出して mod_len とし、末尾16バイトのパディングブロックを切り落としてから復号します（暗号化時のパディングロジックに対応）。 * mod_len が 0 の場合、復号後のデータがそのままプロトコルの body データです。0 以外の場合は末尾の (16 - mod_len) バイトのパディングデータを切り落とす必要があります。 ![aes](../img/aes.png) --- # OpenD 関連 ## Q1：OpenD が「アンケート評価・契約確認」未完了のため自動終了する A: OpenD を使用するには関連するアンケート評価と契約確認を完了する必要があります。先に[こちら](https://www.moomoo.com/zh-cn/about/api-disclaimer)で完了させてください。 ## Q2：OpenD が「プログラム同梱データが存在しない」で終了する A: 通常、権限の問題により同梱データのコピーに失敗しています。プログラムディレクトリ内の __*Appdata.dat*__ を解凍し、プログラムデータディレクトリにコピーしてみてください。 * windows プログラムデータディレクトリ：`%appdata%/com.moomoo.OpenD/F3CNN` * 非 windows プログラムデータディレクトリ：`~/.com.moomoo.OpenD/F3CNN` ## Q3：OpenD のサービス起動に失敗する A: 以下を確認してください。 1. 設定したポートが他のプログラムに占有されていないか。 2. 同じポートを設定した別の OpenD が既に実行されていないか。 ## Q4：SMS認証コードの認証方法は？ A: OpenD の画面上、または Telnet でポートに接続し、コマンド `input_phone_verify_code -code=123456` を入力します。 ::: tip ご注意 * 123456 は受信した SMS認証コードです * -code=123456 の前にスペースが必要です ::: ## Q5：他のプログラミング言語はサポートされていますか？ A: OpenD は Socket ベースのプロトコルを公開しています。現在、Python、C++、Java、C#、JavaScript のインターフェースを提供・メンテナンスしています。[ダウンロードはこちら](https://www.moomoo.com/hans/download/OpenAPI)。 上記の言語でもニーズを満たせない場合は、Protobuf プロトコルを直接実装できます。 ## Q6：同一デバイスで複数回デバイスロックの認証が求められる A: デバイス識別子はランダム生成され、以下のファイルに保存されます。 windows: %appdata%/com.moomoo.OpenD/F3CNN/Device.dat ファイル内。 非windows: ~/.com.moomoo.OpenD/F3CNN/Device.dat ::: tip ご注意 1. ファイルが削除または破損した場合、OpenD は新しいデバイス識別子を再生成し、デバイスロック認証が再度必要になります。 2. イメージコピーでデプロイしたユーザーは注意が必要です。複数のマシンで Device.dat の内容が同一の場合、それらのマシンで複数回デバイスロック認証が発生します。Device.dat ファイルを削除することで解決できます。 ::: ## Q7：OpenD の Docker イメージは提供されていますか？ A: 現在提供していません。 ## Q8：1つのアカウントで複数の OpenD にログインできますか？ A: 1つのアカウントで複数のマシン上の OpenD や他のクライアント端末にログインでき、最大10の OpenD 端末が同時ログイン可能です。ただし「相場キックアウト」の制限があり、最高権限相場を取得できるのは1つの OpenD のみです。例：同一アカウントで2つの端末にログインした場合、1つは香港株 LV2 行情、もう1つは香港株 BMP 行情となります。 ## Q9：OpenD と他のクライアント（デスクトップ端末・モバイル端末）の相場権限をどう制御しますか？ A: 取引所の規定により、複数端末が同時オンラインの場合「相場キックアウト」の制限があり、最高権限相場を取得できるのは1つの端末のみです。コマンドライン OpenD の起動パラメータには [auto_hold_quote_right](../opend/opend-cmd.md#9467) パラメータが組み込まれており、相場権限を柔軟に設定できます。このオプションが有効な場合、OpenD は相場権限がキックアウトされた後に自動で取り戻します。10秒以内に再度キックアウトされた場合、他の端末が最高相場権限を取得します（OpenD は再取得しません）。 ## Q10：OpenD の相場権限を優先的に確保するには？ A: 1. OpenD 起動パラメータ [auto_hold_quote_right](../opend/opend-cmd.md#9467) を 1 に設定します。 2. モバイル端末またはデスクトップ端末の moomoo で、10秒以内に2回連続で最高権限を奪取しないでください（ログインが1回目、「行情再起動」のクリックが2回目にカウントされます）。 ![quote-right-kick](../img/quote-right-kick.png) ## Q11：モバイル端末（またはデスクトップ端末）の相場権限を優先的に確保するには？ A: OpenD 起動パラメータ [auto_hold_quote_right](../opend/opend-cmd.md#9467) を 0 に設定し、モバイル端末またはデスクトップ端末の moomoo を OpenD の後にログインしてください。 ## Q12：GUI版 OpenD でパスワード保存ログインを使用後、長時間稼働で接続切断が通知され、再ログインが必要になる？ A: GUI版 OpenD でパスワード保存ログインを選択した場合、ローカルに記録されたトークンが使用されます。トークンには有効期限があり、期限切れ後にネットワーク変動やバックエンド更新が発生すると、バックエンドとの接続が切断された後に自動再接続できない場合があります。そのため、GUI版 OpenD で長時間稼働させる場合は、パスワードを手動入力してログインし、OpenD に自動処理させることを推奨します。 ## Q13：製品のバグを発見した場合、moomoo のエンジニアにログ調査を依頼するには？ A: 1. カスタマーサポートに問題の詳細を伝えてください：エラー発生時刻、OpenD バージョン番号、API バージョン番号、スクリプト言語名、API名またはプロトコル番号、詳細な入力パラメータと戻り値を含むコードスニペットまたはスクリーンショット。 2. カスタマーサポートが製品バグと確認後、さらなるログ調査が必要な場合はエンジニアから連絡します。 3. 一部の問題には OpenD ログの提供が必要です。取引関連は info ログレベル、相場関連は debug ログレベルが必要です。ログレベル log_level は __*OpenD.xml*__ で[設定](../opend/opend-cmd.md#9467)でき、設定後は OpenD の再起動が必要です。問題が再現した後、該当ログを圧縮して moomoo エンジニアに送信してください。 :::tip ご注意 ログパス： windows：`%appdata%/com.moomoo.OpenD/Log` 非 windows：`~/.com.moomoo.OpenD/Log` ::: ## Q14：スクリプトが OpenD に接続できない A: まず以下を確認してください。 1. スクリプトの接続ポートと OpenD で設定したポートが一致しているか。 2. OpenD の接続上限は 128 のため、不要な接続が未クローズでないか。 3. 監視アドレスが正しいか確認してください。スクリプトと OpenD が同一マシンにない場合、OpenD の監視アドレスを 0.0.0.0 に設定する必要があります。 ## Q15：接続後しばらくして切断される A: プロトコルを自分で実装している場合、定期的なハートビート送信で接続を維持しているか確認してください。 ## Q16：Linux で multiprocessing モジュールを使用して Python スクリプトをマルチプロセスで実行すると、OpenD に接続できない？ A: Linux/Mac 環境でデフォルト方式でプロセス作成後、親プロセス内の py-moomoo-api で作成されたスレッドが子プロセスで消失し、プログラム内部の状態が不正になります。 spawn 方式でプロセスを起動してください。 ```python import multiprocessing as mp mp.set_start_method('spawn') p = mp.Process(target=func) ``` ## Q17：1台のPCで2つの OpenD に同時ログインするには？ A: GUI版 OpenD は未サポートですが、コマンドライン OpenD はサポートしています。 1. 公式サイトからダウンロードしたファイルを解凍し、コマンドライン OpenD フォルダ全体（例：OpenD_5.2.1408_Windows）をコピーしてコピーを作成します（ここでは Windows の例ですが、他の OS でも同様の操作が可能です）。 ![file-page](../img/en-copied.png) 2. 2つのコマンドライン OpenD フォルダでそれぞれ OpenD.xml ファイルを設定します。 1つ目の設定ファイルパラメータ：api_port = 11111、login_account = ログインアカウント1、login_pwd = ログインパスワード1 2つ目の設定ファイルパラメータ：api_port = 11112、login_account = ログインアカウント2、login_pwd = ログインパスワード2 ![order-page](../img/nnorder-page.png) 3. 設定完了後、2つの OpenD プログラムをそれぞれ起動します。 ![fod-page](../img/en-folder.png) 4. APIを呼び出す際、パラメータ `port`（OpenD 監視ポート）が OpenD.xml ファイルのパラメータ `api_port` と対応関係にあることにご注意ください 例： ```python from moomoo import * # アカウント1でログインした OpenD にリクエスト quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111, is_encrypt=False) quote_ctx.close() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。 # アカウント2でログインした OpenD にリクエスト quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11112, is_encrypt=False) quote_ctx.close() # 使用後は接続をクローズしてください。接続数の枯渇を防止します。 ``` ## Q18：相場権限が他のクライアントにキックアウトされた場合、スクリプトで権限取得の運用コマンドを実行するには？ A： 1. OpenD の起動パラメータで、Telnet アドレスと Telnet ポートを設定します。 ![telnet_GUI](../img/telnet_GUI.png) ![telnet_CMD](../img/telnet_CMD.jpg) 2. OpenD を起動します（Telnet も同時に起動されます）。 3. 相場権限がキックアウトされたことを検出した後、以下のコードサンプルを参考に、Telnet 経由で OpenD に `request_highest_quote_right` コマンドを送信できます。 ```python from telnetlib import Telnet with Telnet('127.0.0.1', 22222) as tn: # Telnet アドレス：127.0.0.1、Telnet ポート：22222 tn.write(b'request_highest_quote_right\r\n') reply = b'' while True: msg = tn.read_until(b'\r\n', timeout=0.5) reply += msg if msg == b'': break print(reply.decode('gb2312')) ``` ## Q19：OpenD の自動アップグレードに失敗する A： `update` コマンドで OpenD の自動更新に失敗した場合、考えられる原因： - ファイルが他のプロセスに占有されている：他の OpenD プロセスを終了するか、システムを再起動してから再度 `update` を実行してください 上記でも解決しない場合は、[公式サイト](https://www.moomoo.com/hans/download/OpenAPI)から手動でダウンロード・更新してください。 ## Q20：Ubuntu 22 でGUI版 OpenD を起動できない？ A： 一部の Linux ディストリビューション（例：Ubuntu 22.04）でGUI版 OpenD を実行すると、`dlopen(): error loading libfuse.so.2` と表示される場合があります。 これは、これらのシステムに libfuse がデフォルトでインストールされていないためです。通常は手動インストールで解決できます。例えば Ubuntu 22.04 の場合、コマンドラインで以下を実行してください。 ``` sudo apt update sudo apt install -y libfuse2 ``` インストール成功後、GUI版 OpenD を正常に実行できます。詳細は [https://docs.appimage.org/user-guide/troubleshooting/fuse.html](https://docs.appimage.org/user-guide/troubleshooting/fuse.html) をご参照ください。 ## Q21：Linux でコマンドライン OpenD をバックグラウンドで実行するには？ A：OpenD があるディレクトリに移動し、OpenD.xml を設定した後、以下のコマンドを実行してください ``` nohup ./moomoo OpenD & ``` --- # 相場データ関連 ## Q1：登録失敗 A: 登録APIがエラーを返す場合、以下の2つのケースが一般的です。 * 登録枠不足： 登録枠のルールは[登録枠 & 過去ローソク足データ枠](../intro/authority.md#8582)を参照してください * 登録権限不足： 登録をサポートする相場権限は下表の通りです
市場 商品 登録をサポートする相場権限
香港市場 株式 LV1, LV2, SF
オプション LV1, LV2
先物 LV1, LV2
米国市場 株式 LV1, LV2
オプション LV1
先物 LV1, LV2
A株市場 株式 LV1
シンガポール市場 株式 LV1, LV2
マレーシア市場 株式 LV1, LV2, LV3
日本市場 株式 LV2, LV3
相場情報の利用権限の取得方法は[相場情報の利用権限](../intro/authority.html#7726)を参照してください ご注意：アカウントが上記の権限を持っているのに登録に失敗する場合、他の端末に[相場権限をキックアウト](./opend.html#7801)されている可能性があります。 ## Q2：登録解除失敗 A: 登録後少なくとも1分経過してからでないと登録解除できません。 ## Q3：登録解除成功したが枠が解放されない A: すべての接続で該当相場の登録を解除して初めて枠が解放されます。 例：接続 A と接続 B の両方が HK.00700 の板情報を登録している場合、接続 A が登録解除しても、接続 B がまだデータを利用しているため、OpenD の枠は解放されません。すべての接続が HK.00700 の板情報を登録解除するまで解放されません。 ## Q4：登録から1分未満でスクリプト接続をクローズした場合、枠は解放されますか？ A: されません。接続クローズ後、登録時間が1分未満の銘柄タイプは、1分経過後に自動的に登録解除され、対応する登録枠が解放されます。 ## Q5：リクエスト頻度制限の具体的なロジックは？ A: 30秒以内に最大 n 回とは、1回目と n+1 回目のリクエストの間隔が30秒以上必要であることを意味します。 ## Q6：ウォッチリストに銘柄を追加できないのはなぜ？ A: 上限を超えていないか確認し、一部のウォッチリスト銘柄を削除してみてください。 ## Q7：API の米国株株価情報とアプリの全米総合株価情報が異なるのはなぜ？ A: 米国株取引は多数の取引所に分散しているため、Futuでは複数の米国株基本相場情報を提供しています。4月16日より、Moomoo APIにおいて**無料で**米国株リアルタイム相場情報の権限が開放されます（プロモーション期間中は無料）。従来は別途相場カードを購入する必要があった深さ表示付き米国株相場情報が、無料で利用可能となりました。Moomoo APIでは2種類の米国株相場情報が提供されます：Nasdaq Basic + TotalView（Nasdaq取引所60段階）、NYSE Arcabook（Arca 60段階）。 米国株の当日始値がクライアント表示と一致しない場合、これはMoomoo APIのリアルタイム上流相場情報がNasdaqとNYSE Arcabookのデータを統合しているためです。 ## Q8：API の行情カードはどこで購入できますか？ A: * 香港株市場 * [香港株 LV2 高級行情（香港・マカオ・台湾及び海外IPのみ）](https://qtcard.moomoo.com/buy?market_id=1&good_type=1012&area_type=oversea#/) * [香港株 LV2 + オプション先物 LV2 行情（香港・マカオ・台湾及び海外IPのみ）](https://qtcard.moomoo.com/buy?market_id=1&good_type=1013&area_type=oversea#/) * 米国株市場（**期間限定キャンペーン**） * [Nasdaq Basic](https://qtcard.moomoo.com/buy?market_id=2&qtcard_channel=2&good_type=1022#/) * [Nasdaq Basic+TotalView (Non-Pro)](https://qtcard.moomoo.com/buy?market_id=2&qtcard_channel=2&good_type=1026#/) * [Nasdaq Basic+TotalView (Pro)](https://qtcard.moomoo.com/buy?market_id=2&qtcard_channel=2&good_type=1027#/) * [オプション OPRA リアルタイム行情](https://qtcard.moomoo.com/buy?market_id=2&qtcard_channel=2&good_type=1024#/) ## Q9：リアルタイムデータの get APIのレスポンスが遅い場合があるのはなぜ？ A: リアルタイムデータの get APIは事前の登録が必要で、バックエンドから OpenD へのプッシュに依存します。登録直後にすぐ get APIでリクエストすると、OpenD がまだバックエンドからのプッシュを受信していない可能性があります。これを防ぐため、get APIには待機ロジックが組み込まれており、3秒以内にプッシュを受信すれば即座にスクリプトに返し、3秒を超えてもプッシュがない場合は空データを返します。 関連する get APIは get_rt_ticker、get_rt_data、get_cur_kline、get_order_book、get_broker_queue、get_stock_quote です。リアルタイムデータの get APIのレスポンスが遅い場合は、まず約定データがないことが原因でないか確認してください。 ## Q10：API 米国株 Nasdaq Basic 行情カード購入後に取得できるデータは？ A: Nasdaq Basic 行情カードの購入・有効化後、Nasdaq、NYSE、NYSE MKT 取引所に上場する有価証券（米国正株と ETF を含む。米国先物と米国オプションは含まない）のデータを取得できます。 サポートされるデータAPIは、スナップショット、過去ローソク足データ、リアルタイムティック登録、リアルタイム1段板情報登録、リアルタイムローソク足登録、リアルタイム株価情報登録、リアルタイム分時登録、到達価格アラートです。 ## Q11：各相場商品の板情報は何段までサポートされていますか？ A: 相場商品|LV1|LV2|LV3|SF :-|:-|:-|:-|:- 香港株（正株、ワラント、CBBC、インラインワラントを含む）|/|10|フル板+1000件明細 香港株オプション先物|1|10|/|/ 米国株（ETFを含む）|1|60段|Nasdaq 60ティア+Arca 60ティア|/ 米国株オプション|1|/|/|/ 米国先物 |/|40段|/|/ A株|5|/|/|/ シンガポール株式|1|40|/|/ マレーシア株式|3|5|10|/ 日本株式|/|10|40|/ ## Q12：行情カードを購入・有効化したのに、OpenD で相場権限がないのはなぜ？ A: 1. Moomoo API の相場権限はアプリの権限と完全に同じではないため、一部の行情カードはアプリ端末のみ適用されます。購入した行情カードが OpenD に適用されるものか確認してください。 Moomoo API に適用される**すべて**の行情カードは「権限と制限」に掲載しています。[こちら](/intro/authority.html#7581)をクリックしてご確認ください。 2. 行情カードの購入・有効化後は即座に反映されます。**OpenD を再起動**してから、権限状態を再確認してください。 ## Q13：登録APIでリアルタイム相場を取得するには？ **ステップ1：登録** 銘柄コードとデータタイプを[登録API](../quote/sub.md)に渡して登録を完了します。 登録APIはリアルタイム株価情報、リアルタイム板情報、リアルタイムティック、リアルタイム分時、リアルタイムローソク足、リアルタイムブローカーキューデータの取得をサポートしています。登録成功後、OpenD は moomoo サーバーからリアルタイムデータのプッシュを継続的に受信します。 ご注意：登録枠は総資産、取引件数、取引量に応じて割り当てられます。具体的なルールは[登録枠 & 過去ローソク足データ枠](../intro/authority.md#8582)を参照してください。登録枠が不足している場合は、不要な登録が枠を占有していないか確認し、速やかに[登録解除](../quote/sub.md)してください。 **ステップ2：データ取得** 登録プッシュのデータを OpenD からスクリプトに取得するには、以下の2つの方法があります。 **方法1：リアルタイムデータコールバック** 対応するコールバック関数を設定し、OpenD が受信したデータプッシュを非同期で処理します。 コールバック関数を設定すると、OpenD は受信したリアルタイムデータをすぐにスクリプトのコールバック関数にプッシュして処理します。 登録銘柄が活発な場合、プッシュデータ量が大きく頻度も高くなる可能性があります。OpenD からスクリプトへのプッシュ頻度を適度に下げたい場合は、[OpenD 起動パラメータ](../opend/opend-cmd.md#7386)で API プッシュ頻度（`qot_push_frequency`）を設定することを推奨します。 方法1で使用するAPIは、[リアルタイム株価情報コールバック](../quote/update-stock-quote.md)、[リアルタイム板情報コールバック](../quote/update-order-book.md)、[リアルタイムローソク足コールバック](../quote/update-kl.md)、[リアルタイム分時コールバック](../quote/update-rt.md)、[リアルタイムティックコールバック](../quote/update-ticker.md)、[リアルタイムブローカーキューコールバック](../quote/update-broker.md)です。 **方法2：リアルタイムデータの取得** リアルタイムデータ取得APIを使用して、OpenD が受信した最新データをスクリプトに取得できます。この方法はより柔軟で、大量のプッシュを処理する必要がありません。OpenD がサーバーからのプッシュを継続受信していれば、必要な時にデータを取得できます。 OpenD が受信したプッシュデータから取得するため、このカテゴリのAPIには頻度制限がありません。 方法2で使用するAPIは、[リアルタイム株価情報の取得](../quote/get-stock-quote.md)、[リアルタイム板情報の取得](../quote/get-order-book.md)、[リアルタイムローソク足の取得](../quote/get-kl.md)、[リアルタイム分時の取得](../quote/get-rt.md)、[リアルタイムティックの取得](../quote/get-ticker.md)、[リアルタイムブローカーキューの取得](../quote/get-broker.md)です。 ## Q14：各マーケット状態はどの時間帯に対応しますか？ A:
市場 商品 マーケット状態 時間帯（現地時間）
香港市場 有価証券（株式、ETF、ワラント、CBBC、インラインワラントを含む） * NONE：取引なし CST 08:55 - 09:00
* AUCTION：プレマーケットオークション CST 09:00 - 09:20
* WAITING_OPEN：寄付待ち CST 09:20 - 09:30
* MORNING：前場 CST 09:30 - 12:00
* REST: 昼休み CST 12:00 - 13:00
* AFTERNOON：後場 CST 13:00 - 16:00
* HK_CAS：香港株引け後オークション（CAS メカニズム対応のマーケット状態） CST 16:00 - 16:08
* CLOSED：引け CST 16:08 - 08:55（T+1）
オプション、先物（日中取引のみ） * NONE：オプション寄付待ち CST 08:55 - 09:30
* MORNING：前場 CST 09:30 - 12:00
* REST: 昼休み CST 12:00 - 13:00
* AFTERNOON：後場 CST 13:00 - 16:00
* CLOSED：引け CST 16:00 - 08:55（T+1）
先物（日夜間取引） * FUTURE_DAY_WAIT_FOR_OPEN：先物寄付待ち 商品により取引時間が異なる
* NIGHT_OPEN: 夜間取引時間帯
* NIGHT_END：夜間取引終了
* FUTURE_DAY_WAIT_FOR_OPEN：先物寄付待ち
* FUTURE_DAY_OPEN：日中取引時間帯
* FUTURE_DAY_CLOSE：日中取引終了
米国市場 有価証券（株式、ETFを含む） * PRE_MARKET_BEGIN：米国株プレマーケット取引時間帯 EST 04:00 - 09:30
* AFTERNOON：米国株通常取引時間帯 EST 09:30 - 16:00
* AFTER_HOURS_BEGIN：米国株アフターアワーズ取引時間帯 EST 16:00 - 20:00
* AFTER_HOURS_END：米国株アフターアワーズ終了 EST 20:00 - 04:00（T+1）
* OVERNIGHT：米国株オーバーナイト取引時間帯 EST 20:00 - 04:00（T+1）
オプション * NONE：オプション寄付待ち 商品により取引時間が異なる
* REST：米指数オプション昼休み
* AFTERNOON：米国株通常取引時間帯
* TRADE_AT_LAST：米指数オプション引け前取引時間帯
* NIGHT：米指数オプション夜間取引時間帯
* CLOSED：引け
先物 * FUTURE_SWITCH_DATE：米先物寄付待ち 商品により取引時間が異なる
* FUTURE_OPEN：米先物取引時間帯
* FUTURE_BREAK：米先物中盤休憩
* FUTRUE_BREAK_OVER：米先物休憩後取引時間帯
* FUTURE_CLOSE：米先物終了
A株市場 有価証券（株式、ETFを含む） * NONE：取引なし CST 08:55 - 09:15
* Auction：プレマーケットオークション CST 09:15 - 09:25
* WAITING_OPEN：寄付待ち CST 09:25 - 09:30
* MORNING：前場 CST 09:30 - 11:30
* REST：昼休み CST 11:30 - 13:00
* AFTERNOON：後場 CST 13:00 - 15:00
* CLOSED：引け CST 15:00 - 08:55（T+1）
シンガポール市場 証券類商品（株式、ETFs、REITs、仕組みワラント、DLCsを含む） * WAITING_OPEN：寄り前 CST 08:30 - 09:00
* MORNING：前場 CST 09:00 - 12:00
* REST: 昼休み CST 12:00 - 13:00
* AFTERNOON：後場 CST 13:00 - 17:00
* CLOSED：閉場 CST 17:16 - 08:30（T+1）
先物 * FUTURE_DAY_WAIT_FOR_OPEN：先物寄付待ち 商品により取引時間が異なる
* NIGHT_OPEN：夜間取引時間帯
* NIGHT_END：夜間取引終了
* FUTURE_DAY_OPEN：日中取引時間帯
* FUTURE_DAY_CLOSE：日中取引終了
日本市場 証券類商品（株式、ETFsを含む） * WAITING_OPEN：寄り前 JST 07:55 - 09:00
* MORNING：前場 JST 09:00 - 11:30
* REST: 昼休み JST 11:30 - 12:30
* AFTERNOON：後場 JST 12:30 - 15:30
* CLOSED：閉場 JST 15:30 - 07:50（T+1）
先物 * FUTURE_DAY_WAIT_FOR_OPEN：先物寄付待ち JST 16:25（T-1）- 16:30（T-1）
* NIGHT_OPEN：夜間取引時間帯 JST 16:30（T-1） - 05:30
* NIGHT_END：夜間取引終了 JST 05:30 - 08:45
* FUTURE_DAY_OPEN：日中取引時間帯 JST 08:45 - 15:15
* FUTURE_DAY_CLOSE：日中取引終了 JST 15:15 - 16:25
マレーシア市場 証券類商品（株式、ETFs、REITs、ワラントを含む） * AUCTION：プレオープニングオークション CST 08:30 - 09:00
* MORNING：前場 CST 09:00 - 12:30
* REST: 昼休み CST 12:30 - 14:00
* AFTERNOON：後場 CST 14:30 - 16:45
* CLOSED：閉場 CST 17：00 - 08:25（T+1）
暗号通貨 暗号通貨 * NONE：オプション寄付待ち 商品により取引時間が異なる
* MORNING：通常の取引時間
* CLOSED：引け
\* CST、EST、JST はそれぞれ中国時間、米東時間、日本時間を表します ## Q15：API パラメータの銘柄コード形式 A： * プログラミング言語によって必要な銘柄コードの形式が異なります。 * **Python ユーザー** 銘柄コード code の形式：`exchange_market.symbol`。`exchange_market`は取引所市場を表し、`symbol`は銘柄コードを表します。購読可能な銘柄は以下の通りです:
市場 商品 exchange_market example
香港 有価証券（株式、ETF、ワラント、CBBC、インラインワラント等） HK テンセント：HK.00700
指数 HK 香港ハンセン：HK.800000
先物 HK ハンセン指数先物2606：HK.HSI2606
オプション HK * ストックオプション テンセント 260330 450.00C：HK.TCH260330C450000
* インデックスオプション 香港ハンセン 260330 24000.00C：HK.HSI260330C24000000
セクター (セクションのリストを最初に取得するには、 get_plate_listを使用することをお勧めします) HK AI applications stocks：HK.LIST24037
米国 有価証券（NYSE、AMEX、NASDAQ上場の株式・ETF等） US エヌビディア：US.NVDA
オプション US * ストックオプション NVDA 260330 160.00C：US.NVDA260330C160000
* インデックスオプション SPXW 260330 6330.00C: US..SPXW260330C6330000
先物 US S&P500先物2606：US.ES2606
セクター (セクションのリストを最初に取得するには、 get_plate_listを使用することをお勧めします) US 半導体：US.LIST20077
指数（現在ご利用いただけません。） US S&P 500：US..SPX
中国A株 有価証券（株式、ETF等） SH/SZ Kweichow Moutai：SH.600519
指数 SH/SZ 上海総合：SH.000001
セクター (セクションのリストを最初に取得するには、 get_plate_listを使用することをお勧めします) SH/SZ 自動車用電子機器のコンセプト：SH.LIST0301
シンガポール 証券類商品（株式、ETFs、REITs、仕組みワラント、DLCsを含む） SG シンガポール航空：SG.C6L
先物（現在ご利用いただけません） SG A50指数先物2606：SG.CN2606
日本 証券類商品（株式、ETFsを含む） JP 任天堂：JP.7974
先物（現在ご利用いただけません） JP 日経225先物2606：JP.NK2252606
マレーシア市場 証券類商品（株式、ETFs、REITs、ワラントを含む） MY MAYBANK：MY.1155
* **非 Python ユーザー** 銘柄構造は [Security](../quote/quote.html#7040) を参照してください。 例：テンセントホールディングスの場合、パラメータ market に QotMarket_HK_Security、パラメータ code に '00700' を渡します。 * 確認方法： アプリでコードと相場市場を確認：相場 > ウォッチリスト > すべて。 相場市場の定義は[こちら](../quote/quote.html#6603)を参照してください。 ![code](../img/code.png) ## Q16：権利落ち調整係数について A： ### 概要 [権利落ち調整](../quote/get-rehab.html#6618)とは、株価と出来高に対して権利・配当の修正を行い、株式の実際の騰落に基づいて株価チャートを描画し、出来高を同一株数基準に調整することです。 コーポレートアクション（株式分割、併合、株式配当、転換、新株割当、増資、配当金等）はいずれも株価に影響を与える可能性があり、権利落ち調整によって価格・出来高を調整し、コーポレートアクションの影響を排除して株価の連続性を保ちます。 ### 用語解説 - コーポレートアクション：上場企業が行う、株価や株主のポジションに影響を与える株式関連の行為。 - 前方権利落ち調整：現在の株価を基準に、過去の株価に対して権利落ち調整を計算する。 - 後方権利落ち調整：過去の株価を基準に、以降の株価に対して権利落ち調整を計算する。 - 権利落ち調整係数：権利・配当修正比率。権利落ち調整後の価格およびポジション数量の計算に使用される。 - 権利落ち日：株主名簿確定日の翌営業日。権利落ち日に、証券取引所は権利落ち価格を算出し、投資家の寄付参考価格とする。株式配当が株主に分配される日を意味する。 ### 権利落ち調整方法 主流の権利落ち調整計算方法にはイベント法と連乗法の2種類があり、OpenAPI では市場に応じて異なる計算方法を使用しています。 - イベント権利落ち調整法：権利落ち・配当落ちの各イベントを復元して調整する。2つの調整係数（調整係数 A と調整係数 B）があり、調整係数 B は主に現金配当の株価への影響を調整し、調整係数 A はその他のコーポレートアクションの影響を調整する。 - 連乗権利落ち調整法：調整係数を連乗する方式で調整する。調整係数 A のみ保持（または調整係数 B を 0 とする）し、調整係数 A = 権利落ち日前終値 / 権利・配当調整後の前終値。 ::: tip ご注意 * API は米国株の前方権利落ち調整に連乗法を使用し、調整係数 B を 0 とします。 * API は米国株以外の銘柄（A株、香港株、シンガポール株等）および米国株の後方権利落ち調整にイベント法を使用します。 ::: ### 計算式 #### 単回の権利落ち調整 - 前方権利落ち調整： 前方権利落ち調整価格 = 未調整価格 × 前方調整係数 A + 前方調整係数 B - 後方権利落ち調整： 後方権利落ち調整価格 = 未調整価格 × 後方調整係数 A + 後方調整係数 B #### 複数回の権利落ち調整 - 前方権利落ち調整：時間順に、計算日以降の調整係数をフィルタし、時間の早い調整係数から優先的に計算する。2回の調整を例として： ![code](../img/forward_fomula_en.png) - 後方権利落ち調整：時間逆順に、計算日以前の調整係数をフィルタし、時間の遅い調整係数から優先的に計算する。2回の調整を例として： ![code](../img/backward_fomula_en.png) ### 例 #### 単回の前方権利落ち調整の例 牧原股份を例とします。 - 調整係数は以下の通り： 権利落ち日|銘柄コード|内容|前方調整係数 A |前方調整係数 B :-|:-|:-|:-|:- 2021/06/03|SZ.002714|10株につき4株転換、14.61元配当（税込）|0.71429|-1.04357 - 未調整データは以下の通り： 日付|銘柄コード|未調整終値 :-|:-|:- 2021/06/02|SZ.002714|93.11 2021/06/03|SZ.002714|66.25 - 前方権利落ち調整データは以下の通り： 日付|銘柄コード|前方調整済み終値 :-|:-|:- 2021/06/02|SZ.002714|65.4639719 2021/06/03|SZ.002714|66.25 - 前方権利落ち調整データの計算方法： 牧原股份は 2021/06/03 に株式分割および現金配当（10株につき4株転換、14.61元配当）を実施しました。前方権利落ち調整の計算式に基づいて 2021/06/02 の終値を調整すると、前方調整済み価格（65.4639719）= 未調整価格（93.11）× 前方調整係数 A（0.71429）+ 前方調整係数 B（-1.04357） ![code](../img/backward_example.jpg) #### 複数回の後方権利落ち調整の例 前の例の続きとして、牧原股份の 2021/06/02 の後方権利落ち調整価格を計算します。 - 調整係数は以下の通り： 権利落ち日|銘柄コード|内容|後方調整係数 A |後方調整係数 B :-|:-|:-|:-|:-| 2014/07/04|SZ.002714|10株につき2.34元配当（税込）|1|0.234 2015-06-10|SZ.002714|10株につき10株転換、0.61元配当（税込）|2|0.061 2016-07-08|SZ.002714|10株につき10株転換、3.53元配当（税込）|2|0.353 2017-07-11|SZ.002714|10株につき8株転換、6.9元配当（税込）|1.8|0.69 2018-07-03|SZ.002714|10株につき6.91元配当（税込）|1|0.691 2019-07-04|SZ.002714|10株につき0.5元配当（税込）|1|0.05 2020-06-04|SZ.002714|10株につき7株転換、5.5元配当（税込）|1.7|0.55 - 未調整データは以下の通り： 日付|銘柄コード|未調整終値 :-|:-|:- 2021/06/02|SZ.002714|93.11 - 後方権利落ち調整データは以下の通り： 日付|銘柄コード|後方調整済み終値 :-|:-|:- 2021/06/02|SZ.002714|1152.7226 - 後方権利落ち調整データの計算方法： 牧原股份の 2021/06/02 の後方権利落ち調整価格を計算するには、2021/06/02 以前の権利落ちイベントを順に調整し、最終的な後方調整済み価格を算出します。具体的な計算は以下の通りです。 ![code](../img/backward_example.jpg) ## Q17：暗号通貨マルチブローカー相場データについて #### 1. なぜ暗号通貨の相場データは証券会社によって異なるのですか？ A：各証券会社が接続している相場データの上流プロバイダーが異なるため、同じ通貨ペアでも証券会社によって価格差が生じる場合があります。本システムは証券会社に応じて相場 データソースを切り替える機能をサポートしており、ご覧いただく相場が実際の取引環境と一致するようにしています。 #### 2. 証券会社を指定しない場合、どのデータソースの相場が表示されますか？ A：証券会社が指定されていない場合、システムはデフォルトで主要推奨証券会社の上流データを表示します。 #### 3. 暗号通貨取引に対応した証券口座を複数保有していますが、どのように選択すればよいですか？ A：相場データを取得する際は、実際にお取引される口座に対応する証券会社を選択することをお勧めします。これにより、ご覧いただく相場と注文時の約定価格が一致し、データソースの違いによる価格の乖離を防ぐことができます。 --- # 取引関連 ## Q1：デモ取引について A: ### 概要 デモ取引は、実際の市場環境で仮想資金を使って取引するもので、実際のアカウントの資産に影響はありません。 #### 取引時間 模擬取引がサポートする時間帯：通常取引時間帯（全市場）、米国株式の日中取引時間帯、米国株式のプレマーケット・アフターマーケット時間帯（米国株式信用取引模擬口座のみ対応） 模擬取引がサポートしない時間帯：米国株式の夜間取引時間帯、中国A株の競売時間帯、香港株式の競売時間帯 詳細は[デモ取引ルール](https://support.moomoo.com/topic5_689?lang=zh-cn)をご覧ください。 #### サポート商品 Moomoo API でサポートされるデモ取引の商品は[こちら](../intro/intro.md#7439)を参照してください。 #### 注文 1. 注文タイプ：指値注文と成行注文。 2. 注文変更の操作タイプ：デモ取引は有効化、無効化、削除をサポートしません。注文変更と注文取消のみサポートします。 3. 約定：デモ取引は約定関連の操作をサポートしません。[当日約定の照会](../trade/get-order-fill-list.md#8740)、[過去の約定照会](../trade/get-history-order-fill-list.md#6585)、[約定プッシュコールバック](../trade/update-order-fill.md#8526)を含みます。 4. 有効期限：デモ取引の有効期限は当日有効のみサポートします。 5. 空売り：オプションと先物は空売りをサポート。株式は米国株のみ空売りをサポート。 6. 模擬取引口座では注文手数料の照会はサポートされていません。 7. 模擬取引口座では現金流れの照会はサポートされていません。 8. 組み合わせオプション注文のシナリオでは、ポジション照会をサポートしていますが、組み合わせ注文の照会は現時点でサポートしていません。 #### 操作プラットフォーム 1. モバイル端末：マイページ — デモ取引 ![sim-page](../img/en-sim-page.png) 2. デスクトップ端末：左側のデモタブ ![sim-page](../img/en-create-sim-account.png) 3. Web端末：[デモ取引画面](https://m-match.moomoo.com/simulate/) 4. Moomoo API：APIを呼び出す際、パラメータの取引環境をデモ環境に設定するだけです。詳細は[Moomoo API でのデモ取引方法](../qa/trade.md#5032)をご覧ください。 ::: tip ご注意 * 上記4つの方法は操作プラットフォームが異なるだけで、4つの方法で操作するデモ口座は共通です。 ::: ### Moomoo API でデモ取引を行うには？ #### 接続の作成 まず取引商品に応じて[対応する接続を作成](../trade/base.md#2302)します。株式またはオプションの場合は `OpenSecTradeContext` を使用し、先物の場合は `OpenFutureTradeContext` を使用してください。 #### 取引口座一覧の取得 [取引口座一覧の取得](../trade/get-acc-list.md#9630)で取引口座（デモ口座、本番口座を含む）を確認します。Python の例：戻り値の取引環境 `trd_env` が `SIMULATE` の場合、デモ口座を表します。 香港株式の模擬取引口座を取得するには、filter_trdmarketをTrdMarket.HKに指定する必要があります。この場合、2つの模擬取引口座が返されます。sim_acc_type = STOCKは香港株式模擬口座、sim_acc_type = OPTIONは香港オプション模擬口座、sim_acc_type = FUTURESは香港先物模擬口座です。 米国株式の模擬取引口座を取得するには、filter_trdmarketをTrdMarket.USに指定する必要があります。sim_acc_type = STOCK_AND_OPTIONは米国株式信用取引模擬口座を表し、株式とオプションの模擬取引が可能です。sim_acc_type = FUTURESは米国先物模擬口座です。 * **Example: Stocks and Options** ```python from moomoo import * trd_ctx = OpenSecTradeContext(filter_trdmarket=TrdMarket.HK, host='127.0.0.1', port=11111, security_firm=SecurityFirm.FUTUSECURITIES) #trd_ctx = OpenFutureTradeContext(host='127.0.0.1', port=11111, is_encrypt=None, security_firm=SecurityFirm.FUTUSECURITIES) ret, data = trd_ctx.get_acc_list() if ret == RET_OK: print(data) print(data['acc_id'][0]) # get the first account id print(data['acc_id'].values.tolist()) # convert to list format else: print('get_acc_list error: ', data) trd_ctx.close() ``` * **Output** ```python acc_id trd_env acc_type card_num security_firm \ 0 281756480572583411 REAL MARGIN 1001318721909873 FUTUSECURITIES 1 9053218 SIMULATE CASH N/A N/A 2 9048221 SIMULATE MARGIN N/A N/A sim_acc_type trdmarket_auth 0 N/A [HK, US, HKCC] 1 STOCK [HK] 2 OPTION [HK] ``` ::: tip ご注意 * デモ取引では株式口座とオプション口座が区別されます。株式口座では株式のみ、オプション口座ではオプションのみ取引可能です。Python の例：戻り値のデモ口座タイプ `sim_acc_type` が `STOCK` の場合は株式口座、`OPTION` の場合はオプション口座を表します。 ::: * **Example: Futures** ```python from moomoo import * #trd_ctx = OpenSecTradeContext(filter_trdmarket=TrdMarket.HK, host='127.0.0.1', port=11111, security_firm=SecurityFirm.FUTUSECURITIES) trd_ctx = OpenFutureTradeContext(host='127.0.0.1', port=11111, is_encrypt=None, security_firm=SecurityFirm.FUTUSECURITIES) ret, data = trd_ctx.get_acc_list() if ret == RET_OK: print(data) print(data['acc_id'][0]) # get the first account id print(data['acc_id'].values.tolist()) # convert to list format else: print('get_acc_list error: ', data) trd_ctx.close() ``` * **Output** ```python acc_id trd_env acc_type card_num security_firm sim_acc_type \ 0 9497808 SIMULATE MARGIN N/A N/A FUTURES 1 9497809 SIMULATE MARGIN N/A N/A FUTURES 2 9497810 SIMULATE MARGIN N/A N/A FUTURES 3 9497811 SIMULATE MARGIN N/A N/A FUTURES trdmarket_auth 0 [FUTURES_SIMULATE_HK] 1 [FUTURES_SIMULATE_US] 2 [FUTURES_SIMULATE_SG] 3 [FUTURES_SIMULATE_JP] ``` #### 発注 [発注API](../trade/place-order.md)を使用する際、取引環境をデモ環境に設定するだけです。Python の例：`trd_env = TrdEnv.SIMULATE`。 * **Example** ```python from moomoo import * trd_ctx = OpenSecTradeContext(filter_trdmarket=TrdMarket.HK, host='127.0.0.1', port=11111, security_firm=SecurityFirm.FUTUSECURITIES) ret, data = trd_ctx.place_order(price=510.0, qty=100, code="HK.00700", trd_side=TrdSide.BUY, trd_env=TrdEnv.SIMULATE) if ret == RET_OK: print(data) else: print('place_order error: ', data) trd_ctx.close() ``` * **Output** ```python code stock_name trd_side order_type order_status order_id qty price create_time updated_time dealt_qty dealt_avg_price last_err_msg remark time_in_force fill_outside_rth 0 HK.00700 腾讯控股 BUY NORMAL SUBMITTING 4642000476506964749 100.0 510.0 2021-10-09 11:34:54 2021-10-09 11:34:54 0.0 0.0 DAY N/A ``` #### 注文取消・注文変更 [注文変更API](../trade/modify-order.md)を使用する際、取引環境をデモ環境に設定するだけです。Python の例：`trd_env = TrdEnv.SIMULATE`。 * **Example** ```python from moomoo import * trd_ctx = OpenSecTradeContext(filter_trdmarket=TrdMarket.HK, host='127.0.0.1', port=11111, security_firm=SecurityFirm.FUTUSECURITIES) order_id = "4642000476506964749" ret, data = trd_ctx.modify_order(ModifyOrderOp.CANCEL, order_id, 0, 0, trd_env=TrdEnv.SIMULATE) if ret == RET_OK: print(data) else: print('modify_order error: ', data) trd_ctx.close() ``` * **Output** ```python trd_env order_id 0 SIMULATE 4642000476506964749 ``` #### 過去の注文照会 [過去の注文照会API](../trade/get-history-order-list.md)を使用する際、取引環境をデモ環境に設定するだけです。Python の例：`trd_env = TrdEnv.SIMULATE`。 * **Example** ```python from moomoo import * trd_ctx = OpenSecTradeContext(filter_trdmarket=TrdMarket.HK, host='127.0.0.1', port=11111, security_firm=SecurityFirm.FUTUSECURITIES) ret, data = trd_ctx.history_order_list_query(trd_env=TrdEnv.SIMULATE) if ret == RET_OK: print(data) else: print('history_order_list_query error: ', data) trd_ctx.close() ``` * **Output** ```python code stock_name trd_side order_type order_status order_id qty price create_time updated_time dealt_qty dealt_avg_price last_err_msg remark time_in_force fill_outside_rth 0 HK.00700 腾讯控股 BUY ABSOLUTE_LIMIT CANCELLED_ALL 4642000476506964749 100.0 510.0 2021-10-09 11:34:54 2021-10-09 11:37:08 0.0 0.0 DAY N/A ``` ### デモ口座のリセット方法は？ 現在 Moomoo API ではデモ口座のリセットをサポートしていません。モバイル端末で復活カードを使用して指定のデモ口座をリセットできます。リセット後、口座資金は初期値に戻り、過去の注文はクリアされます。 #### 具体的な操作 モバイル端末：マイページ — デモ取引 — プロフィール — アイテム — 復活カード。 ![sim-page](../img/en-sim-reset.png) ## Q2：A株の取引はサポートされていますか？ A: デモ取引は A株取引をサポートしています。ただし、本番取引は A株通経由で一部の A株のみ取引可能です。詳細は[A株通銘柄一覧](https://www.hkex.com.hk/Mutual-Market/Stock-Connect/Eligible-Stocks/View-All-Eligible-Securities?sc_lang=zh-HK)をご覧ください。 ## Q3：各市場でサポートされる取引方向 A: 先物以外のすべての株式は BUY と SELL の2つの取引方向のみサポートしています。ポジションなしの状態で SELL を渡した場合、生成される注文の取引方向は空売りとなります。 ## Q4：本番取引で各市場がサポートする注文タイプ A:
市場 商品 指値注文 成行注文 オークション指値注文 オークション成行注文 絶対指値注文 特別指値注文 特別指値全量
約定注文		 ストップロス成行注文 ストップロス指値注文 タッチ成行注文（利益確定） タッチ指値注文（利益確定） トレイリングストップ成行注文 トレイリングストップ指値注文
香港市場 有価証券（株式、ETF、
ワラント、CBBC、インラインワラントを含む）		 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
オプション ✓ X - - - - - X ✓ X ✓ X ✓
先物 ✓ ✓ - ✓ - - - ✓ ✓ ✓ ✓ ✓ ✓
米国市場 有価証券（株式、ETFを含む） ✓ ✓ - - - - - ✓ ✓ ✓ ✓ ✓ ✓
オプション ✓ ✓ - - - - - ✓ ✓ ✓ ✓ ✓ ✓
先物 ✓ ✓ - - - - - ✓ ✓ ✓ ✓ ✓ ✓
A株通市場 有価証券（株式、ETFを含む） ✓ X - - - - - X ✓ X ✓ X ✓
シンガポール市場 先物 ✓ ✓ - - - - - ✓ ✓ ✓ ✓ ✓ ✓
日本市場 先物 ✓ ✓ - - - - - ✓ ✓ ✓ ✓ ✓ ✓
## Q5：各市場でサポートされる注文操作 A: * 香港株は注文変更、注文取消、有効化、無効化、削除をサポート * 米国株は注文変更と注文取消のみサポート * A株通は注文取消のみサポート * 先物は注文変更、注文取消、削除をサポート ## Q6：OpenD 起動パラメータ future_trade_api_time_zone の使い方は？ A：先物口座がサポートする取引商品はグローバルの複数の取引所に分散しており、取引所のタイムゾーンもそれぞれ異なるため、先物取引 API の時間表示が問題になります。 OpenD 起動パラメータに future_trade_api_time_zone パラメータが追加され、世界各地の先物トレーダーが柔軟にタイムゾーンを指定できます。デフォルトのタイムゾーンは UTC+8 で、米東時間の方が慣れている場合は UTC-5 に設定するだけです。 ::: tip ご注意 + このパラメータは先物取引APIクラスのオブジェクトにのみ有効です。香港株取引、米国株取引、A株通取引のAPIクラスオブジェクトのタイムゾーンは、引き続き取引所所在地のタイムゾーンで表示されます。 + このパラメータが影響するAPIは、注文プッシュコールバック、約定プッシュコールバック、当日注文照会、過去の注文照会、当日約定照会、過去の約定照会、発注です。 ::: ## Q7：API 経由の注文はアプリで確認できますか？ A：確認できます。 Moomoo API 経由で発注コマンドの送信に成功すると、アプリの**取引**ページで当日注文、注文状態、約定状況等を確認できます。また、**メッセージ—注文メッセージ**で約定通知を受け取ることもできます。 ## Q8：どの商品が非取引時間帯の発注をサポートしていますか？ A：すべての注文は、約定するには取引時間中である必要があります。 Moomoo API は一部の商品について**非取引時間帯の発注**機能をサポートしています（アプリではより多くの商品の非取引時間帯発注をサポート）。具体的には下表をご覧ください。
市場 銘柄タイプ デモ取引 本番取引
Futu HK Moomoo US Moomoo SG Moomoo AU Moomoo MY Moomoo CA Moomoo JP
香港市場 株式、ETF、ワラント、CBBC、インラインワラント ✓ ✓ ✓ ✓ ✓ ✓ X X
オプション (指数オプションを含む。先物口座での取引が必要) ✓ ✓ X X X X X X
先物 ✓ ✓ X X X X X X
米国市場 株式、ETF ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
オプション ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
先物 ✓ ✓ X ✓ X ✓ X X
A株市場 A株通株式 ✓ ✓ ✓ ✓ X X X X
非A株通株式 ✓ X X X X X X X
シンガポール市場 株式、ETF、ワラント、REIT、DLC X X X X X X X X
先物 ✓ ✓ X ✓ X X X X
日本市場 株式、ETF、REIT X X X X X X X X
先物 ✓ ✓ X X X X X X
オーストラリア市場 株式、ETF X X X X X X X X
カナダ市場 株式 X X X X X X X X
::: tip ご注意 - ✓：非取引時間帯の発注をサポート - X：非取引時間帯の発注を未サポート（または取引自体を未サポート） ::: ## Q9：発注APIにおいて、各注文タイプの必須パラメータおよび証券会社の1注文あたりの制限 A1: 各注文タイプの必須パラメータ
パラメータ 指値注文 成行注文 オークション指値注文 オークション成行注文 絶対指値注文 特別指値注文 特別指値全量
約定注文		 ストップロス成行注文 ストップロス指値注文 タッチ成行注文（利益確定） タッチ指値注文（利益確定） トレイリングストップ成行注文 トレイリングストップ指値注文
price ✓ ✓ ✓ ✓ ✓ ✓ ✓
qty ✓ ✓✓✓✓✓ ✓✓✓✓✓ ✓✓
code ✓ ✓✓✓✓✓ ✓✓✓✓✓ ✓✓
trd_side ✓ ✓✓✓✓✓ ✓✓✓✓✓ ✓✓
order_type ✓ ✓✓✓✓✓ ✓✓✓✓✓ ✓✓
trd_env ✓ ✓✓✓✓✓ ✓✓✓✓✓ ✓✓
aux_price ✓✓✓✓
trail_type ✓✓
trail_value ✓✓
trail_spread ✓
`Python ユーザー` はご注意ください。[place_order](../trade/place-order.html#8194) は price にデフォルト値を設定していないため、上記5つの注文タイプでも price の入力が必要です。price には任意の値を渡せます。 A2：各証券会社の1注文あたりの株数・金額の上限
証券会社 商品 1注文あたりの株数上限 1注文あたりの金額上限
FUTU HK A株通 1,000,000 株 ￥5,000,000
米国株 500,000 株 $5,000,000
香港株先物/オプション 3,000 枚 制限なし
moomoo US 米国株 500,000 株 $10,000,000
moomoo SG 米国株 500,000 株 $5,000,000
moomoo AU 米国株 制限なし 制限なし
## Q10：注文変更APIにおいて、注文変更時の各注文タイプの必須パラメータ A:
パラメータ 指値注文 成行注文 オークション指値注文 オークション成行注文 絶対指値注文 特別指値注文 特別指値全量
約定注文		 ストップロス成行注文 ストップロス指値注文 タッチ成行注文（利益確定） タッチ指値注文（利益確定） トレイリングストップ成行注文 トレイリングストップ指値注文
modify_order_op ✓ ✓✓✓✓✓ ✓✓✓✓✓ ✓✓
order_id ✓ ✓✓✓✓✓ ✓✓✓✓✓ ✓✓
price ✓ ✓ ✓ ✓ ✓ ✓ ✓
qty ✓ ✓✓✓✓✓ ✓✓✓✓✓ ✓✓
trd_env ✓ ✓✓✓✓✓ ✓✓✓✓✓ ✓✓
aux_price ✓✓✓✓
trail_type ✓✓
trail_value ✓✓
trail_spread ✓
`Python ユーザー` はご注意ください。[modify_order](../trade/modify-order.html#5781) は price にデフォルト値を設定していないため、上記5つの注文タイプでも price の入力が必要です。price には任意の値を渡せます。 ## Q11：取引APIが「当該証券取引口座は免責契約に同意していません」を返す？ A： 以下のリンクで契約確認を完了し、OpenD を再起動すれば取引機能を正常に使用できます。 所属証券会社|契約確認 :-|:-|:- FUTU HK|[こちら](https://risk-disclosure.futuhk.com/index?agreementNo=HKOT0015) Moomoo US|[こちら](https://risk-disclosure.us.moomoo.com/index?agreementNo=USOT0027) Moomoo SG|[こちら](https://risk-disclosure.sg.moomoo.com/index?agreementNo=SGOT0015) Moomoo AU|[こちら](https://risk-disclosure.au.moomoo.com/index?agreementNo=AUOT0025) Moomoo CA|[こちら](https://risk-disclosure.ca.moomoo.com/index?agreementNo=CAOT0117) Moomoo MY|[こちら](https://risk-disclosure.my.moomoo.com/index?agreementNo=MYOT0066) Moomoo JP|[こちら](https://risk-disclosure.jp.moomoo.com/index?agreementNo=JPOT0140) ## Q12：パターンデイトレーダー（PDT）について ### 概要 moomoo証券(米国) 口座での日中取引は、米国 FINRA の規制制限を受けます（これは米国の証券会社が受ける規制要件であり、取引する株式の所属市場とは無関係です。他の国・地域の証券会社 (例：moomoo証券(香港)、moomoo証券(シンガポール)) の取引口座はこの制限を受けません）。連続5営業日以内に日中取引を3回以上行うと、パターンデイトレーダー（PDT）としてマークされます。 詳細は[こちら](https://www.moomoo.com/us/hans/support/topic4_5?=zh-cn)をご覧ください ### 日中取引のフローチャート ![PDT_process](../img/PDT_process.png) ### PDT としてマークされてもよく、プログラム取引を中断したくない場合、「PDT マーク防止」を無効にするには？ A： 連続5営業日以内に4回目の日中取引を行う際、無意識にPDTとしてマークされることを防ぐため、サーバーがこの取引をブロックします。意図的にPDTとしてマークされたい場合でサーバーのブロックを希望しない場合は、以下の対策を取ってください。 [コマンドライン OpenD でパラメータを設定](../opend/opend-cmd.html#9467)し、起動パラメータ `pdt_protection` の値を 0 に変更して「パターンデイトレーダーとしてマークされることを防止する」機能を無効にします。 ![US_para](../img/US_para.png) ご注意：PDT としてマークされた場合、口座資産が $25000 未満の場合は新規建てができなくなります。 ### DTCall 警告通知を無効にするには？ A： PDT としてマークされた後は、口座の日中取引購買力（DTBP）に注意が必要です。日中取引が DTBP を超えると Day-Trading Call（DTCall）が発生します。サーバーは、残りの日中取引購買力を超える新規建て注文をブロックします。それでも発注を希望し、サーバーのブロックを望まない場合は、以下の対策を取ってください。 [コマンドライン OpenD でパラメータを設定](../opend/opend-cmd.html#9467)し、起動パラメータ `dtcall_confirmation` の値を 0 に変更して「日中取引マージンコール警告」機能を無効にします。 ![US_para2](../img/US_para2.png) ご注意：開建て注文の市場価額が残りの日中取引購買力を超え、本日中に対象銘柄を決済した場合、Day-Trading Call（DTCall）が発生し、入金のみで解除可能です。 ### DTBP の値を確認するには？ A： [口座資金の照会](../trade/get-funds.html#8738)APIで、日中取引関連の戻り値（残りの日中取引回数、初期日中取引購買力、残りの日中取引購買力等）を取得できます。 ## Q13：注文の約定状態を追跡するには A: 発注後、以下のAPIで注文の約定状態を追跡できます。
取引環境 API
本番取引 [注文プッシュコールバック](../trade/update-order.html)、[約定プッシュコールバック](../trade/update-order-fill.html)
デモ取引 [注文プッシュコールバック](../trade/update-order.html)
ご注意：非 Python ユーザーは上記2つのAPIを使用する前に、先に[取引プッシュの登録](../trade/sub-acc-push.html)を行う必要があります #### 注文プッシュコールバックの特徴： 注文全体の情報変更をフィードバックします。以下の8つのフィールドが変更された場合、注文プッシュがトリガーされます： `注文状態`、`注文価格`、`注文数量`、`約定数量`、`トリガー価格`、`トラッキングタイプ`、`トラッキング金額/パーセンテージ`、`指定スプレッド` したがって、発注、注文変更、注文取消、有効化、無効化の操作、または市場で高度な注文がトリガーされたり約定変動があった場合、すべて注文プッシュがトリガーされます。[約定プッシュコールバック](../trade/update-order-fill.html)を呼び出すだけでこれらの情報を監視できます。 #### 約定プッシュコールバックの特徴： 単一約定の情報のみフィードバックします。以下の1つのフィールドが変更された場合、プッシュがトリガーされます： `約定状態` 例：指値注文 900 株が3回に分けて完全約定し、各回の約定がそれぞれ 200、300、400 株の場合。 ![example](../img/example.png) ## Q14：発注APIが「この商品の最小単位は xxx です。最小単位の整数倍に調整してから再度送信してください」を返す？ A: 市場ごとに取引所が異なる最小変動単位を要求しています。注文価格が要求を満たさない場合、注文は拒否されます。各市場の呼値ルールは以下の通りです。 ### 呼値ルール #### 香港市場 香港証券取引所の公式説明に準じます。[こちら](https://www.moomoo.com/us/hans/support/topic4_304)をクリックしてください。 #### A株市場 株式の呼値：0.01。 #### 米国市場 株式の呼値：
約定価格 呼値
$1 未満 $0.0001
$1 以上 $0.01
オプションの呼値：
約定価格 呼値
$0.10 - $3.00 $0.01 または $0.05
$3.00 以上 $0.05 または $0.10
先物の呼値：合約により異なります。[先物合約情報の取得](../quote/get-future-info.html#5542)APIの戻り値フィールド `最小変動の単位` で確認できます。 ### 注文価格が呼値に合わない事態を避けるには？ * 方法1：[リアルタイム板情報の取得](../quote/get-order-book.html)APIで正しい取引価格を取得します。取引所の板情報上の価格は必ず正しい呼値です。 * 方法2：[発注](../trade/place-order.html)APIのパラメータ `価格微調整幅` を使用して、入力価格を自動的に正しい取引価格に調整します。 例：テンセントホールディングスの現在の市場価格が 359.600 の場合、呼値ルールに基づく最小変動呼値は 0.200 です。 発注時の入力注文価格が 359.678、価格微調整幅が 0.0015 の場合、入力価格を最も近い正しい呼値まで上方調整することを許可し、0.15% を超えないことを意味します。この場合、上方の最も近い正しい価格は 359.800 で、実際の調整幅は 0.034% であり、価格微調整幅の要件を満たすため、最終的な注文価格は 359.800 となります。 価格微調整幅の設定値が実際に必要な調整幅より小さい場合、OpenD の自動価格調整は失敗し、注文はエラー「注文価格が呼値上にありません」を返します。 ## Q15：購買力は十分なのに、成行注文が「購買力不足」を返すのはなぜ？ A： ### 成行注文で購買力不足と表示される理由 - リスク管理の観点から、成行注文にはより高い購買力係数が適用されています。すべての注文パラメータが同一の場合、成行注文は指値注文よりも多くの購買力を消費します。 - また、商品や市場状況に応じて、リスク管理システムは成行注文の購買力係数を動的に調整します。そのため、成行注文を出す際に最大購買力から最大購入可能数量を計算しても、結果は正確でない可能性が高いです。 ### 正確な購入可能数量の計算方法 自分で計算することは推奨しません。[最大購入・売却可能数量の照会](../trade/get-max-trd-qtys.html)APIで正確な購入可能数量を取得できます。 ### できるだけ多く購入するには 対当て価格の指値注文で成行注文を代替して取引できます。 ここで対当て価格とは：買1価格（売り注文の場合）または 売1価格（買い注文の場合） ## Q16：moomoo証券の新しいAPIの提供を開始いたしました A： このたび、moomoo証券の新しいAPIの提供を開始いたしました。新たに「米国株信用取引のデモ口座」に対応し、取引機能がさらに充実しました。 なお、旧APIの米国株デモ取引サービスは、今後順次提供を終了いたします。引き続き快適な環境で米国株デモ取引をご利用いただくため、お早めに新APIへの切り替えをお願いいたします。 ## Q17：取引APIパラメータの使用説明 ### 1. 取引オブジェクトとは？ プラットフォームアカウントには通常、1つのマージン総合口座が開設されており、その中に複数の取引サブ口座があります（通常2つ：総合証券口座と総合先物口座。必要に応じて総合外国為替口座等の他のサブ口座がある場合もあります）。一部の特殊ユーザーや機関投資家は、複数の証券会社で複数の総合口座を開設している場合があります。 取引オブジェクトの作成は、サブ口座の初期フィルタリングプロセスです。 - OpenSecTradeContext で作成した取引オブジェクトは、get_acc_list 呼び出し時に**証券取引口座**のみ返します - OpenFutureTradeContext で作成した取引オブジェクトは、get_acc_list 呼び出し時に**先物取引口座**のみ返します パラメータ security_firm は対応する所属証券会社の口座をフィルタし、パラメータ filter_trdmarket は対応する取引市場権限の口座をフィルタします。 #### 1.1 security_firm 証券会社パラメータ Moomoo API が現在サポートする証券会社は[こちら](../trade/trade.html#6462)をご覧ください。 作成した取引オブジェクトは、get_acc_list 呼び出し時に security_firm に対応する証券会社の本番口座とすべてのデモ取引口座を返します（デモ取引には証券会社の概念がないため、security_firm に何を渡してもすべてのデモ口座が返されます）。 security_firm のデフォルト値は FUTUSECURITIES で、FUTU HK 証券会社の口座はこのパラメータを省略できますが、他の証券会社の口座を取得する際は証券会社パラメータの変更が必要です。 * **Example 1** ```python trd_ctx = OpenSecTradeContext(security_firm=SecurityFirm.FUTUSECURITIES) ret, data = trd_ctx.get_acc_list() print(data) ``` * **Output** ```python acc_id trd_env acc_type uni_card_num card_num security_firm sim_acc_type trdmarket_auth acc_status 0 281756478396547854 REAL MARGIN 1001200163530138 1001369091153722 FUTUSECURITIES N/A [HK, US, HKCC, HKFUND, USFUND] ACTIVE 1 3450309 SIMULATE CASH N/A N/A N/A STOCK [HK] ACTIVE 2 3548731 SIMULATE MARGIN N/A N/A N/A OPTION [HK] ACTIVE 3 281756455998014447 REAL MARGIN N/A 1001100320482767 FUTUSECURITIES N/A [HK] DISABLED ``` * **Example 2** ```python trd_ctx = OpenSecTradeContext(security_firm=SecurityFirm.FUTUSG) ret, data = trd_ctx.get_acc_list() print(data) ``` * **Output** ```python acc_id trd_env acc_type uni_card_num card_num security_firm sim_acc_type trdmarket_auth acc_status 0 3450309 SIMULATE CASH N/A N/A N/A STOCK [HK] ACTIVE 1 3548731 SIMULATE MARGIN N/A N/A N/A OPTION [HK] ACTIVE ``` #### 1.2 filter_trdmarket 取引市場パラメータ Moomoo API が現在サポートする取引市場は[こちら](../trade/trade.html#4416)をご覧ください。 作成した取引オブジェクトは、get_acc_list 呼び出し時に filter_trdmarket 市場の取引権限を持つすべての口座を返します。filter_trdmarket に NONE を渡すと市場フィルタなしで全口座を返します。 filter_trdmarket のデフォルトパラメータは HK で、総合口座体系では、このパラメータは異なる市場のデモ取引口座をフィルタするために使用されます。 * **Example 1** ```python trd_ctx = OpenSecTradeContext(filter_trdmarket=TrdMarket.US) ret, data = trd_ctx.get_acc_list() print(data) ``` * **Output** ```python acc_id trd_env acc_type uni_card_num card_num security_firm sim_acc_type trdmarket_auth acc_status 0 281756478396547854 REAL MARGIN 1001200163530138 1001369091153722 FUTUSECURITIES N/A [HK, US, HKCC, HKFUND, USFUND] ACTIVE 1 3450310 SIMULATE MARGIN N/A N/A N/A STOCK [US] ACTIVE 2 3548732 SIMULATE MARGIN N/A N/A N/A OPTION [US] ACTIVE 3 281756460292981743 REAL MARGIN N/A 1001100520714263 FUTUSECURITIES N/A [US] DISABLED ``` * **Example 2** ```python trd_ctx = OpenSecTradeContext(filter_trdmarket=TrdMarket.NONE) ret, data = trd_ctx.get_acc_list() print(data) ``` * **Output** ```python acc_id trd_env acc_type uni_card_num card_num security_firm sim_acc_type trdmarket_auth acc_status 0 281756478396547854 REAL MARGIN 1001200163530138 1001369091153722 FUTUSECURITIES N/A [HK, US, HKCC, HKFUND, USFUND] ACTIVE 1 3450309 SIMULATE CASH N/A N/A N/A STOCK [HK] ACTIVE 2 3450310 SIMULATE MARGIN N/A N/A N/A STOCK [US] ACTIVE 3 3450311 SIMULATE CASH N/A N/A N/A STOCK [CN] ACTIVE 4 3548732 SIMULATE MARGIN N/A N/A N/A OPTION [US] ACTIVE 5 3548731 SIMULATE MARGIN N/A N/A N/A OPTION [HK] ACTIVE 6 281756455998014447 REAL MARGIN N/A 1001100320482767 FUTUSECURITIES N/A [HK] DISABLED 7 281756460292981743 REAL MARGIN N/A 1001100520714263 FUTUSECURITIES N/A [US] DISABLED 8 281756468882916335 REAL MARGIN N/A 1001100610464507 FUTUSECURITIES N/A [HKCC] DISABLED 9 281756507537621999 REAL CASH N/A 1001100910390035 FUTUSECURITIES N/A [HKFUND] DISABLED 10 281756550487294959 REAL CASH N/A 1001101010406844 FUTUSECURITIES N/A [USFUND] DISABLED ``` ::: tip ご注意 filter_trdmarket に NONE を渡すと、すべての取引口座を返します。0行目は本番口座、1～5行目はすべてデモ取引口座、6～10行目は無効化された本番口座です。これらの無効口座は単一市場口座で、現在は総合口座に置き換えられています。ただし、過去の注文と過去の約定はこれらの無効口座に残っているため、これらの口座で照会できます。 OpenFutureTradeContext オブジェクトには filter_trdmarket パラメータはなく、security_firm パラメータのみで、OpenSecTradeContext と同じ機能です。 ::: ### 2. 取引APIパラメータ 具体的な取引API（発注、注文一覧照会等）を使用する際、APIの `trd_env`、`acc_index`、`acc_id` パラメータでまず一意の口座を特定し、その口座に対して対応するAPI操作を実行します。 ![acc-select](../img/acc-select-en.png) ::: tip まとめ 1. trd_env に基づいて本番口座かデモ口座かをフィルタ 2. フィルタ結果から acc_id で指定された口座を優先選択 3. acc_id が 0 の場合、acc_index で対応する口座を選択 4. エラーケース：指定された acc_id が存在しない、または acc_index が範囲外 ::: ### 3. 使用例 #### 3.1 総合証券口座での本番発注 ```python trd_ctx = OpenSecTradeContext(filter_trdmarket=TrdMarket.NONE, security_firm=SecurityFirm.FUTUSECURITIES) ret, data = trd_ctx.unlock_trade("123123") if ret == RET_OK: print("解锁成功") ret, data = trd_ctx.place_order(45, 200, 'HK.00700', TrdSide.BUY, order_type=OrderType.NORMAL, trd_env=TrdEnv.REAL, # デフォルトパラメータと同じため省略可能 acc_id=0) # デフォルトパラメータと同じため省略可能 print(data) ``` #### 3.2 総合先物口座での本番注文一覧照会 ```python trd_ctx = OpenFutureTradeContext(security_firm=SecurityFirm.FUTUSECURITIES) ret, data = trd_ctx.order_list_query(trd_env=TrdEnv.REAL, # デフォルトパラメータと同じため省略可能 acc_id=0) # デフォルトパラメータと同じため省略可能 print(data) ``` #### 3.3 香港株デモ現金口座の口座資金照会 ```python # filter_trdmarket に TrdMarket.HK を指定 # trd_env に TrdEnv.SIMULATE を指定 # acc_index に 0 を指定 trd_ctx = OpenSecTradeContext(filter_trdmarket=TrdMarket.HK) ret, data = trd_ctx.accinfo_query(trd_env=TrdEnv.SIMULATE, acc_index=0) print(data) ``` #### 3.4 米国株デモマージン口座でのオプション発注 ```python # filter_trdmarket と trd_env でフィルタ後、2口座のみ残る # 0番目は米国株現金口座（株式取引用）、1番目は米国株マージン口座（オプション取引用） # acc_index に 1 を指定して米国株マージン口座を選択 trd_ctx = OpenSecTradeContext(filter_trdmarket=TrdMarket.US) ret, data = trd_ctx.place_order(10, 1, code="US.AAPL250618P550000",trd_side=TrdSide.BUY, trd_env=TrdEnv.SIMULATE, acc_index=1) print(data) ``` #### 3.5 日本先物デモ口座の最大購入・売却可能数量照会 ```python # get_acc_list の結果を表示すると、日本先物デモ口座の acc_id が 6271199 であることが確認できる # 最大購入・売却可能数量のリクエスト時にこの acc_id を渡す trd_ctx = OpenFutureTradeContext() ret, data = trd_ctx.acctradinginfo_query(order_type=OrderType.NORMAL, price=5000, trd_env=TrdEnv.SIMULATE, acc_id=6271199, code="JP.NK225main") print(data) ``` ### 4. API の口座はアプリ/デスクトップ端末とどう対応するか ![card-app](../img/card-app-en.png) アプリではカード番号の下4桁のみ表示されます。[get_acc_list](../trade/get-acc-list.html)の戻り値には uni_card_num 列と card_num 列があり、それぞれ総合口座のカード番号と単一通貨口座（廃止済み）のカード番号に対応します。カード番号の下4桁でAPIで取得した口座とアプリ上の口座を対応付けできます。 --- # その他 ## Q1：C++ API のコンパイル方法は？ A: moomoo API C++ SDK は Windows/MacOS/Linux をサポートしています。各 OS に以下のコンパイル環境で生成されたライブラリファイルが提供されます。 OS|コンパイルツール :-|:- Windows |Visual Studio 2013 Centos 7|g++ 4.8.5 Ubuntu 16.04|g++ 5.4.0 MacOS | XCode 11 コンパイラバージョンが異なる場合、または依存する protobuf のバージョンが異なる場合は、ソースコードから MMAPI と protobuf を再コンパイルする必要があるかもしれません。ソースコードの場所は下図のディレクトリをご覧ください。 ``` MMAPIディレクトリ構造： +---Bin 各OS向けデフォルトコンパイル環境でビルドされた依存ライブラリ +---Include 共有ヘッダファイルおよびprotoプロトコルから生成された.h/.ccファイル +---Sample サンプルプロジェクト \---Src +---MMAPI MMAPIソースコード +---protobuf-all-3.5.1.tar.gz protobufソースコード ``` #### コンパイル手順： 1. protobuf の再コンパイル：libprotobuf 静的ライブラリの生成 2. プロトコル proto ファイルから C++ ファイルを生成 3. MMAPI の再コンパイル：ソースは Src/MMAPI にあり、libMMAPI 静的ライブラリを生成 #### ステップ1：protobuf の再コンパイル： - Windows： - CMake をインストール - VS コマンドラインツールを開き、protobuf/cmake ディレクトリに cd - 実行：cmake -G "Visual Studio 12 2019" -DCMAKE_INSTALL_PREFIX=install -Dprotobuf_BUILD_TESTS=OFF これにより Visual Studio 2019 のプロジェクトファイルが生成されます。他のバージョンの Visual Studio では -G パラメータを変更してください - 生成された Visual Studio プロジェクトファイルを開き、プラットフォームツールセットを v120_xp に設定してコンパイル - Linux（protobuf/src/README を参照） - ./autogen.sh を実行 - CXXFLAGS="-std=gnu++11" ./configure --disable-shared を実行 - make を実行 - 生成された libprotobuf.a を Bin/Linux ディレクトリに配置 - MacOS（protobuf/src/README を参照） - brew でこれらの依存ライブラリをインストール：autoconf automake libtool - ./configure CC=clang CXX="clang++ -std=gnu++11 -stdlib=libc++" --disable-shared を実行 #### ステップ2: proto コードの再生成 - 上記の Protobuf コンパイル後に protoc 実行ファイルが同時に生成されます。protoc を使用して Include/Proto 配下の .proto ファイルから対応する .h と .cc ファイルを生成します。例えば以下のコマンドで Common.proto から対応する Common.pb.h と Common.pb.cc が生成されます - protoc -I="MMAPI パス/Include/Proto" --cpp_out="." MMAPI パス/Include/Proto/Common.proto - 生成された .h と .cc ファイルを Include/Proto に配置 #### ステップ3: MMAPI の再コンパイル - Windows：Visual Studio で C++ 静的ライブラリプロジェクトを新規作成し、Src/MMAPI と Include 配下のソースコードを追加して、プラットフォームツールセットを v120_xp に設定してコンパイル - Mac：Xcode で C++ 静的ライブラリプロジェクトを新規作成し、Src/MMAPI と Include 配下のソースコードを追加してコンパイル - Linux：CMake を使用して MMAPI 静的ライブラリをコンパイル。MMAPI パス/Src ディレクトリで実行： - cmake -DTARGET_OS=Linux ## Q2：より完全な戦略サンプルはありますか？ A: * Python 戦略サンプルは /moomoo/examples/ フォルダにあります。以下のコマンドで Python API のインストールパスを確認できます。 ``` import moomoo print(moomoo.__file__) ``` * C# 戦略サンプルは /MMAPI4NET/Sample/ フォルダにあります * Java 戦略サンプルは /MMAPI4J/sample/ フォルダにあります * C++ 戦略サンプルは /MMAPI4CPP/Sample/ フォルダにあります * JavaScript 戦略サンプルは /MMAPI4JS/sample/ フォルダにあります ## Q3：Python API の import でエラーが発生する **ケース1**：Python 環境に moomoo モジュールをインストール済みなのに、No module named 'moomoo' と表示される？ 現在の IDE で使用している interpreter が moomoo モジュールをインストールした interpreter と異なる可能性が高いです。つまり、PCに2つ以上の Python 環境がインストールされている可能性があります。 以下の2ステップを実行してください。 1. Python で以下のコードを実行し、現在の interpreter のパスを確認します。 ``` import sys print(sys.executable) ``` サンプル図： ![No module named 'moomoo'](../img/import-futu-error.png) 2. コマンドラインで `$ D:\software\anaconda3\python.exe -m pip install moomoo-api` を実行します（前半のファイルパスはステップ1で表示されたパスです）。 これにより、現在の interpreter にも moomoo モジュールがインストールされます。 ## Q4：import は成功したが、APIを呼び出せない？ A：この場合、通常は正しい moomoo API モジュールがインポートされているか確認が必要です。以下のケースでも import が成功することがあります。 **ケース1**：「moomoo」と同名のファイルが存在する 1. 現在のファイル名が moomoo.py 2. 現在のファイルと同じディレクトリに moomoo.py という名前の別のファイルが存在する 3. 現在のファイルと同じディレクトリに `/moomoo` というフォルダが存在する そのため、ファイル/フォルダ/プロジェクトに「moomoo」と命名しないことを強く推奨します。 **ケース2**：「moomoo」という名前の第三者ライブラリを誤ってインストールした moomoo API の正式名称は `moomoo-api` であり、「moomoo」ではありません。 「moomoo」という名前の第三者ライブラリをインストール済みの場合はアンインストールし、[moomoo-api をダウンロード](../quick/demo.md#5708)してください。 PyCharm での例：第三者ライブラリのインストール状況を確認します。 ![settings](../img/settings.png) ![moomooku](../img/mmku.png) ## Q5：プロトコル暗号化について A: ### 概要 非対称暗号化アルゴリズム RSA を使用して、戦略プログラム（moomoo API）と OpenD 間のリクエストとレスポンスの内容を暗号化し、通信の安全性を確保できます。 戦略プログラム（moomoo API）と OpenD が同一PC上にある場合、通常は暗号化不要です。 ### プロトコル暗号化の手順 以下のステップでこの問題を解決できます。 1. 第三者の Web プラットフォームで自動的に鍵ファイルを生成します。 - 具体的な方法：baidu または google で「RSA オンライン生成」を検索し、**鍵形式**を PKCS#1、**鍵長**を 1024 bit に設定し、秘密鍵パスワードは未設定のまま、**鍵ペアを生成**をクリックします。 ![ui-config](../img/create_rsa.png) 2. 生成された **RSA 暗号化秘密鍵** をテキストファイルにコピー＆ペーストし、OpenD のあるPCの指定パスに保存します。 3. OpenD のあるPCで、**RSA 暗号化秘密鍵** のパスを指定します。 - 方法1：[GUI版 OpenD](../quick/opend-base.md#8384) 起動画面右側の「暗号化秘密鍵」欄で、前のステップで **RSA 暗号化秘密鍵** を保存したパスを指定します。下図参照： ![ui-config](../img/mmrsa_ui-config.png) - 方法2：[コマンドライン OpenD](../opend/opend-cmd.md#9467) 起動ファイル OpenD.xml で、パラメータ `rsa_private_key` にステップ2の **RSA 暗号化秘密鍵** のパスを設定します。下図参照： ![ui-config](../img/rsa_xml.png) 4. ステップ2の txt ファイルを戦略プログラム（moomoo API）のあるPCの指定パスに別名保存し、戦略プログラムでこのパスを[秘密鍵パスとして設定](../ftapi/init.md#4820)します。 5. 戦略プログラム（moomoo API）でプロトコル暗号化を有効にします。有効化には2つの方法があり、方法2の優先度が高くなります。 - 方法1：単一接続の暗号化（共通）。[相場オブジェクト](../quote/base.md#795)または[取引オブジェクト](../trade/base.md#4970)の接続作成時に、**暗号化を有効にする**パラメータで設定します。 - 方法2：全接続の暗号化（Python のみ）。`enable_proto_encrypt` インターフェースで設定します。詳細は[こちら](../ftapi/init.md#1561)。 :::tip ご注意 * OpenD または戦略プログラム（moomoo API）で **RSA 暗号化秘密鍵** パスを指定する際は、txt ファイル自体のパスを指定する必要があります。 * RSA 暗号化公開鍵は保存不要です。秘密鍵から計算できます。 ::: ## Q6：取得した DataFrame データの一部しか表示されないのはなぜ？ A：pandas.DataFrame データを表示する際、行列数が多い場合、pandas はデフォルトでデータを折りたたむため、表示が不完全に見えます。 APIの戻り値データが実際に不完全なわけではありません。Python スクリプトの先頭に以下のコードを追加するだけで解決できます。 ``` import pandas as pd pd.options.display.max_rows=5000 pd.options.display.max_columns=5000 pd.options.display.width=1000 ``` ## Q7：Mac で C++ API を使用中、「libFTAPIChannel.dylib を開けません」というエラーが発生する A：対応するライブラリディレクトリで以下のコマンドを実行すると解決できます：`$ xattr -r -d com.apple.quarantine libAPIChannel.dylib`。 ## Q8：Python ユーザー。OpenD 設定ファイルでログレベルを no に設定しても、log フォルダに大容量のログファイルが生成され続けるのはなぜ？ A：OpenD 設定ファイルのログレベルパラメータは OpenD が生成するログのみを制御します。Python API もデフォルトでログを生成します。Python API のログを無効にしたい場合は、Python スクリプトに以下の記述を追加してください。 ``` logger.file_level = logging.FATAL # Python API ログの無効化 logger.console_level = logging.FATAL # Python 実行時のコンソールログの無効化 ``` ## Q9：バージョン 5.4 以上の Java API のライブラリ名と設定方法の変更について A: * Java API 5.3 以下のバージョンをお使いのユーザーは、バージョン更新時に以下の変更にご注意ください。 **設定フローの変更**： 1. [moomoo 公式サイト](https://www.moomoo.com/download/)から moomoo API をダウンロードします。 2. ダウンロードした mmAPI ファイルを解凍します。`/MMAPI4J` が Java API のディレクトリです。ディレクトリ構造内の `/lib/moomoo-api-.x.y.z.jar` をプロジェクト設定に追加してください。moomoo-api プロジェクトの作成は[こちら](../quick/demo.html#3364)を参照してください。 **ディレクトリ構造の変更**： 1. moomoo API の Java 版のライブラリ名が、従来の mmapi4j.jar から `moomoo-api-x.y.z.jar` に変更されました（「x.y.z」はバージョン番号）。 2. 第三者ライブラリの参照から /lib/jna.jar と /lib/jna-platform.jar の依存が削除され、`/lib/bcprov-jdk15on-1.68.jar` と `/lib/bcpkix-jdk15on-1.68.jar` の依存が追加されました。 ``` +---mmapi4j moomoo-apiのソースコード。使用中のJDKバージョンと互換性がない場合はこのプロジェクトから再コンパイル可能 +---lib 共有ライブラリファイルの格納先 | moomoo-api-x.y.z.jar moomoo API の Java バージョン | bcprov-jdk15on-1.68.jar サードパーティライブラリ。暗号化・復号に使用 | bcpkix-jdk15on-1.68.jar サードパーティライブラリ。暗号化・復号に使用 | protobuf-java-3.5.1.jar サードパーティライブラリ。protobufデータの解析に使用 +---sample サンプルプロジェクト +---resources mavenプロジェクトのデフォルト生成ディレクトリ ``` * 初めて moomoo API をお使いの場合は、より便利な maven リポジトリでの Java API 設定方法を提供しています。設定フローは[こちら](../quick/demo.html#7328)を参照してください。 ## Q10：Python ユーザー。pyinstaller でスクリプトをパッケージ化する際に Common_pb2 モジュールが見つからないエラーが発生する A：以下のステップで問題を解決できます。 1. main.py をパッケージ化する場合の例です。コマンドラインで pyinstaller main.py を実行します。パラメータ「-F」は付けないでください（path は main.py のパスです） ``` pyinstaller path\main.py ``` パッケージ化成功後、main.py と同じディレクトリの /dist 内に /main フォルダが生成され、main.exe がこのフォルダ内にあります。 ![dist](../img/mmdist.png) 2. 以下のコードを実行して、moomoo-api のインストールディレクトリを確認します。 ``` import moomoo print(moomoo.__file__) ``` 実行結果: ``` C:\Users\ceciliali\Anaconda3\lib\site-packages\moomoo\__init__.py ``` ![path_futu](../img/pathmoomoo.png) 3. 上図フォルダ内の /common/pb のすべてのファイルを /main にコピーします。 4. /main 内に moomoo という名前のフォルダを作成し、上図フォルダ内の `VERSION.txt` ファイルを /main/moomoo にコピーします。 ![main_futu](../img/main_moomoo.png) 5. main.exe を再度実行してみてください ## Q11：API呼び出し結果は正常だが、戻り値が期待と異なる？ A: * API呼び出し結果が正常であれば、moomoo がリクエストを正常に受信・応答したことを意味しますが、戻り値の表現が期待と異なる場合があります。 例：非取引時間帯に[登録](../quote/sub.md)APIを呼び出した場合、リクエストは正常に応答されAPI呼び出し結果も正常ですが、非取引時間帯では取引所からの相場データ更新がないため、市場が取引時間帯に戻るまで相場データのプッシュを受信できません。 * API呼び出し結果は戻り値フィールド（定義は[API呼び出し結果](../ftapi/common.md#8411)を参照）で確認でき、0はAPI呼び出し正常、0以外はAPI呼び出し失敗を意味します。 Python ユーザーの場合、以下の2つの記法は同等です。 ``` if ret_code == RET_OK: ``` ``` if ret_code == 0: ``` ## Q12：WebSocket 関連 A： ### 概要 Moomoo API では、WebSocket は主に以下の2つの用途で使用されます。 * GUI版 OpenD では、UI 画面と内部のコマンドライン OpenD の通信に WebSocket が使用されます。 * JavaScript API と OpenD 間の通信に WebSocket が使用されます。 ![WebSocket-struct](../img/WebSocket-struct.png) * WebSocket 起動時、コマンドライン OpenD は **MMWebSocket 中継サービス** と Socket 接続（TCP）を確立します。この接続にはデフォルトの **監視アドレス** と **API プロトコル監視ポート** が使用されます。 * 同時に、JavaScript API は **MMWebSocket 中継サービス** と WebSocket 接続（HTTP）を確立します。この接続には **WebSocket 監視アドレス** と **WebSocket ポート** が使用されます。 ### 使用方法 アカウントの安全性のため、WebSocket が非ローカルからのリクエストを監視する場合は、SSL を有効にし **WebSocket 認証鍵** を設定することを強く推奨します。 SSL は **WebSocket 証明書** と **WebSocket 秘密鍵** を設定することで有効になります。 コマンドライン OpenD では OpenD.xml の設定またはコマンドラインパラメータでファイルパスを設定できます。GUI版 OpenD では【その他のオプション】ドロップダウンメニューで設定項目を確認できます。 ![ui-more-config](../img/mmui-more-config.png) ::: tip ご注意 証明書が自己署名の場合、JavaScript API を呼び出すマシンに証明書をインストールするか、証明書検証を無効にする必要があります。 ::: #### 自己署名証明書の生成 自己署名証明書の生成の詳細はこのドキュメントでは割愛します。各自でご確認ください。 比較的簡単に使用できる生成手順を以下に示します。 1. openssl をインストールします。 2. openssl.cnf を修正し、alt_names ノードに OpenD のあるマシンの IP アドレスまたはドメイン名を追加します。 例：IP.2 = xxx.xxx.xxx.xxx、DNS.2 = www.xxx.com 3. 秘密鍵と証明書（PEM）を生成します。 **証明書生成パラメータ参考**： `openssl req -x509 -newkey rsa:2048 -out moomoo.cer -outform PEM -keyout moomoo.key -days 10000 -verbose -config openssl.cnf -nodes -sha256 -subj "/CN=moomoo CA" -reqexts v3_req -extensions v3_req` ::: tip ご注意 * openssl.cnf はシステムパスに配置するか、生成パラメータで絶対パスを指定する必要があります。 * 秘密鍵生成時にパスワード未設定（-nodes）を指定する必要があります。 ::: テスト用にローカル自己署名証明書と証明書生成用設定ファイルを添付します： * [openssl.cnf](../file/openssl.cnf) * [moomoo.cer](../file/cer) * [moomoo.key](../file/key) ## Q13：API の相場・取引サービスはどこにデプロイされていますか？ A： - 相場データ： プラットフォームアカウント|相場サーバーの所在地 :-|:-|:- moomoo ID|Tencent Cloud 広州・香港 moomoo ID|Tencent Cloud 米国バージニア・シンガポール - 取引： 所属証券会社|取引サーバーの所在地 :-|:-|:- moomoo証券(香港)|香港 moomoo証券(米国)|Tencent Cloud 米国バージニア moomoo証券(シンガポール) |Tencent Cloud シンガポール moomoo証券(オーストラリア)|Tencent Cloud シンガポール moomoo証券(マレーシア)|Alibaba Cloud マレーシア moomoo証券(カナダ)|AWS カナダ moomoo証券(日本)|Tencent Cloud 日本 --- # 更新履歴 ## 2026-06-25 ### [OpenD 10.8.6808](https://www.moomoo.com/jp/download/OpenAPI) * [検索API](../quote/get-search-quote.md)に対応。キーワードで目的の銘柄をすばやく絞り込み可能 * [検索API](../quote/get-search-news.md)に対応。キーワードでニュースや開示情報、アナリスト評価を一括取得 * [テクニカル指標](../quote/get-indicator-list.md)リストをフル公開。Mai LanguageやPythonに対応し、テクニカル分析をすぐ実行可能 * オプションデータを拡充。IV/HVやプットコールレシオ、0DTEオプション、決算情報、オプション売りなどのデータ取得が可能に。 詳細はこちら：[相場情報API](../quote/overview.md)。 * 市場ファンダメンタルズAPIに対応。機関投資家の動向やマクロ経済データ、配当カレンダー、決算情報、各種ランキング、業種関連図、Fedウォッチなどの情報取得が可能に。詳細はこちら：[相場情報API](../quote/overview.md)。 ## 2026-06-04 ### [OpenD 10.7.6708](https://www.moomoo.com/jp/download/OpenAPI) * シンガポール株、マレーシア株、日本株の相場情報と取引機能を提供開始。権限の詳細は [相場権限](../intro/authority.md#2867) を参照 * オプション戦略の相場情報と取引機能を提供開始。ストラドル、スプレッド、バタフライなど複数の戦略に対応。[オプション戦略の取得](../quote/get-option-strategy.md)、[オプション損益分析](../quote/get-option-strategy-analysis.md)、[オプションスナップショット](../quote/get-option-quote.md) などの相場データに対応しており、[コンボ注文](../trade/place-combo-order.md) によるコンボオプションの取引や、[コンボオプションの購買力照会](../trade/comboorder-tradinginfo-query.md) の変動情報の確認が可能です。 ## 2026-05-21 ### [OpenD 10.6.6608](https://www.moomoo.com/jp/download/OpenAPI) * クライアントアプリと同様にスクリーニング条件を組み合わせ可能：APIから[条件スクリーニング](../quote/get-stock-screen.md#9158)インターフェースを直接呼び出し、ファンダメンタルズ・テクニカル・チャートパターンの5つの次元で自由に組み合わせ、1行のコードで戦略に合致する銘柄を抽出 * クライアントアプリと同様に個別銘柄のファンダメンタルズデータを照会可能：APIから[個別銘柄ファンダメンタルズデータ](../quote/get-financials-statements.md#3396)インターフェースを呼び出し、財務三表・事業構成・アナリスト評価・モーニングスターレポート・バリュエーション（PE/PB/PS）・配当/自社株買い/株式分割・株主保有・インサイダー取引・会社概要と経営陣・トップ10ブローカー・空売りデータを取得 ## 2026-05-07 ### [OpenD 10.5.6508](https://www.moomoo.com/jp/download/OpenAPI) * 暗号資産（Crypto）の相場データおよび取引サポートを追加、HK/US/SG地域のユーザーに対応 * 暗号資産アカウントの資金・ポジション・注文履歴・資金フロー照会を追加 * K線タイプ [KLType](../quote/quote.md#4119) に `K_10M`（10分足）、`K_120M`（2時間足）、`K_180M`（3時間足）、`K_240M`（4時間足）を追加 * OpenD Skills が暗号資産機能に対応 ## 2026-04-23 ### [OpenD 10.4.6408](https://www.moomoo.com/jp/download/OpenAPI) * `OpenSecTradeContext()`、`OpenFutureTradeContext()`、`OpenCryptoTradeContext()` の `security_firm` パラメータのデフォルト値を `NONE` に変更——システムが現在のアカウントに紐づくブローカーを自動的にマッチングし、手動指定不要に * ログサイレントモードを追加、OpenD のログ出力を無効化可能に * Windows インストーラーのファイル名にバージョン番号を埋め込み、バージョン識別と管理を容易に * OpenD Skills パフォーマンス最適化 ## 2026-04-16 ### [OpenD 10.3.6308](https://www.moomoo.com/jp/download/OpenAPI) * 米国株リアルタイム相場データをプロモーション期間中無料開放 * OpenD が証券口座未開設ユーザーのログイン利用に対応、リアルタイム相場サブスクリプション100銘柄分および履歴K線リクエスト枠を付与 * 履歴K線リクエスト枠のリセット周期を30日から7日に短縮 ## 2026-03-26 ### [OpenD 10.2.6208](https://www.moomoo.com/jp/download/OpenAPI) * APIに米国株信用取引シミュレーションサポートを追加、`TrdEnv.SIMULATE` を設定するだけでシミュレーション注文が可能、注文状況はリアルタイムでアプリに同期 * OpenD Skills パフォーマンス最適化 ## 2026-03-20 ### OpenD 10.1.6108 * 全く新しい [Moomoo Skills Hub](https://www.moomoo.com/ja/skillhub) をリリース、OpenClaw・Claude Code・Cursor・Codex など主流AIエージェントの接続に対応 * 相場・取引 [Moomoo API Skill](https://www.moomoo.com/ja/skillhub/openapi) は56のAPIインターフェースをカバー、香港・米国・中国本土（上海/深圳）・シンガポール・日本市場に対応し、リアルタイム相場・インテリジェント取引・リアルタイムプッシュ通知の3大機能を提供 ## 2026-03-06 ### OpenD 10.0.6018 * Moomoo API が日本・マレーシア・カナダ地域のユーザーに対応 * 最近の既知の問題を修正