@okx_ai/okx-trade-cli 1.3.4-beta.1 → 1.3.4-beta.2

package/dist/index.js

@@ -9679,6 +9679,58 @@ function registerMarketFilterTools() {
         );
         return normalizeResponse(response);
       }
+    },
+    // ─────────────────────────────────────────────────────────────────────────
+    // market_get_pair_spread — /api/v5/aigc/mcp/pair-spread
+    // ─────────────────────────────────────────────────────────────────────────
+    {
+      name: "market_get_pair_spread",
+      module: "market",
+      description: "Compute spread statistics between two instruments over a lookback window. Returns absolute and ratio spread (mean / stdDev / median / min / max) plus an optional realtime spread snapshot. Use to size pairs trades, detect mean-reversion setups, or compare cross-listed contracts. Results are cached ~60s per (pair, bar, window) tuple. Read-only, no credentials required.\nDo NOT use to fetch raw candles (use market_get_candles) or single-instrument OI/funding (use market_get_oi_history / market_filter_oi_change).",
+      isWrite: false,
+      inputSchema: {
+        type: "object",
+        properties: {
+          instIdA: {
+            type: "string",
+            description: "First instrument ID, e.g. BTC-USDT-SWAP"
+          },
+          instIdB: {
+            type: "string",
+            description: "Second instrument ID; must differ from instIdA"
+          },
+          bar: {
+            type: "string",
+            enum: ["5m", "15m"],
+            description: "Bar size for the spread series. Default 15m. 1m is not supported."
+          },
+          window: {
+            type: "string",
+            description: "Lookback window. Format <n><unit>, units m/H/D/W (case-sensitive), max 1W. Default 1W."
+          },
+          backtestTime: {
+            type: "number",
+            description: "Anchor timestamp (ms epoch) for backtest mode. When provided, realtime is omitted."
+          }
+        },
+        required: ["instIdA", "instIdB"]
+      },
+      handler: async (rawArgs, context) => {
+        const args = asRecord(rawArgs);
+        const body = compactObject({
+          instIdA: requireString(args, "instIdA"),
+          instIdB: requireString(args, "instIdB"),
+          bar: readString(args, "bar"),
+          window: readString(args, "window"),
+          backtestTime: readNumber(args, "backtestTime")
+        });
+        const response = await context.client.publicPost(
+          "/api/v5/aigc/mcp/pair-spread",
+          body,
+          publicRateLimit("market_get_pair_spread", 5)
+        );
+        return normalizeResponse(response);
+      }
     }
   ];
 }
@@ -13751,7 +13803,7 @@ async function cmdDiagnoseMcp(options = {}) {
 
 // src/commands/diagnose.ts
 var CLI_VERSION = readCliVersion();
-var GIT_HASH = true ? "cd99d487" : "dev";
+var GIT_HASH = true ? "0566db8f" : "dev";
 function maskKey2(key) {
   if (!key) return "(not set)";
   if (key.length <= 8) return "****";
@@ -14327,6 +14379,11 @@ var CLI_REGISTRY = {
         toolName: "market_filter_oi_change",
         usage: "okx market oi-change --instType <SWAP|FUTURES> [--bar <5m|15m|1H|4H|1D>] [--sortBy <oiUsd|oiDeltaUsd|oiDeltaPct|absOiDeltaPct|volUsd24h|fundingRate|last>] [--sortOrder <asc|desc>] [--limit <1-100>] [--minOiUsd <n>] [--minVolUsd24h <n>] [--minAbsOiDeltaPct <n>]",
         description: "Find instruments with largest OI changes over a bar window (accumulation/distribution scanner)"
+      },
+      "pair-spread": {
+        toolName: "market_get_pair_spread",
+        usage: "okx market pair-spread <instIdA> <instIdB> [--bar <5m|15m>] [--window <window>] [--backtest-time <ms>] [--json]",
+        description: "Compute spread statistics (abs + ratio) between two instruments over a lookback window"
       }
     },
     subgroups: {
@@ -16031,6 +16088,8 @@ var CLI_OPTIONS = {
   params: { type: "string" },
   list: { type: "boolean", default: false },
   "backtest-time": { type: "string" },
+  // pair-spread
+  window: { type: "string" },
   // news
   coins: { type: "string" },
   sentiment: { type: "string" },
@@ -16554,6 +16613,42 @@ async function cmdMarketOiChangeFilter(run, opts) {
     }))
   );
 }
