jquants-api-client-python

jquants-api-client 是面向个人投资者的数据 API 发布服务「J-Quants API」的 Python 客户端库。如需了解更多关于 J-Quants 和 API 规范的信息，请参阅官方网站。目前，J-Qua…

jquants-api-client

個人投資家向けデータ API 配信サービス「 J-Quants API 」の Python クライアントライブラリです。 J-Quants や API 仕様についての詳細を知りたい方は公式ウェブサイトをご参照ください。現在、J-Quants API は有償版サービスとして提供されています。

使用方法

pip 経由でインストールします。

pip install jquants-api-client

動作環境

Python 3.10 以上
pandas 2.2 以上
- pandas 3 系にも対応しています。ただし pandas 3 系は Python 3.11 以上が必須のため、Python 3.10 では pandas 2 系が使用されます。
- pandas 3 系では返却される DataFrame の dtype が一部変わります。dtype に依存した処理を行っている場合はご注意ください。
  - 文字列カラム: object → str
  - 日付カラム: datetime64[ns] → datetime64[us]

J-Quants API の利用

To use J-Quants API, you need to "Applications for J-Quants API" from J-Quants API Web site and to select a plan.

J-Quants API を利用するためにはJ-Quants API の Web サイトから「J-Quants API 申し込み」及び利用プランの選択が必要になります。

jquants-api-client-python を使用するためには「J-Quants API ダッシュボードから取得した API キー」が必要になります。必要に応じて下記の Web サイトより取得してください。

J-Quants API ダッシュボード

サンプルコード (V2)

V2 API では API キーによる認証を使用します。API キーは J-Quants API ダッシュボードから取得できます。

from datetime import datetime
from dateutil import tz
import jquantsapi

my_api_key: str = "*****"
cli = jquantsapi.ClientV2(api_key=my_api_key)
df = cli.get_eq_bars_daily_range(
    start_dt=datetime(2022, 7, 25, tzinfo=tz.gettz("Asia/Tokyo")),
    end_dt=datetime(2022, 7, 26, tzinfo=tz.gettz("Asia/Tokyo")),
)
print(df)

環境変数 JQUANTS_API_KEY を設定している場合は、引数を省略できます。

import jquantsapi

cli = jquantsapi.ClientV2()  # 環境変数 JQUANTS_API_KEY を使用

API レスポンスが Dataframe の形式で取得できます。

…

より具体的な使用例はサンプルノートブック(/examples) をご参照ください。

対応 API (V2)

ClientV2 クラスで利用可能な V2 API エンドポイントです。

プランごとに利用可能な API とデータ格納期間については、公式ドキュメントをご参照ください。

ラッパー群

get_eq_master - 上場銘柄一覧
get_eq_bars_daily - 株価日足
get_eq_bars_daily_am - 株価午前終値
get_eq_earnings_cal - 決算発表予定日（3・9月期決算会社のみ・翌営業日分）
get_eq_investor_types - 投資部門別売買状況
get_eq_valuation - バリュエーション指標（PER/PBR/ROE・時価総額）
get_idx_bars_daily - 指数日足
get_idx_bars_daily_topix - TOPIX日足
get_mkt_calendar - 営業日カレンダー
get_mkt_short_ratio - 空売り比率
get_mkt_short_sale_report - 空売り報告
get_mkt_margin_interest - 週次信用取引残高
get_mkt_margin_alert - 信用規制情報
get_mkt_breakdown - 売買内訳
get_drv_bars_daily_fut - 先物日足
get_drv_bars_daily_opt - オプション日足
get_drv_bars_daily_opt_225 - 日経225オプション日足
get_fin_summary - 決算サマリー
get_fin_summary_cursor - 決算サマリー（cursor 差分取得）
get_fin_details - 財務詳細
get_fin_details_cursor - 財務詳細（cursor 差分取得）
get_fin_dividend - 配当情報
get_fin_earnings_date - 決算発表予定日
get_edinet_major_shareholders - 大株主状況（EDINET）
get_edinet_cross_shareholdings - 政策保有株式（EDINET）
get_edinet_large_volume_shareholders - 大量保有報告書（EDINET）
get_bulk_list - バルクデータ一覧
get_bulk - バルクデータ取得
get_eq_bars_minute - 分足
get_eq_bars_5minute - 5分足（分足から算出）
get_eq_bars_15minute - 15分足（分足から算出）
get_td_list - 適時開示インデックス一覧
get_td_files - 適時開示ファイルダウンロードURL取得
get_td_bulk - 適時開示インデックス一括ダウンロードURL取得

ユーティリティ群

業種や市場区分一覧などを返します。

get_market_segments - 市場区分一覧
get_17_sectors - 17業種一覧
get_33_sectors - 33業種一覧

日付範囲を指定して一括でデータ取得して、取得したデータを結合して返すユーティリティです。

get_list - 銘柄一覧（セクター情報付き）
get_eq_bars_daily_range - 株価日足（範囲指定）
get_eq_valuation_range - バリュエーション指標（範囲指定）
get_mkt_short_ratio_range - 空売り比率（範囲指定）
get_mkt_short_sale_report_range - 空売り報告（範囲指定）
get_mkt_margin_interest_range - 信用取引残高（範囲指定）
get_mkt_margin_alert_range - 信用規制情報（範囲指定）
get_mkt_breakdown_range - 売買内訳（範囲指定）
get_drv_bars_daily_fut_range - 先物日足（範囲指定）
get_drv_bars_daily_opt_range - オプション日足（範囲指定）
get_drv_bars_daily_opt_225_range - 日経225オプション日足（範囲指定）
get_fin_summary_range - 決算サマリー（範囲指定）
get_fin_details_range - 財務詳細（範囲指定）
get_fin_earnings_date_range - 決算発表予定日（公表日の範囲指定）

レートリミット

J-Quants API には、サービスの安定稼働を目的としてレートリミット（利用頻度の制限）が設けられています。プランごとのレートリミットの詳細については、公式ドキュメントをご参照ください。

注意事項

サフィックスが _range で終わるメソッド（例: get_eq_bars_daily_range、get_fin_summary_range など）は、指定された日付範囲に対して並列処理で繰り返し API リクエストを行います。そのため、広い日付範囲を指定した場合や、短時間に複数回実行した場合、レートリミットに達する可能性があります。

レートリミットを超過すると、API は HTTP ステータスコード 429 Too Many Requests を返します。エラーが発生した場合は、一定時間待機してから再試行するか、より狭い日付範囲で分割してリクエストすることをご検討ください。

設定

API キーは設定ファイルおよび環境変数を使用して指定することも可能です。設定は下記の順に読み込まれ、設定項目が重複している場合は後に読み込まれた値で上書きされます。

/content/drive/MyDrive/drive_ws/secret/jquants-api.toml (Google Colab のみ)
${HOME}/.jquants-api/jquants-api.toml
jquants-api.toml
os.environ["JQUANTS_API_CLIENT_CONFIG_FILE"]
${JQUANTS_API_KEY}

設定ファイル例

jquants-api.toml は下記のように設定します。

[jquants-api-client]
api_key = "*****"

動作確認

Google Colab および Python 3.13 で動作確認を行っています。 J-Quants API は有償版で継続開発されているため、本ライブラリも今後仕様が変更となる可能性があります。 Python の EOL を迎えたバージョンはサポート対象外となります。 Please note we only support Python supported versions. Unsupported versions (after EOL) are not supported. ref. https://devguide.python.org/versions/#supported-versions

開発

J-Quants API Client の開発に是非ご協力ください。 Github 上で Issue や Pull Request をお待ちしております。

jquants-api-client-python

工具介绍