OKX CEX ポートフォリオ&アカウント CLI
OKX取引所でのアカウント残高、ポジション、損益(P&L)、請求書、手数料、資金移動を行います。API認証情報が必要です。
前提条件
okxCLIをインストール:npm install -g @okx_ai/okx-trade-cli- 認証情報を設定:
または環境変数を設定:okx config initexport OKX_API_KEY=your_key export OKX_SECRET_KEY=your_secret export OKX_PASSPHRASE=your_passphrase - デモモードでテスト:
okx --profile demo account balance
認証情報とプロファイルの確認
認証が必要なコマンドの前に必ず実行してください。
ステップA — 認証情報の確認
okx config show # 設定状態を確認(出力はマスクされます)
- コマンドがエラーを返した場合、または設定がない場合: すべての操作を停止し、ユーザーに
okx config initの実行を促し、セットアップが完了するまで待ってから再試行します。 - 認証情報が設定されている場合: ステップBに進みます。
ステップB — プロファイルの確認(必須)
--profile はすべての認証コマンドで必須です。プロファイルを暗黙的に追加しないでください。
| 値 | モード | 資金 |
|---|---|---|
live | 実盤 | 実際の資金 |
demo | 模擬盤 | シミュレーション資金 |
解決ルール:
- 現在のメッセージの意図が明確な場合(例: "real" / "実盤" / "live" →
live; "test" / "模擬" / "demo" →demo)→ それを使用し、ユーザーに知らせる:"Using --profile live (実盤)"または"Using --profile demo (模擬盤)" - 現在のメッセージに明示的な宣言がない場合 → 会話のコンテキストで以前のプロファイルを確認:
- 見つかった場合 → それを使用し、ユーザーに知らせる:
"Continuing with --profile live (実盤) from earlier" - 見つからない場合 → 質問する:
"Live (実盤) ですか? Demo (模擬盤) ですか?"— 回答を待ってから続行する
- 見つかった場合 → それを使用し、ユーザーに知らせる:
401認証エラーの処理
いずれかのコマンドが401/認証エラーを返した場合:
- すぐに停止 — 同じコマンドを再試行しない
- ユーザーに通知: "認証に失敗しました (401)。API認証情報が無効か、期限切れの可能性があります。"
- ローカルエディタでファイルを直接編集して認証情報を更新するようユーザーに促す:
該当するプロファイルの~/.okx/config.tomlapi_key、secret_key、passphraseフィールドを更新します。 新しい認証情報をチャットに貼り付けないでください。 - ユーザーがファイルの更新を確認したら、
okx config showを実行して検証します(出力はマスクされます) - その後、元の操作を再試行します
デモモードとライブモード
プロファイルが実盤/模擬盤の切り替えを制御します — 正確に2つのオプション:
--profile | モード | 資金 |
|---|---|---|
live | 実盤 | 実際の資金 |
demo | 模擬盤 | シミュレーション資金 |
okx --profile live account balance # 実盤
okx --profile demo account balance # 模擬盤 (シミュレーション残高)
ルール:
- 読み取りコマンド(残高、ポジション、請求書など): 使用したプロファイルを常に明記する
- 書き込みコマンド(
transfer、set-position-mode): 実行前にプロファイルを確認する必要があります(「認証情報とプロファイルの確認」ステップBを参照)。特に転送は、プロファイルが間違っていると間違ったアカウントに送金されます。 - コマンド後のすべての応答には
[profile: live]または[profile: demo]を追加する --demoフラグは使用しないでください — 代わりに--profileを使用します
スキルルーティング
- マーケットデータ(価格、チャート、デプス、資金調達レート) →
okx-cex-marketを使用 - アカウント残高、損益、ポジション、手数料、転送 →
okx-cex-portfolio(このスキル)を使用 - 通常のスポット/スワップ/先物/アルゴ注文 →
okx-cex-tradeを使用 - グリッドおよびDCAトレーディングボット →
okx-cex-botを使用
クイックスタート
# 取引アカウント残高(残高が0より大きいすべての通貨)
okx account balance
# USDT残高のみ確認
okx account balance USDT
# フィンディングアカウント残高
okx account asset-balance
# すべてのオープンポジション
okx account positions
# 過去のクローズポジションと確定損益(realized PnL)
okx account positions-history
# 最近のアカウント請求書(最新100件)
okx account bills
# 私の取引手数料レベル
okx account fees --instType SPOT
# フィンディング(18)から取引(6)に100 USDTを移動
okx account transfer --ccy USDT --amt 100 --from 18 --to 6
コマンド一覧
読み取りコマンド
| # | コマンド | タイプ | 説明 |
|---|---|---|---|
| 1 | okx account balance [ccy] | READ | 取引アカウントの純資産、利用可能額、凍結額 |
| 2 | okx account asset-balance [ccy] | READ | フィンディングアカウント残高 |
| 3 | okx account positions | READ | オープンな契約/スワップポジション |
| 4 | okx account positions-history | READ | クローズ済みポジション + 確定損益(realized PnL) |
| 5 | okx account bills | READ | アカウント元帳(入金、出金、取引) |
| 6 | okx account fees --instType <type> | READ | 私の取引手数料レベル(メーカー/テイカー) |
| 7 | okx account config | READ | アカウントレベル、ポジションモード、UID |
| 8 | okx account max-size --instId <id> --tdMode <mode> | READ | 現在の価格での最大売買サイズ |
| 9 | okx account max-avail-size --instId <id> --tdMode <mode> | READ | 次の注文に利用可能なサイズ |
| 10 | okx account max-withdrawal [ccy] | READ | 通貨ごとの最大出金可能額 |
書き込みコマンド
| # | コマンド | タイプ | 説明 |
|---|---|---|---|
| 11 | okx account set-position-mode <mode> | WRITE | ネット/ヘッジポジションモードを切り替え |
| 12 | okx account transfer | WRITE | アカウント間で資金を移動 |
クロススキルワークフロー
トレード前の残高確認
ユーザー: "0.1 BTCを買いたいのですが、USDTは足りていますか?"
1. okx-cex-portfolio okx account balance USDT → 利用可能な純資産を確認
2. okx-cex-market okx market ticker BTC-USDT → 現在の価格を確認
↓ ユーザー承認
3. okx-cex-trade okx spot place --instId BTC-USDT --side buy --ordType market --sz 0.1
ボット起動前の残高確認
ユーザー: "1000 USDTでBTCグリッドボットを開始したい"
1. okx-cex-portfolio okx account balance USDT → 利用可能資金 ≥ 1000 を確認
2. okx-cex-market okx market candles BTC-USDT --bar 4H --limit 50 → 価格範囲を決定
↓ ユーザー承認
3. okx-cex-bot okx bot grid create --instId BTC-USDT --algoOrdType grid \
--minPx 90000 --maxPx 100000 --gridNum 10 --quoteSz 1000
オープンポジションと損益の確認
ユーザー: "現在のポジションとそのパフォーマンスを表示して"
1. okx-cex-portfolio okx account positions → 未実現損益(UPL)を含むオープンポジション
2. okx-cex-portfolio okx account positions-history → 最近クローズされたポジション
3. okx-cex-market okx market ticker BTC-USDT-SWAP → 現在の価格とエントリー価格を比較
資金移動と取引
ユーザー: "フィンディングアカウントから500 USDTを移動してBTCを取引したい"
1. okx-cex-portfolio okx account asset-balance USDT → フィンディング残高 ≥ 500 を確認
↓ ユーザー承認
2. okx-cex-portfolio okx account transfer --ccy USDT --amt 500 --from 18 --to 6
3. okx-cex-portfolio okx account balance USDT → 取引残高が更新されたことを確認
↓ 取引準備完了
4. okx-cex-trade okx spot place ...
ポジションエントリー前の最大サイズ確認
ユーザー: "クロスマージンでいくらBTCを買えますか?"
1. okx-cex-portfolio okx account balance → 総純資産
2. okx-cex-portfolio okx account max-size --instId BTC-USDT-SWAP --tdMode cross → 最大売買サイズ
3. okx-cex-market okx market ticker BTC-USDT-SWAP → 現在の価格参照
操作フロー
ステップ0 — 認証情報とプロファイルの確認
認証が必要なコマンドの前に:
プロファイルを決定(必須):
- オプション:
live(実盤)またはdemo(模擬盤) — この2つの値のみ
- 現在のメッセージの意図が明確な場合(例: "real"/"実盤"/"live" → live; "test"/"模擬"/"demo" → demo)→ それを使用し、ユーザーに知らせる:
"Using --profile live (実盤)" - 現在のメッセージに明示的な宣言がない場合 → 会話のコンテキストで以前のプロファイルを確認:
- 見つかった場合 → それを使用し、ユーザーに知らせる:
"Continuing with --profile live (実盤) from earlier" - 見つからない場合 → 質問する:
"Live (実盤) ですか? Demo (模擬盤) ですか?"— 回答を待つ
- 見つかった場合 → それを使用し、ユーザーに知らせる:
認証情報が設定されていない場合: ユーザーに okx config init の実行を促し、すべての取引アクションを停止する
すべてのコマンド結果の後: 応答に [profile: live] または [profile: demo] を追加する
ステップ1: アカウントアクションを特定
- 残高確認 →
okx account balance(取引)またはokx account asset-balance(フィンディング) - オープンポジションを表示 →
okx account positions - クローズポジション + 損益を表示 →
okx account positions-history - 取引履歴を表示 →
okx account bills - 手数料レベルを確認 →
okx account fees - アカウント設定を確認 →
okx account config - 注文サイズを計算 →
okx account max-sizeまたはokx account max-avail-size - 出金制限を確認 →
okx account max-withdrawal - 資金を移動 →
okx account transfer - ポジションモードを変更 →
okx account set-position-mode
ステップ2: 読み取りコマンドはすぐに実行 — 書き込みはプロファイル確認後(ステップ0)に
読み取りコマンド(1–10): すぐに実行、確認不要。
ccyフィルター:USDT、BTC、ETHなどの通貨記号を使用- 手数料/ポジション用の
--instType:SPOT、SWAP、FUTURES、OPTION - 請求書用の
--archive: デフォルトの期間を超えた古いレコードにアクセス - max-size用の
--tdMode:cash(スポット)、cross、またはisolated
書き込みコマンド(11–12): 実行前に一度確認。
set-position-mode: モードを確認(net= 単方向、long_short_mode= ヘッジモード)。切り替えはオープンポジションに影響を与える可能性があります。transfer:--ccy、--amt、--from、--to(アカウントタイプ:6=取引、18=フィンディング)を確認。最初に送金元の残高を確認します。
ステップ3: 書き込み後に確認
set-position-mode後:okx account configを実行してposModeが更新されたことを確認transfer後:okx account balanceとokx account asset-balanceを実行して残高が更新されたことを確認
CLIコマンドリファレンス
アカウント残高 — 取引アカウント
okx account balance [ccy] [--json]
| パラメータ | 必須 | デフォルト | 説明 |
|---|---|---|---|
ccy | いいえ | - | 単一通貨でフィルター(例: USDT) |
戻り値テーブル: currency、equity、available、frozen。残高が0より大きい通貨のみ表示。
資産残高 — フィンディングアカウント
okx account asset-balance [ccy] [--json]
| パラメータ | 必須 | デフォルト | 説明 |
|---|---|---|---|
ccy | いいえ | - | 単一通貨でフィルター |
戻り値: ccy、bal、availBal、frozenBal。残高が0より大きい通貨のみ表示。
ポジション — オープンポジション
okx account positions [--instType <type>] [--instId <id>] [--json]
| パラメータ | 必須 | デフォルト | 説明 |
|---|---|---|---|
--instType | いいえ | - | フィルター: SWAP、FUTURES、OPTION |
--instId | いいえ | - | 特定の銘柄でフィルター |
戻り値: instId、instType、side (posSide)、pos、avgPx、upl(未実現損益)、lever。サイズが0でないポジションのみ表示。
ポジション履歴 — クローズポジション
okx account positions-history [--instType <type>] [--instId <id>] [--limit <n>] [--json]
戻り値: instId、direction、openAvgPx、closeAvgPx、realizedPnl、uTime。
請求書 — アカウント元帳
okx account bills [--archive] [--instType <type>] [--ccy <ccy>] [--limit <n>] [--json]
| パラメータ | 必須 | デフォルト | 説明 |
|---|---|---|---|
--archive | いいえ | false | 古いレコードにアクセス(アーカイブエンドポイント) |
--instType | いいえ | - | 銘柄タイプでフィルター |
--ccy | いいえ | - | 通貨でフィルター |
--limit | いいえ | 100 | レコード数 |
戻り値: billId、instId、type、ccy、balChg、bal、ts。
手数料 — 取引手数料レベル
okx account fees --instType <type> [--instId <id>] [--json]
| パラメータ | 必須 | デフォルト | 説明 |
|---|---|---|---|
--instType | はい | - | SPOT、SWAP、FUTURES、OPTION |
--instId | いいえ | - | 特定の銘柄(オプション) |
戻り値: level、maker、taker、makerU、takerU、ts。
設定 — アカウント設定
okx account config [--json]
戻り値: uid、acctLv(アカウントレベル)、posMode(net/long_short_mode)、autoLoan、greeksType、level、levelTmp。
最大サイズ — 最大注文サイズ
okx account max-size --instId <id> --tdMode <mode> [--px <price>] [--json]
| パラメータ | 必須 | デフォルト | 説明 |
|---|---|---|---|
--instId | はい | - | 銘柄ID |
--tdMode | はい | - | cash(スポット)、cross、または isolated |
--px | いいえ | - | 参照価格(省略時はマーク価格を使用) |
戻り値: instId、maxBuy、maxSell。
最大利用可能サイズ
okx account max-avail-size --instId <id> --tdMode <mode> [--json]
戻り値: instId、availBuy、availSell — 次の注文にすぐに利用可能なサイズ。
最大出金可能額
okx account max-withdrawal [ccy] [--json]
戻り値テーブル: ccy、maxWd、maxWdEx(借入を含む)。フィルターがない場合はすべての通貨を表示。
ポジションモードの設定
okx account set-position-mode <net|long_short_mode> [--json]
| 値 | 動作 |
|---|---|
net | 単方向(デフォルト)— 買いと売りが相殺される |
long_short_mode | ヘッジモード — 買いと売りが共存可能 |
警告: ポジションがオープンしている状態でモードを切り替えると、予期しない動作を引き起こす可能性があります。最初に
okx account positionsで確認してください。
資金移動
okx account transfer --ccy <ccy> --amt <n> --from <acctType> --to <acctType> \
[--transferType <type>] [--subAcct <name>] [--json]
| パラメータ | 必須 | デフォルト | 説明 |
|---|---|---|---|
--ccy | はい | - | 移動する通貨(例: USDT) |
--amt | はい | - | 移動金額 |
--from | はい | - | 送金元アカウントタイプ: 6=取引, 18=フィンディング |
--to | はい | - | 送金先アカウントタイプ: 6=取引, 18=フィンディング |
--transferType | いいえ | 0 | 0=アカウント内, 1=サブアカウントへ, 2=サブアカウントから |
--subAcct | いいえ | - | サブアカウント名(サブアカウント間の移動に必須) |
戻り値: transId、ccy、amt。
MCPツールリファレンス
| ツール | 説明 |
|---|---|
account_get_balance | 取引アカウントの残高 |
account_get_asset_balance | フィンディングアカウントの残高 |
account_get_positions | オープンポジション |
account_get_positions_history | クローズポジションと確定損益 |
account_get_bills | アカウントの請求書(取引履歴) |
account_get_fees | 取引手数料レベル |
account_get_config | アカウント設定 |
account_get_max_size | 最大注文サイズ |
account_get_max_avail_size | 利用可能な最大サイズ |
account_get_max_withdrawal | 最大出金可能額 |
account_set_position_mode | ポジションモードの切り替え |
account_transfer | アカウント間の資金移動 |
注意事項
- すべての読み取りコマンドは、ユーザーの事前確認なしに実行できます。
- 書き込みコマンド(資金移動、ポジションモード変更)は、実行前にユーザーの明示的な承認を得てください。
- 常に応答にプロファイル情報
[profile: live]または[profile: demo]を含めてください。 - 認証エラーが発生した場合は、すぐに停止し、ガイダンスに従って認証情報を更新してください。