@okx_ai/okx-trade-cli 1.3.9 → 1.4.0-beta.1

package/dist/index.js

@@ -2111,6 +2111,13 @@ function requireString(args, key) {
   }
   return value;
 }
+function requireBoolean(args, key) {
+  const value = readBoolean(args, key);
+  if (value === void 0) {
+    throw new ValidationError(`Missing required parameter "${key}".`);
+  }
+  return value;
+}
 function assertEnum(value, key, values) {
   if (value === void 0) {
     return;
@@ -5545,6 +5552,136 @@ function registerGridTools() {
         );
         return normalizeWrite(response);
       }
+    },
+    {
+      name: "grid_get_positions",
+      title: "Grid Bot Get Positions",
+      module: "bot.grid",
+      description: "Get open contract-grid positions for an active or recently-stopped contract-grid bot. Returns liquidation price, margin ratio, and unrealized PnL.",
+      isWrite: false,
+      inputSchema: {
+        type: "object",
+        properties: {
+          algoId: { type: "string", description: "Grid bot algo order ID" },
+          algoOrdType: {
+            type: "string",
+            enum: ["contract_grid"],
+            description: "Must be contract_grid"
+          }
+        },
+        required: ["algoId", "algoOrdType"]
+      },
+      handler: async (rawArgs, context) => {
+        const args = asRecord(rawArgs);
+        const response = await context.client.privateGet(
+          "/api/v5/tradingBot/grid/positions",
+          {
+            algoId: requireString(args, "algoId"),
+            algoOrdType: requireString(args, "algoOrdType")
+          },
+          privateRateLimit("grid_get_positions", 20)
+        );
+        return normalizeResponse(response);
+      }
+    },
+    {
+      name: "grid_get_liquidate_price",
+      title: "Grid Bot Get Liquidation Price",
+      module: "bot.grid",
+      description: "Estimate the liquidation price for a contract-grid bot before creating it. Contract grid only. Requires the full intended config: instId, sz (margin), lever, the grid range (maxPx, minPx, gridNum) and direction. runType defaults to arithmetic ('1'); triggerStrategy is optional.",
+      isWrite: false,
+      inputSchema: {
+        type: "object",
+        properties: {
+          instId: { type: "string", description: "Instrument ID, e.g. BTC-USDT-SWAP" },
+          sz: { type: "string", description: "Margin size in USDT (or base coin for CoinM)" },
+          lever: { type: "string", description: "Leverage, e.g. '5'" },
+          direction: {
+            type: "string",
+            enum: ["long", "short", "neutral"],
+            description: "Bot direction (pass 'neutral' for a neutral bot)"
+          },
+          basePos: { type: "boolean", description: "Whether the base position is opened" },
+          maxPx: { type: "string", description: "Upper price of the grid range" },
+          minPx: { type: "string", description: "Lower price of the grid range" },
+          gridNum: { type: "string", description: "Number of grids" },
+          runType: {
+            type: "string",
+            enum: ["1", "2"],
+            description: "1=arithmetic (default); 2=geometric"
+          },
+          triggerStrategy: {
+            type: "string",
+            enum: ["instant", "price", "rsi", "webhook"],
+            description: "Entry trigger strategy for the intended bot"
+          }
+        },
+        required: ["instId", "sz", "lever", "maxPx", "minPx", "gridNum", "direction"]
+      },
+      handler: async (rawArgs, context) => {
+        const args = asRecord(rawArgs);
+        const missing = ["maxPx", "minPx", "gridNum", "direction"].filter(
+          (key) => readString(args, key) === void 0
+        );
+        if (missing.length > 0) {
+          throw new OkxApiError(
+            `Missing required parameter(s): ${missing.join(", ")}. A liquidation-price estimate needs the full intended config \u2014 instId, sz, lever, maxPx, minPx, gridNum and direction.`,
+            { code: "", endpoint: "grid_get_liquidate_price" }
+          );
+        }
+        const response = await context.client.privateGet(
+          "/api/v5/tradingBot/grid/liquidate-price",
+          compactObject({
+            instId: requireString(args, "instId"),
+            sz: requireString(args, "sz"),
+            lever: requireString(args, "lever"),
+            direction: readString(args, "direction"),
+            basePos: readBoolean(args, "basePos"),
+            maxPx: readString(args, "maxPx"),
+            minPx: readString(args, "minPx"),
+            gridNum: readString(args, "gridNum"),
+            runType: readString(args, "runType") ?? "1",
+            triggerStrategy: readString(args, "triggerStrategy")
+          }),
+          privateRateLimit("grid_get_liquidate_price", 20)
+        );
+        return normalizeResponse(response);
+      }
+    },
+    {
+      name: "grid_close_position",
+      title: "Grid Bot Close Position",
+      module: "bot.grid",
+      description: "[CAUTION] Close the remaining open position of a contract-grid bot that was stopped with stopType='2'. Use grid_get_positions first to confirm the position exists and check its size before closing. Use mktClose=true for an immediate market close, or mktClose=false to place a limit close order (provide sz and px).",
+      isWrite: true,
+      inputSchema: {
+        type: "object",
+        properties: {
+          algoId: { type: "string", description: "Grid bot algo order ID" },
+          mktClose: {
+            type: "boolean",
+            description: "Required, no default (fund-moving): true=market close immediately; false=limit close (requires sz and px)."
+          },
+          sz: { type: "string", description: "Close size (required when mktClose=false)" },
+          px: { type: "string", description: "Limit price (required when mktClose=false)" }
+        },
+        required: ["algoId", "mktClose"]
+      },
+      handler: async (rawArgs, context) => {
+        const args = asRecord(rawArgs);
+        const mktClose = requireBoolean(args, "mktClose");
+        const response = await context.client.privatePost(
+          "/api/v5/tradingBot/grid/close-position",
+          compactObject({
+            algoId: requireString(args, "algoId"),
+            mktClose,
+            sz: readString(args, "sz"),
+            px: readString(args, "px")
+          }),
+          privateRateLimit("grid_close_position", 20)
+        );
+        return normalizeWrite(response);
+      }
     }
   ];
 }
