A Python toolkit for Japanese financial market data, supporting J-Quants and EDINET APIs.
Project description
日本の株式分析を、もっと手軽に、もっと速く
kabukit は、J-Quants と EDINET のデータを、コマンドラインや Python コードから快適に扱うためのモダンなツールキットです。
なぜ kabukit なのか?
日本株の投資分析には、様々なデータソースへのアクセスが必要です。しかし、それぞれの API は仕様が異なり、データ取得だけで多くの時間を費やしてしまいます。kabukit は、こうした課題を解決します。
ターミナルから即座にデータ取得
API の認証設定が対話形式で簡単に完了。kabu get prices --all の一行で、全上場銘柄の 10 年分1 の株価データが手に入り、すぐに分析を始められます。
ノートブックで快適な分析体験
await get_statements() と書くだけで、全上場銘柄の財務情報を非同期で並列取得。Polars によるデータフレーム操作で、数千銘柄のデータも瞬時に処理できます。
賢いキャッシュで高速アクセス
一度取得したデータはローカルに保存され、次回からは瞬時にアクセス可能。ネットワークアクセスを待つことなく、何度でも試行錯誤できます。
モダンな技術スタックで高速処理
httpx の非同期処理により、複数銘柄のデータを並列取得。従来の同期的なアプローチと比べ、データ取得時間を大幅に短縮します。
1 J-Quants API スタンダードプラン利用時。詳しくは J-Quants API のプラン表を参照してください。
クイックスタート
インストール
Python 3.12 以上が必要です。
pip install kabukit
または
uv add kabukit
CLI で使う
インストールしたら、まずは認証設定から始めましょう。
# J-Quants API の認証(対話形式)
kabu auth jquants
# 上場銘柄一覧を取得
kabu get info
# トヨタ自動車の財務情報を取得
kabu get statements 7203
Python で使う
Jupyter や marimo などのノートブック環境では、await 式を直接記述できます。
from kabukit import get_info, get_prices
# 上場銘柄一覧を取得
df_info = await get_info()
# トヨタ自動車の株価を取得
df_prices = await get_prices("7203")
主な機能
2つの API を統一的に扱える
- J-Quants API: 上場銘柄情報、財務情報、株価四本値など
- EDINET API: 有価証券報告書などの開示書類
異なる API の仕様差を吸収し、同じインターフェースで利用できます。
高速なデータ処理
柔軟な利用方法
- CLI: スクリプト不要で、ターミナルから直接データ取得
- Python API: ノートブック環境での対話的な分析に最適
- キャッシュ活用: CLI で取得したデータを Python から読み込み可能
ドキュメント
詳しい使い方は、公式ドキュメントを参照してください。
- CLI の使い方 - 認証設定、データ取得、キャッシュ管理
- Python API の使い方 - 各種情報を Python から取得する方法。モジュール関数と Client クラスの使い分け
ライセンス
MIT License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file kabukit-0.16.2.tar.gz.
File metadata
- Download URL: kabukit-0.16.2.tar.gz
- Upload date:
- Size: 36.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.9.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
574ff35f091ff65dcd2fc9356014e559fb9a5ca011bf50d0bd85c63fe80858bc
|
|
| MD5 |
73c7b0e2c07f680cf4f215590b277c7b
|
|
| BLAKE2b-256 |
cadfc0c05c64880c80a8cfd29543f1e613cbc5be2f2fc43ad4e9130f2504a918
|
File details
Details for the file kabukit-0.16.2-py3-none-any.whl.
File metadata
- Download URL: kabukit-0.16.2-py3-none-any.whl
- Upload date:
- Size: 58.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.9.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8ca60dfe707698fd59a9998f127909089ed07494a83b29b7e3a5e9e9290cfb7c
|
|
| MD5 |
7981bde6afdc89aeadd1cff94749a1f2
|
|
| BLAKE2b-256 |
3805c0aaac900c5bf4d9ca4b8791890ff96867ff05137697e38b5e80d7a65c5a
|