okx-cex-earn について
okx-cex-earnは、OKX CLIで各種OKX Earn商品を管理するスキルです。残高や商品、注文の確認、申し込みや償還を行うユーザー向けで、Simple Earn、Dual Investment、オンチェーンEarn、AutoEarn、Flash Earnを扱います。
主な機能
- 01Simple Earnの残高、利率、注文の照会
- 02定期商品とDual Investment商品の閲覧・申し込み
- 03オンチェーンEarn注文の管理
- 04AutoEarnの状態確認と切り替え
- 05Flash Earnプロジェクトの閲覧
活用シーン
- 01利用可能な定期商品と残り枠の比較
- 02複数のEarn商品の保有状況と注文の確認
- 03Earn商品の申し込みまたは償還
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ okx/ agent-skills --skill okx-cex-earnインストール後、Claude Code で/okx-cex-earnを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
references/autoearn-commands.mddcd-commands.mdflash-earn-commands.mdonchain-commands.mdsavings-commands.mdtemplates.mdworkflows.md詳細
OKX CEX Earn CLI
事前確認
コマンドを実行する前に、../_shared/preflight.md に従ってください。
ステップ 2 の基準として、このファイルのフロントマターにある metadata.version を使用してください。
前提条件
okxCLI をインストールします:npm install -g @okx_ai/okx-trade-cli- 認証情報を設定します:
okx config init # select site -> follow browser OAuth flow - 確認します:
okx earn savings balance
セキュリティ:チャットで認証情報を受け取ることは絶対にしないでください。設定には
okx config initを使うよう案内してください。
認証情報とプロファイルの確認
認証が必要なコマンドを実行する前に、両方のコマンドを実行してください。okx auth status --json の apiKey フィールドは認証バイナリの内部状態であり、~/.okx/config.toml に API キープロファイルがあるかどうかにかかわらず、常に false です。API キーの有無を確認する唯一の信頼できる情報源は okx config show --json です。認証方法は事前確認のステップ 2 で検出され、セッション中はその情報が保持されます。
okx config show --json # reveals API-key profiles (TOML config)
okx auth status --json # reveals OAuth session state (auth-binary state)
次の順に適用してください。最初に一致した項目を採用します。
config show --jsonにapi_keyフィールドが空でないプロファイルがある → API キーモード。続行します。- API キープロファイルがなく、かつ
auth status --jsonが"status":"logged_in"を返す → OAuth モード。続行します。 - API キープロファイルがなく、かつ
"status":"pending"→ ログイン処理中です。完了するまで待ちます。 - API キープロファイルがなく、かつ
"status":"not_logged_in"→ 停止し、okx-cex-authスキルを読み込んでログイン手順に従い、完了するまで待ちます。
OKX Earn はデモモードをサポートしていません。常にライブモードを黙って使用し、エラーがない限りそのことには触れないでください。
- API キーを使用するユーザー:
--profile <live-profile>(demo=trueが設定されていないプロファイル)を使用します。 - OAuth を使用するユーザー:フラグは不要です(ライブモードがデフォルトです)。
認証エラーが発生した場合(401/「Session expired」/「Run okx auth login first」): 直ちに停止し、okx-cex-auth スキルを読み込んで再認証手順に従ってから、再試行してください。
スキルの振り分け
| ユーザーの意図 | 振り分け先のスキル |
|---|---|
| 市場価格、ティッカー、ローソク足 | okx-cex-market |
| 現物/スワップ/先物/オプションの注文 | okx-cex-trade |
| 口座残高、ポジション、送金 | okx-cex-portfolio |
| グリッド/DCA 取引ボット | okx-cex-bot |
| Simple Earn、Flash Earn、On-chain Earn、Dual Investment(双币赢)、AutoEarn(自动赚币) | このスキル |
コマンド一覧
earn savings — Simple Earn(10 個のコマンド)
| コマンド | 種類 | 認証 | 説明 |
|---|---|---|---|
earn savings balance [ccy] | READ | 必須 | 貯蓄残高(全通貨または指定通貨)。全体像を把握するため、定期注文も取得します。 |
earn savings purchase --ccy --amt [--rate] | WRITE | 必須 | Simple Earn(活期)に資金を預け入れます |
earn savings redeem --ccy --amt | WRITE | 必須 | Simple Earn(活期)から資金を払い戻します |
earn savings set-rate --ccy --rate | WRITE | 必須 | 最低貸出レートを設定します |
earn savings lending-history | READ | 必須 | 利益の詳細を含む、ユーザー個人の貸出記録 |
earn savings rate-history | READ | 必須 | Simple Earn の貸出レートと定期商品の提示内容(認証が必要) |
earn savings fixed-products [--ccy] | READ | 必須 | APR、期間、残りの割当量、売り切れ状況を含む、購入可能な定期商品を確認します |
earn savings fixed-orders [--ccy] [--state] | READ | 必須 | 定期注文を照会します。状態:pending/earning/expired/settled/cancelled |
earn savings fixed-purchase --ccy --amt --term [--confirm] | WRITE | 必須 | Simple Earn Fixed(定期)に申し込みます。--confirm を指定しない場合はプレビューのみです |
earn savings fixed-redeem --reqId <reqId> | WRITE | 必須 | 定期注文を払い戻します(全額)。早期払い戻しが可能なのは、状態が pending の注文のみです |
コマンドの完全な構文、レートフィールドの意味、確認テンプレートについては、{baseDir}/references/savings-commands.md をお読みください。
earn dcd — Dual Investment / 双币赢(6 件のコマンド)
| コマンド | 種類 | 認証 | 説明 |
|---|---|---|---|
earn dcd pairs | READ | 必須 | 利用可能な DCD 通貨ペア |
earn dcd products | READ | 必須 | フィルターに一致する有効な商品 |
earn dcd quote-and-buy --productId --sz --notionalCcy | WRITE | 必須 | 見積もりと実行を一度に行う、一括申し込み |
earn dcd order --ordId | READ | 必須 | 単一注文の状態をすばやく確認 |
earn dcd orders | READ | 必須 | 注文一覧/履歴 |
earn dcd redeem-execute --ordId | WRITE | 必須 | 早期償還を 2 段階で実行:プレビュー後に実行 |
DCD はデモ/シミュレーション取引モードに対応していません。必ずライブモードを使用してください(API Key:
--profile <live-profile>、OAuth:フラグは不要)。
コマンドの構文、商品に関する概念、エラーコードの詳細については、{baseDir}/references/dcd-commands.md を参照してください。
earn onchain — オンチェーン運用(6 件のコマンド)
| コマンド | 種類 | 認証 | 説明 |
|---|---|---|---|
earn onchain offers | READ | 必須 | 利用可能なステーキング/DeFi 商品 |
earn onchain purchase --productId --ccy --amt | WRITE | 必須 | オンチェーン商品に申し込む |
earn onchain redeem --ordId --protocolType | WRITE | 必須 | オンチェーン投資を償還する |
earn onchain cancel --ordId --protocolType | WRITE | 必須 | 保留中のオンチェーン注文をキャンセルする |
earn onchain orders | READ | 必須 | 有効なオンチェーン注文 |
earn onchain history | READ | 必須 | オンチェーン注文履歴 |
コマンドの構文とパラメーターの詳細については、{baseDir}/references/onchain-commands.md を参照してください。
earn auto-earn — AutoEarn / 自動運用(3 件のコマンド)
| コマンド | 種類 | 認証 | 説明 |
|---|---|---|---|
earn auto-earn status [CCY] | READ | 必須 | 自動運用に対応する通貨とその状態を照会する |
earn auto-earn on <CCY> | WRITE | 必須 | 通貨の自動運用を有効にする |
earn auto-earn off <CCY> | WRITE | 必須 | 通貨の自動運用を無効にする |
24 時間の制限: 有効化から 24 時間以内は無効にできません(API の厳格な制限)。有効化する前に、必ずユーザーに警告してください。
コマンドの構文、earnType の推定ルール、MCP ツールのリファレンスについては、{baseDir}/references/autoearn-commands.md を参照してください。
earn flash-earn — Flash Earn / フラッシュ運用(1 件のコマンド)
| コマンド | 種類 | 認証 | 説明 |
|---|---|---|---|
earn flash-earn projects [--status <0|100|0,100>] | READ | 必須 | ステータスで Flash Earn プロジェクトを一覧表示します。0=開始予定、100=進行中、デフォルトは両方 |
操作フロー
ステップ 0 — 認証情報とプロファイルの確認
認証が必要なコマンドを実行する前に、認証情報とプロファイルの確認を参照してください。常にライブモードを使用し、そのことはユーザーに伝えないでください。
ステップ 1 — 資産運用の意図を特定する
Simple Earn Flexible(活期):
- 残高/履歴/利率の照会 → READ コマンドを実行し、そのまま進みます。
- 申し込み/償還/利率の設定 → WRITE コマンドを実行し、ステップ 2 に進みます。
Simple Earn Fixed(定期):
- 利用可能な商品を確認する/クォータを確認する →
earn savings fixed-products [--ccy]。これは固定期間商品のプールを照会する専用ツールです。利用可能な固定期間の Earn 商品、残りのクォータ、APR についてユーザーから質問された場合は、必ずこのツールを使用してください。 - ユーザーの既存注文を照会する →
earn savings fixed-orders [--ccy] [--state]。 - 申し込み(プレビューしてから確定する 2 段階の手順)/償還(保留状態のみ) → WRITE コマンドを実行し、ステップ 2 に進みます。実行前のチェックリストと確認用テンプレートについては、
{baseDir}/references/savings-commands.mdを読みます。 - 複数段階のワークフロー(プレビュー付きの申し込み、早期償還)については、
{baseDir}/references/workflows.mdを読みます。
On-chain Earn:
- オファー/注文/履歴の照会 → READ コマンドを実行し、そのまま進みます。
- 購入/償還/キャンセル → WRITE コマンドを実行し、ステップ 2 に進みます。
AutoEarn(自动赚币):
- Auto-Earn の状態を照会する → READ を実行し、そのまま進みます。
- Auto-Earn の有効化/無効化 → WRITE コマンドを実行し、ステップ 2 に進みます。確認用テンプレートと earnType の推定については、
{baseDir}/references/autoearn-commands.mdを読みます。
Flash Earn(闪赚):
- プロジェクトを確認する → READ を実行し、そのまま進みます。
- 今後開始予定のプロジェクトを表示するには
--status 0、進行中のプロジェクトを表示するには--status 100を使用します。両方を表示するにはフラグを省略します。
ユーザーが「Earn ポジション」または「赚币持仓」の表示を求めた場合(DCD を明示しているかどうかは問いません)、ポジションを持つすべてのサブモジュールを同時に照会します(Flash Earn は照会専用で、ポジションはありません)。
okx earn savings balance --json # Simple Earn Flexible (活期)
okx earn savings fixed-orders --json # Simple Earn Fixed (定期)
okx earn onchain orders --json # On-chain Earn
okx earn dcd orders --json # Dual Investment (双币赢)
実際に保有している資産があるセクションのみを表示します。DCD については、{baseDir}/references/dcd-commands.md の表を使って状態コードを翻訳します。
Dual Investment(DCD / 双币赢):
- 商品/通貨ペアを確認する → READ を実行します。ユーザーが通貨を指定した場合、商品テーブルを表示する前に必須の並列プリフェッチを行うため、
{baseDir}/references/workflows.mdの DCD 確認フローを読みます。 - 申し込み(見積もりを取得して購入) → WRITE を実行します。
{baseDir}/references/workflows.mdの DCD 申し込みフローを参照します。 - 早期償還 → WRITE を実行します。
{baseDir}/references/workflows.mdの DCD 早期償還フローを参照します。
複数段階のワークフロー(遊休資金の分析、申し込み+確認、償還+振替、オンチェーンでの申し込み)については、{baseDir}/references/workflows.md を読みます。
ステップ 2 — 書き込み操作を確認する
すべての WRITE コマンドでは、概要を提示し、明示的な確認を待ちます。
「そのまま実行して」/「直接搞」は有効な確認ではありません。まずユーザーに概要を提示する必要があります。
Simple Earn の確認ダイアログ形式については、{baseDir}/references/savings-commands.md を読みます。On-chain の確認については、{baseDir}/references/onchain-commands.md を読みます。
Step 3 — 実行と確認
購入後は、商品の種類に応じて確認します。
- DCD の
quote-and-buyが成功した場合 →earn dcd orders --jsonを実行し、一致する注文のみを表示します。 - オンチェーンで購入した場合(レスポンスに
ordIdが含まれる場合)→earn onchain orders --jsonを実行し、一致する注文のみを表示します。 - Simple Earn Flexible を購入した場合(レスポンスに
ordIdが含まれない場合)→earn savings balance --ccy <ccy> --jsonを実行します。 - Simple Earn Fixed を購入した場合 →
earn savings fixed-orders --ccy <ccy> --state pending --jsonを実行し、新しい注文を表示します。
Simple Earn Flexible の購入: earn savings balance --ccy <ccy> と earn savings rate-history --ccy <ccy> --limit 1 --json を並行して実行します。出力形式については、{baseDir}/references/savings-commands.md を参照してください。
Simple Earn Flexible の償還: earn savings balance --ccy <ccy> を実行して、残高が更新されたことを確認します。資金がファンディングアカウントに返されたことをユーザーに伝えます。
Simple Earn Fixed の購入: earn savings fixed-orders --ccy <ccy> --state pending --json を実行して、注文が作成されたことを確認します。APR、期間、予想満期日などの注文詳細を表示します。
Simple Earn Fixed の償還: earn savings fixed-orders --json を実行して、注文状態が cancelled に変わったことを確認します。早期キャンセルでは利息が発生せず、元本全額がファンディングアカウントに返されることをユーザーに伝えます。
オンチェーンでの償還: earn onchain orders を照会して状態を確認します。estSettlementTime を到着予定時刻として表示します。
オンチェーンでのキャンセル: 送信後に earn onchain orders を照会します。
- 注文が一覧から消えている → キャンセルが完了し、資金がファンディングアカウントに返されたことをユーザーに伝えます。
state: 3(キャンセル処理中)→ キャンセル処理中であり、資金はまもなくファンディングアカウントに返されることをユーザーに伝えます。
全般的な注意事項
- セキュリティ: API キーやシークレットをチャットに貼り付けるようユーザーに求めてはいけません。
- 出力: 一覧表示/照会コマンドには必ず
--jsonを渡し、結果を Markdown の表として表示します。ターミナル出力をそのまま貼り付けてはいけません。 - ネットワークエラー: コマンドが接続エラーで失敗した場合は、VPN を確認するようユーザーに案内します:
curl -I https://www.okx.com - 言語: 常にユーザーの言語で応答します。
数値/時刻の書式設定と応答構成の規則については、{baseDir}/references/templates.md を参照してください。