@@ -10771,9 +10908,9 @@ var CALENDAR_REGIONS = [
   "zimbabwe"
 ];
 var NEWS_LANGUAGE = ["en-US", "zh-CN"];
-function langHeader(lang) {
-  if (lang === "zh-CN" || lang === "zh_CN") return { "Accept-Language": "zh-CN" };
-  return { "Accept-Language": "en-US" };
+function acceptLanguage(lang) {
+  if (lang === "zh-CN" || lang === "zh_CN") return "zh_CN";
+  return "en_US";
 }
 var NEWS_DETAIL_LVL = ["brief", "summary", "full"];
 var NEWS_IMPORTANCE = ["high", "low"];
@@ -10831,10 +10968,10 @@ function registerNewsTools() {
             end: readNumber(args, "end"),
             detailLvl: readString(args, "detailLvl"),
             limit: readNumber(args, "limit") ?? 10,
-            cursor: readString(args, "after")
+            cursor: readString(args, "after"),
+            acceptLanguage: acceptLanguage(readString(args, "language"))
           }),
-          publicRateLimit("news_get_latest", 20),
-          langHeader(readString(args, "language"))
+          publicRateLimit("news_get_latest", 20)
         );
         return normalizeResponse(response);
       }
@@ -10875,10 +11012,10 @@ function registerNewsTools() {
             begin: readNumber(args, "begin"),
             end: readNumber(args, "end"),
             detailLvl: readString(args, "detailLvl"),
-            limit: readNumber(args, "limit") ?? 10
+            limit: readNumber(args, "limit") ?? 10,
+            acceptLanguage: acceptLanguage(readString(args, "language"))
           }),
-          publicRateLimit("news_get_by_coin", 20),
-          langHeader(readString(args, "language"))
+          publicRateLimit("news_get_by_coin", 20)
         );
         return normalizeResponse(response);
       }
