Python API の使い方
kabukit は、複数のソースからデータを取得するための、Python API を提供します。
現在サポートしているソースは以下の通りです。
ノートブックでの非同期処理
kabukit は、httpx を使った非同期設計になっており、Jupyter や marimo のような非同期処理を直接扱えるノートブック環境で快適に利用できます。
2 つのインターフェース
Python API は、モジュール関数と Client クラスの 2 のインターフェースを提供します。
モジュールレベル関数
httpx クライアントを意識することなく、手軽にデータを取得にするのに適しています。また、銘柄コードや日付を複数指定すると、関数内部で非同期処理を並列実行するため、効率的に情報を取得できます。
以下の例では、J-Quants API から株価情報を取得します。get_prices 関数に銘柄コードを与えます。
from kabukit import get_prices
df = await get_prices("7203")
df.select("Date", "Code", "Open", "High", "Low", "Close", "Volume")
shape: (2_441, 7)
| Date | Code | Open | High | Low | Close | Volume |
|---|---|---|---|---|---|---|
| date | str | f64 | f64 | f64 | f64 | f64 |
| 2016-03-31 | "72030" | 1205.0 | 1212.2 | 1188.6 | 1190.4 | 5.15435e7 |
| 2016-04-01 | "72030" | 1186.0 | 1189.2 | 1150.6 | 1154.2 | 6.9877e7 |
| 2016-04-04 | "72030" | 1140.0 | 1143.8 | 1118.0 | 1125.0 | 6.64115e7 |
| 2016-04-05 | "72030" | 1120.0 | 1126.8 | 1083.4 | 1087.8 | 7.66835e7 |
| 2016-04-06 | "72030" | 1090.2 | 1107.0 | 1084.2 | 1091.4 | 5.7542e7 |
| … | … | … | … | … | … | … |
| 2026-03-24 | "72030" | 3321.0 | 3336.0 | 3258.0 | 3271.0 | 1.65657e7 |
| 2026-03-25 | "72030" | 3389.0 | 3420.0 | 3328.0 | 3338.0 | 1.85567e7 |
| 2026-03-26 | "72030" | 3383.0 | 3388.0 | 3348.0 | 3388.0 | 1.61072e7 |
| 2026-03-27 | "72030" | 3355.0 | 3434.0 | 3346.0 | 3408.0 | 2.81981e7 |
| 2026-03-30 | "72030" | 3204.0 | 3237.0 | 3168.0 | 3224.0 | 3.09417e7 |
get_prices 関数に銘柄コードのリストを与えると、非同期処理を並列実行して、複数銘柄の株価情報を一度に取得します。
import polars as pl
from polars import col as c
# 複数銘柄の株価情報を取得
df = await get_prices(["7203", "9984", "8306", "6758"])
# 銘柄コードごとに集計
df.group_by(c.Code).agg(
pl.len().alias("日数"),
c.Low.min().alias("最安値"),
c.High.max().alias("最高値"),
c.Close.last().alias("直近終値"),
c.TurnoverValue.mean().alias("1日あたり平均取引代金"),
)
shape: (4, 6)
| Code | 日数 | 最安値 | 最高値 | 直近終値 | 1日あたり平均取引代金 |
|---|---|---|---|---|---|
| str | u32 | f64 | f64 | f64 | f64 |
| "67580" | 2441 | 508.2 | 4776.0 | 3188.0 | 4.3290e10 |
| "72030" | 2441 | 983.4 | 4000.0 | 3224.0 | 5.7251e10 |
| "83060" | 2441 | 380.0 | 3087.0 | 2621.0 | 5.8284e10 |
| "99840" | 2441 | 649.3 | 6923.8 | 3692.0 | 9.5385e10 |
Client クラス
より詳細な制御（例: タイムアウト設定、リトライポリシーの変更など）
が必要な場合に直接利用します。特に、各クラスの client 属性は httpx.AsyncClient のインスタンスであるため、httpx が提供する豊富なメソッドや設定に直接アクセスすることが可能です。
たとえば、J-Quants API に対応した JQuantsClient は以下のように使います。
from kabukit import JQuantsClient
client = JQuantsClient()
# ここで API を呼び出す
await client.aclose() # 最後に手動でセッションを閉じる
async with 構文を使うことで、セッションを安全に管理できます。
async with JQuantsClient() as client:
# このブロック内で API を呼び出す
pass
# 自動でセッションが閉じられる