Language: 日本語 | English

jquants-cli

J-Quants API V2 を利用して日本株式市場のデータを取得できる CLI ツールです。

特徴

• J-Quants API V2 の全エンドポイントに対応（株式・市場・財務・指数・デリバティブ・バルクダウンロード）
• テーブル / JSON / CSV / Parquet の4種類の出力フォーマット
• パイプ接続時に自動で CSV 形式に切替（TTY 検出）
• OAuth2 PKCE によるセキュアなブラウザログイン
• 環境変数・.env ファイルによる API Key 管理
• シェル補完スクリプト生成（bash / zsh / fish / powershell）
• AI Agent 向け Skills ファイル対応
• macOS / Linux / Windows クロスプラットフォーム対応

前提条件

• J-Quants API V2 を利用するには、こちらよりアカウント登録が必要です
• データ取得には Free / Light / Standard / Premium のいずれかのプランを選択してください

インストール

Homebrew (macOS / Linux)

brew install J-Quants/tap/jquants

GitHub Releases

Releases ページから各プラットフォーム向けのビルド済みバイナリをダウンロードし、PATH の通ったディレクトリに配置してください。

ソースからビルド

Rust（stable、MSRV 1.78 以上）が必要です。

git clone https://github.com/J-Quants/jquants-cli
cd jquants-cli
cargo install --path .

認証

推奨: OAuth2 ブラウザログイン

jquants login

実行するとブラウザが自動で開き、J-Quants アカウントでログインすると API Key が ~/.config/jquants/credentials.json に保存されます。

API Key を直接指定

環境変数または .env ファイルで設定できます。

export JQUANTS_API_KEY=your_api_key_here

# .env ファイル
JQUANTS_API_KEY=your_api_key_here

API Key は J-Quants Dashboard から取得してください。

ログアウト

jquants logout

ブラウザでセッションをクリアし、~/.config/jquants/credentials.json を削除します。

使い方

詳しい使い方ガイドは J-Quants CLI を参照してください。

シェル補完

# bash
jquants completion bash > ~/.config/bash/completions/jquants.bash

# zsh
jquants completion zsh > ~/.zfunc/_jquants
fpath=(~/.zfunc $fpath)
autoload -Uz compinit && compinit

# fish
jquants completion fish > ~/.config/fish/completions/jquants.fish

AI Agent 連携

本ツールには AI Agent（Claude Code 等）向けの Skills ファイルが同梱されています。以下のコマンドでインストールしてください。

npx skills add J-Quants/jquants-cli

または、CLI から親ディレクトリを指定してインストールすることもできます。指定したディレクトリの直下に jquants-cli-usage/ が作成されます。

# .claude/skills/jquants-cli-usage/ が作成される
jquants skills add --dir .claude/skills

Contributing

コントリビューションを歓迎しています。詳細は CONTRIBUTING.md をご参照ください。

License

MIT — Copyright © JPX Market Innovation and Research, Inc.