@@ -10933,10 +11070,10 @@ function registerNewsTools() {
             end: readNumber(args, "end"),
             detailLvl: readString(args, "detailLvl"),
             limit: readNumber(args, "limit") ?? 10,
-            cursor: readString(args, "after")
+            cursor: readString(args, "after"),
+            acceptLanguage: acceptLanguage(readString(args, "language"))
           }),
-          publicRateLimit("news_search", 20),
-          langHeader(readString(args, "language"))
+          publicRateLimit("news_search", 20)
         );
         return normalizeResponse(response);
       }
@@ -10966,9 +11103,8 @@ function registerNewsTools() {
         }
         const response = await context.client.privateGet(
           NEWS_DETAIL,
-          { id },
-          publicRateLimit("news_get_detail", 20),
-          langHeader(readString(args, "language"))
+          { id, acceptLanguage: acceptLanguage(readString(args, "language")) },
+          publicRateLimit("news_get_detail", 20)
         );
         return normalizeResponse(response);
       }
@@ -14923,7 +15059,7 @@ async function cmdDiagnoseMcp(options = {}) {
 
 // src/commands/diagnose.ts
 var CLI_VERSION = readCliVersion();
-var GIT_HASH = true ? "2b5e5c85" : "dev";
+var GIT_HASH = true ? "0a33fb41" : "dev";
 function maskKey2(key) {
   if (!key) return "(not set)";
   if (key.length <= 8) return "****";
@@ -16154,6 +16290,21 @@ var CLI_REGISTRY = {
             toolName: "grid_stop_order",
             usage: "okx bot grid stop --algoId <id> --algoOrdType <type> --instId <id> [--stopType <1|2>]",
             description: "Stop a running grid bot order"
+          },
+          positions: {
+            toolName: "grid_get_positions",
+            usage: "okx bot grid positions --algoId <id> --algoOrdType contract_grid",
+            description: "Get open contract-grid positions (liquidation price, margin ratio, unrealized PnL)"
+          },
+          "liquidate-price": {
+            toolName: "grid_get_liquidate_price",
+            usage: "okx bot grid liquidate-price --instId <id> --sz <margin> --lever <leverage> --maxPx <px> --minPx <px> --gridNum <n> --direction <long|short|neutral> [--runType <1|2>] [--triggerStrategy <instant|price|rsi|webhook>]",
+            description: "Estimate liquidation price for a contract-grid bot"
+          },
+          "close-position": {
+            toolName: "grid_close_position",
+            usage: "okx bot grid close-position --algoId <id> (--mktClose | --no-mktClose) [--sz <size>] [--px <price>]",
+            description: "Close remaining open position after bot stopped with stopType=2 (close mode is required: --mktClose for market, --no-mktClose --sz --px for limit)"
           }
         }
       },
