ツール
コマンドラインツールを 2 つ公開しています。 Komachi はデータを取得し、 Hase はそこから派生データを作って分析に使えるようにします。 どちらも Python パッケージで、Apache License 2.0 で公開しています。
| ツール | 役割 | PyPI |
|---|---|---|
| Komachi | 取得。ダウンロード、外部データの取り込み、ファイル検証 | kamakuraquantlab-komachi |
| Hase | 分析。silver・gold の生成とプロット | kamakuraquantlab-hase |
動作確認は Linux と macOS、Python 3.13 以降で行っています。 Windows および Python 3.12 以前では確認していません。 動作する可能性はありますが、確認できる環境がないため、サポートの対象外とさせていただいています。
Hase: 1. 何をするツールか
取得した bronze データから、分析に使える派生データを作ります。 入力と同じレイアウトで、同じルートの下に並べて保存します。
| データセット | 層 | 内容 |
|---|---|---|
BookState | silver | スナップショットごとの最良気配、仲値、スプレッド、最良気配の厚み |
MarketPrice | silver | 指定した数量で板を歩いたときの実効価格 |
Spread | gold | 1 秒グリッドで測ったスプレッドの移動平均（bps） |
Volatility | gold | 1 秒グリッドで測った実現ボラティリティとリターンのボラティリティ（bps） |
Hase はローカルのファイルだけを読みます。 API に接続せず、トークンを持たず、利用枠も消費しません。 手元にある bronze であれば、どこから来たものでも同じように扱います。
Hase: 2. インストールして生成する
pip install kamakuraquantlab-hase
hase derive BookState --market COINCHECK:BTC_SPOT --start 2025-07-01 --end 2025-07-28
hase derive MarketPrice --market COINCHECK:BTC_SPOT --start 2025-07-01 --end 2025-07-28
hase derive Spread --market COINCHECK:BTC_SPOT --start 2025-07-01 --end 2025-07-28
hase derive Volatility --market COINCHECK:BTC_SPOT --start 2025-07-01 --end 2025-07-28
hase local --market COINCHECK:BTC_SPOT
生成済みの日付は再計算しません。作り直す場合は --recreate を付けてください。
hase local は、取得済みの bronze と生成済みの派生データを並べて表示します。
Hase を先にインストールした場合は、Komachi と同じように保存先を尋ねられ、
同じ ~/.kamakuraquantlab.env に書き出して終了します。
どちらを先に入れても、設定は 1 回で済みます。
Hase がこのファイルから読むのは保存先だけで、トークンは読みません。
MarketPrice の数量は基軸通貨建てで、既定は 0.002 BTC です
（--execution-size）。
円建ての金額で歩かせる場合は --execution-notional 1000000 のように指定します。
数量は保存先のパスに含まれるため、条件の違う結果が混ざることはありません。
Hase: 3. 図にする
hase plot-book --market COINCHECK:BTC_SPOT --date 2025-07-01 --output book.png
hase plot-trades --market COINCHECK:BTC_SPOT --date 2025-07-01 --output trades.png
plot-book は最良気配とスプレッド、plot-trades は価格と売買別の出来高です。
軸のラベルは日本時間で、ファイルが切られた日付と一致します。
ソースとドキュメント
どちらも Apache License 2.0 で公開しています。 トークンとデータをどう扱っているかは、ソースを読んで確認いただけます。