+async function cmdMarketPairSpread(run, instIdA, instIdB, opts) {
+  const result = await run("market_get_pair_spread", {
+    instIdA,
+    instIdB,
+    bar: opts.bar,
+    window: opts.window,
+    backtestTime: opts.backtestTime
+  });
+  const data = getData2(result);
+  if (opts.json) return printJson(data);
+  const bar = data?.["bar"] ?? "15m";
+  const win = data?.["window"] ?? "1W";
+  const mode = data?.["mode"] ?? "live";
+  outputLine(`${instIdA} / ${instIdB}  bar=${bar} window=${win}  mode=${mode}`);
+  const rt = data?.["realtime"];
+  if (rt) {
+    outputLine(`realtime  lastA=${rt["lastPriceA"]}  lastB=${rt["lastPriceB"]}  abs=${rt["spreadAbs"]}  ratio=${rt["spreadRatio"]}`);
+  }
+  const stats = data?.["statistics"];
+  if (stats) {
+    const abs = stats["absolute"];
+    const ratio = stats["ratio"];
+    const meta = data?.["meta"];
+    outputLine(`samples  count=${meta?.["alignedBars"] ?? "?"}  start=${stats?.["windowStartTs"] ?? "?"}  end=${stats?.["windowEndTs"] ?? "?"}`);
+    printTable([
+      { stat: "mean", absolute: abs?.["mean"], ratio: ratio?.["mean"] },
+      { stat: "stdDev", absolute: abs?.["stdDev"], ratio: ratio?.["stdDev"] },
+      { stat: "median", absolute: abs?.["median"], ratio: ratio?.["median"] },
+      { stat: "min", absolute: abs?.["min"], ratio: ratio?.["min"] },
+      { stat: "max", absolute: abs?.["max"], ratio: ratio?.["max"] }
+    ]);
+    if (meta) {
+      outputLine(`meta  requested=${meta["requestedBars"]}  aligned=${meta["alignedBars"]}  dropped=${meta["droppedBars"]}  truncated=${meta["truncated"]}`);
+    }
+  }
+}
 
 // src/commands/account.ts
 import * as fs7 from "fs";
@@ -20297,7 +20392,7 @@ async function cmdEventCancel(run, opts) {
 // src/index.ts
 var _require3 = createRequire3(import.meta.url);
 var CLI_VERSION2 = _require3("../package.json").version;
-var GIT_HASH2 = true ? "cd99d487" : "dev";
+var GIT_HASH2 = true ? "0566db8f" : "dev";
 function handlePilotCommand(action, json, force, binaryPath) {
   if (action === "status") return cmdPilotStatus(json, binaryPath);
   if (action === "install") return cmdPilotInstall(json, binaryPath);
@@ -20402,6 +20497,15 @@ function handleMarketFilterCommand(run, action, rest, v, json) {
       limit,
       json
     });
+  if (action === "pair-spread") {
+    const backtestTime = v["backtest-time"] !== void 0 ? Number(v["backtest-time"]) : void 0;
+    return cmdMarketPairSpread(run, rest[0], rest[1], {
+      bar: v.bar,
+      window: v.window,
+      backtestTime,
+      json
+    });
+  }
 }
 function handleIndicatorAction(run, rest, v, json) {
   if (rest[0] === "list") return cmdMarketIndicatorList(json);
@@ -20450,7 +20554,8 @@ function handleMarketCommand(run, action, rest, v, json) {
     "filter",
     "oi-history",
     "oi-change",
-    "index-candles"
+    "index-candles",
+    "pair-spread"
   ]);
 }
 function handleAccountWriteCommand(run, action, v, json) {