@@ -17166,12 +17317,19 @@ var CLI_OPTIONS = {
   quoteSz: { type: "string" },
   baseSz: { type: "string" },
   direction: { type: "string" },
-  basePos: { type: "boolean", default: true },
+  // No parser default: a global default:true would bleed into `liquidate-price`
+  // (forcing basePos=true, wrong for neutral bots). `grid_create_order`'s handler
+  // already applies the `?? true` default, so create is unaffected; liquidate-price
+  // can now omit basePos. Use --basePos / --no-basePos to set it explicitly.
+  basePos: { type: "boolean" },
   tpRatio: { type: "string" },
   slRatio: { type: "string" },
   algoClOrdId: { type: "string" },
   stopType: { type: "string" },
   topUpAmt: { type: "string" },
+  // grid position management
+  // Fund-moving: no default — close-position requires an explicit --mktClose/--no-mktClose.
+  mktClose: { type: "boolean" },
   live: { type: "boolean", default: false },
   // grid sub-orders pending filter (separate from global --live trading mode,
   // which is mutually exclusive with --demo and so unusable in demo mode)
@@ -20492,6 +20650,66 @@ async function cmdGridStop(run, opts) {
   if (opts.json) return printJson(data);
   emitWriteResult5(data?.[0], "Grid bot stopped", "algoId");
 }
+async function cmdGridPositions(run, opts) {
+  const result = await run("grid_get_positions", {
+    algoId: opts.algoId,
+    algoOrdType: opts.algoOrdType
+  });
+  const positions = getData8(result) ?? [];
+  if (opts.json) return printJson(positions);
+  if (!positions.length) {
+    outputLine("No positions");
+    return;
+  }
+  printTable(
+    positions.map((p) => ({
+      algoId: p["algoId"],
+      instId: p["instId"],
+      pos: p["pos"],
+      posSide: p["posSide"],
+      liqPx: p["liqPx"],
+      mgnRatio: p["mgnRatio"],
+      upl: p["upl"]
+    }))
+  );
+}
+async function cmdGridLiquidatePrice(run, opts) {
+  const result = await run("grid_get_liquidate_price", {
+    instId: opts.instId,
+    sz: opts.sz,
+    lever: opts.lever,
+    direction: opts.direction,
+    basePos: opts.basePos,
+    maxPx: opts.maxPx,
+    minPx: opts.minPx,
+    gridNum: opts.gridNum,
+    runType: opts.runType,
+    triggerStrategy: opts.triggerStrategy
+  });
+  const data = getData8(result) ?? [];
+  if (opts.json) return printJson(data);
+  const item = data[0];
+  if (!item) {
+    outputLine("No data");
+    return;
+  }
+  printKv({
+    instId: item["instId"],
+    liqPx: item["liqPx"],
+    direction: item["direction"]
+  });
+}
+async function cmdGridClosePosition(run, opts) {
+  const result = await run("grid_close_position", {
+    algoId: opts.algoId,
+    mktClose: opts.mktClose,
+    sz: opts.sz,
+    px: opts.px
+  });
+  const data = getData8(result);
+  if (opts.json) return printJson(data);
+  emitWriteResult5(data?.[0], "Grid position closed", "algoId");
+}
 async function cmdDcaCreate(run, opts) {
   const result = await run("dca_create_order", {
     instId: opts.instId,
@@ -21822,7 +22040,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 ? "2b5e5c85" : "dev";
+var GIT_HASH2 = true ? "0a33fb41" : "dev";
 function handlePilotCommand(action, json, force, binaryPath) {
   if (action === "status") return cmdPilotStatus(json, binaryPath);
   if (action === "install") return cmdPilotInstall(json, binaryPath);
@@ -22764,7 +22982,41 @@ function handleBotGridCommand(run, v, rest, json) {
       stopType: v.stopType,
       json
     });
-  unknownSubcommand("bot grid", subAction, ["orders", "details", "sub-orders", "create", "amend", "stop"]);
+  if (subAction === "positions")
+    return cmdGridPositions(run, {
+      algoId: v.algoId,
+      algoOrdType: v.algoOrdType,
+      json
+    });
+  if (subAction === "liquidate-price")
+    return cmdGridLiquidatePrice(run, {
+      instId: v.instId,
+      sz: v.sz,
+      lever: v.lever,
+      direction: v.direction,
+      basePos: v.basePos,
+      maxPx: v.maxPx,
+      minPx: v.minPx,
+      gridNum: v.gridNum,
+      runType: v.runType,
+      triggerStrategy: v.triggerStrategy,
+      json
+    });
+  if (subAction === "close-position") {
+    if (v.mktClose === void 0) {
+      errorLine("Missing required --mktClose/--no-mktClose: okx bot grid close-position --algoId <id> (--mktClose | --no-mktClose [--sz <size>] [--px <price>])");
+      process.exitCode = 1;
+      return;
+    }
+    return cmdGridClosePosition(run, {
+      algoId: v.algoId,
+      mktClose: v.mktClose,
+      sz: v.sz,
+      px: v.px,
+      json
+    });
+  }
+  unknownSubcommand("bot grid", subAction, ["orders", "details", "sub-orders", "create", "amend", "stop", "positions", "liquidate-price", "close-position"]);
 }
 function handleBotDcaCommand(run, subAction, v, json) {
   const algoOrdType = v.algoOrdType ?? "contract_dca";