ツール
コマンドラインツールを 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 以前では確認していません。 動作する可能性はありますが、確認できる環境がないため、サポートの対象外とさせていただいています。
AI エージェントに任せる
以下のセットアップと操作は、Claude Code や Codex などの
AI コーディングエージェントに任せられます。
Komachi のリポジトリにエージェント向けの手引き（AGENTS.md）を
同梱しているため、Python の準備からトークンの設定、
コマンドの実行までその場で進められます。
git clone https://github.com/kamakuraquantlab/Komachi
cd Komachi
claude # または codex など、お使いのエージェント自然言語でそのまま指示できます。 手引きに用語の対応表を記載しているため、 「利用枠」「ダウンロード期間」「板情報」など、 このサイトで使っている言葉もそのまま通じます。
プロンプトの例
そのまま貼り付けてお使いいただけます。
はじめて使うとき
Komachi を使えるようにしてください。Python の用意から、
インストール、トークンの設定までお願いします。
トークンは hk_… です。トークンはダウンロードのページでサインインすると発行されます。
何が取れるか調べる
収録されているマーケットと期間を一覧にしてください。
BTC の板情報がある取引所はどれですか。欠測している日付も教えてください。取得する
COINCHECK:BTC_SPOT の 2025-07-01 から 1 週間分を取得したいです。
利用枠をいくつ消費するか先に教えてください。利用枠を消費するのは取得のときだけです。 エージェントには、消費する数を示して確認を取ってから実行するよう指示しています。
取得したデータを見る
取得済みのデータを DuckDB で読めるようにして、
COINCHECK:BTC_SPOT の 2025-07-01 のスプレッドの推移を出してください。うまくいかないとき
このエラーが出ました。原因と、次にすることを教えてください。
（エラーの全文を貼り付けてください）期限切れや利用枠に関するご相談など、手元では解決しない内容は サポートまでご連絡ください。
Komachi: 1. インストール
ここから先は、ご自身で進める場合の手順です。
Python 3.13 以降が必要です。
pip install 'kamakuraquantlab-komachi[duckdb]'
komachi local
最初の実行では、データの保存先を尋ねられます。
答えは ~/.kamakuraquantlab.env に書き出され、その内容を表示して終了します。
もう一度同じコマンドを実行すると、そこから先に進みます。
パッケージ名は kamakuraquantlab-komachi、コマンド名は komachi です。
[duckdb] を付けない最小構成でもダウンロードはできますが、
取得したファイルを読むには必要です。
Komachi: 2. トークンを登録する
トークンはダウンロードのページで発行します。 注文番号とご購入時のメールアドレスでサインインし、「トークンを表示」を押してください。
komachi token set --token hk_…
komachi token status
token set はトークンを検証してから設定ファイル
~/.kamakuraquantlab.env に保存します（パーミッション 0600）。
token status はご利用可能な利用枠、ダウンロード期間の期限、
すでに取得した market-day の期間を表示します。
Komachi: 3. 何が取得できるか確認する
komachi markets
マーケットごとに、収録しているデータセット、収録期間、期間内の欠測日を表示します。
続けて、本サイトからは提供せず取引所自身が公開しているデータ（Binance と GMO コインの約定履歴）も
取り込み先として並びます。利用枠は消費しません。
手元にすでに何があるかは komachi local で確認できます。
Komachi: 4. ダウンロードする
komachi download --market COINCHECK:BTC_SPOT --start 2025-07-01 --days 28実行すると、取得する範囲、ファイルサイズ、消費する market-day を表示してから確認を求めます。 その時点ではまだ何も取得していません。
--days を省略すると、利用枠の範囲で取得できるだけ取得します。
中断した場合は同じコマンドをもう一度実行してください。
取得済みの分は再取得せず、追加の消費もありません。
Komachi: 5. 保存先とレイアウト
<root>/bronze/dataset=Trade/exchange=COINCHECK/symbol=BTC_SPOT/date=2025-07-01/data.parquet
データレイクと同じ bronze レイアウトで保存します。
保存先は初回実行時に尋ねられ、既定は ~/kamakuraquantlab-data です。
答えは ~/.kamakuraquantlab.env に書かれ、Hase も同じファイルを読みます。
--root または環境変数 ROOT_PATH で上書きできます。
date= は日本時間の 1 日（15:00〜14:59 UTC）です。
ファイル内のタイムスタンプは UTC エポック秒です。
いま手元に何があるかは komachi local で確認できます。
取得したファイルの中身は komachi trades --market COINCHECK:BTC_SPOT --date 2025-07-01、
板情報は komachi book ですぐに確認できます。
download と import はファイルを書いたあとに DuckDB のビューを
更新するため、変換の手順を挟まずそのまま読めます。
Komachi: 6. 外部データを取り込む
Binance と GMO コインは、いずれも自社の約定履歴を公開しています。 Komachi はそれらを取得して、同じ bronze レイアウトに変換します。利用枠は消費しません。
komachi import --market BINANCE:BTC_USDT --start 2025-07-01 --days 28
komachi import --market GMO:BTC_JPY --start 2025-07-01 --days 28
指定の仕方は download と同じです。
取引所ごとに 1 日の区切りが違いますが、取り込み時に日本時間の日次へ切り直すため、
本サイトのデータとそのまま並べられます。
取り込めるのは約定履歴です。両取引所とも板情報は公開していないため、
板情報はMarket Archive でご提供しています。
ソースとドキュメント
どちらも Apache License 2.0 で公開しています。 トークンとデータをどう扱っているかは、ソースを読んで確認いただけます。