n8n-nodes-tk-modify-orders 1.0.0

package/README.md

@@ -0,0 +1,196 @@
+# n8n-nodes-tk-modify-orders
+
+A custom n8n node package for the **Bitget Exchange** (Futures/Contracts).  
+Includes **all parameters** from the official Bitget API v2 for placing, modifying orders, and managing open positions.
+
+---
+
+## Nodes Included
+
+| Node | Operation |
+|---|---|
+| **Bitget TK – Place Order** | Place a new futures order (all order types, TP/SL presets, STP) |
+| **Bitget TK – Modify Open Order** | Modify pending regular orders, trigger/plan orders, or TP/SL orders |
+| **Bitget TK – Modify Open Position** | Change leverage, margin, margin mode, position mode, set TP/SL, flash close |
+
+---
+
+## Installation
+
+### From npm (once published)
+
+```bash
+cd ~/.n8n/custom
+npm install n8n-nodes-tk-modify-orders
+```
+
+### Manual Installation (local development)
+
+```bash
+# 1. Clone / copy this folder to your n8n custom nodes directory
+cp -r n8n-nodes-tk-modify-orders ~/.n8n/custom/
+
+# 2. Install and build
+cd ~/.n8n/custom/n8n-nodes-tk-modify-orders
+npm install
+npm run build
+
+# 3. Restart n8n
+```
+
+### Build from Source (TypeScript)
+
+```bash
+npm install
+npm run build
+```
+
+---
+
+## Credentials Setup
+
+In n8n, create a new credential of type **Bitget TK API** and fill in:
+
+| Field | Description |
+|---|---|
+| API Key | Your Bitget API Key |
+| Secret Key | Your Bitget Secret Key |
+| Passphrase | The passphrase set when creating your API key |
+
+> Generate credentials at: Bitget → Settings → API Management
+
+---
+
+## Node Reference
+
+### 1. Bitget TK – Place Order
+
+**Endpoint:** `POST /api/v2/mix/order/place-order`
+
+| Parameter | Type | Required | Description |
+|---|---|---|---|
+| symbol | string | ✅ | e.g. `BTCUSDT` |
+| productType | select | ✅ | USDT-FUTURES, COIN-FUTURES, USDC-FUTURES, SUSDT-FUTURES, SCOIN-FUTURES, SUSDC-FUTURES |
+| marginMode | select | ✅ | `isolated` / `crossed` |
+| marginCoin | string | ✅ | e.g. `USDT` |
+| side | select | ✅ | `buy` / `sell` |
+| tradeSide | select | — | `open` / `close` (hedge mode only) |
+| orderType | select | ✅ | `limit` / `market` |
+| size | string | ✅ | Order quantity |
+| price | string | for limit | Limit price |
+| force | select | — | `gtc` / `ioc` / `fok` / `post_only` |
+| clientOid | string | — | Custom order ID (recommended) |
+| reduceOnly | select | — | `NO` / `YES` |
+| presetStopSurplusPrice | string | — | Preset TP trigger price |
+| presetStopSurplusExecutePrice | string | — | Preset TP execute price |
+| presetStopSurplusTriggerType | select | — | `fill_price` / `mark_price` / `index_price` |
+| presetStopLossPrice | string | — | Preset SL trigger price |
+| presetStopLossExecutePrice | string | — | Preset SL execute price |
+| presetStopLossTriggerType | select | — | `fill_price` / `mark_price` / `index_price` |
+| stpMode | select | — | Self-trade prevention: `cancel_maker` / `cancel_taker` / `cancel_both` |
+
+---
+
+### 2. Bitget TK – Modify Open Order
+
+Choose the **Order Operation**:
+
+#### A) Modify Regular Order
+**Endpoint:** `POST /api/v2/mix/order/modify-order`
+
+| Parameter | Description |
+|---|---|
+| symbol, productType, marginCoin | Identify the market |
+| orderId / clientOid | Identify the order (at least one required) |
+| newClientOid | Reassign a new client ID |
+| newPrice | New limit price |
+| newSize | New quantity |
+| newPresetStopSurplusPrice | Update attached TP price |
+| newPresetStopLossPrice | Update attached SL price |
+
+#### B) Modify Trigger / Plan Order
+**Endpoint:** `POST /api/v2/mix/order/modify-plan-order`
+
+| Parameter | Description |
+|---|---|
+| planType | `normal_plan` (trigger) / `track_plan` (trailing stop) |
+| orderId / clientOid | Identify the order |
+| newSize | New quantity |
+| newPrice | New execution price |
+| newTriggerPrice | New trigger price |
+| newTriggerType | `fill_price` / `mark_price` / `index_price` |
+| newCallbackRatio | Trailing ratio (%) for `track_plan` |
+| newStopSurplusTriggerPrice / Type / ExecutePrice | Attached TP modification |
+| newStopLossTriggerPrice / Type / ExecutePrice | Attached SL modification |
+
+#### C) Modify TP/SL Order
+**Endpoint:** `POST /api/v2/mix/order/modify-tpsl-order`
+
+| Parameter | Description |
+|---|---|
+| orderId / clientOid | Identify the order |
+| triggerPrice | New trigger price |
+| triggerType | `fill_price` / `mark_price` / `index_price` |
+| executePrice | New execution price (`0` = market) |
+| size | New quantity |
+| rangeRate | Trailing % for trailing TP/SL |
+
+---
+
+### 3. Bitget TK – Modify Open Position
+
+Choose the **Position Operation**:
+
+| Operation | Endpoint | Key Parameters |
+|---|---|---|
+| Change Leverage | `POST /api/v2/mix/account/set-leverage` | symbol, productType, marginCoin, leverage, holdSide (long/short for hedge) |
+| Adjust Position Margin | `POST /api/v2/mix/account/set-margin` | symbol, productType, marginCoin, amount (+/-), holdSide |
+| Change Margin Mode | `POST /api/v2/mix/account/set-margin-mode` | symbol, productType, marginCoin, marginMode (isolated/crossed) |
+| Change Position Mode | `POST /api/v2/mix/account/set-position-mode` | productType, posMode (one_way_mode/hedge_mode) |
+| Set Position TP/SL | `POST /api/v2/mix/order/place-pos-tpsl` | symbol, holdSide, stopSurplus + stopLoss trigger/execute/type prices, custom clientOids |
+| Place Single TP/SL | `POST /api/v2/mix/order/place-tpsl-order` | planType, symbol, holdSide, triggerPrice, triggerType, executePrice, size, rangeRate |
+| Flash Close Position | `POST /api/v2/mix/order/close-positions` | symbol, productType, holdSide (or both), clientOid |
+
+---
+
+## Position Mode Guide
+
+**One-Way Mode:**
+- `side=buy` → Opens long OR closes short  
+- `side=sell` → Opens short OR closes long  
+- Use `reduceOnly=YES` to force close-only
+
+**Hedge Mode:**
+- `side=buy` + `tradeSide=open` → Open long  
+- `side=buy` + `tradeSide=close` → Close long  
+- `side=sell` + `tradeSide=open` → Open short  
+- `side=sell` + `tradeSide=close` → Close short  
+
+---
+
+## Rate Limits
+
+All endpoints: **10 requests/second per UID**
+
+---
+
+## API Reference
+
+- [Bitget API v2 Docs](https://www.bitget.com/api-doc/common/intro)
+- [Place Order](https://www.bitget.com/api-doc/contract/trade/Place-Order)
+- [Modify Order](https://www.bitget.com/api-doc/contract/trade/Modify-Order)
+- [Modify Trigger Order](https://www.bitget.com/api-doc/contract/plan/Modify-Plan-Order)
+- [Modify TPSL Order](https://www.bitget.com/api-doc/contract/plan/Modify-Tpsl-Order)
+- [Flash Close](https://www.bitget.com/api-doc/contract/trade/Flash-Close-Position)
+- [Set Leverage](https://www.bitget.com/api-doc/contract/account/Change-Leverage)
+- [Set Margin](https://www.bitget.com/api-doc/contract/account/Change-Margin)
+- [Set Margin Mode](https://www.bitget.com/api-doc/contract/account/Change-Margin-Mode)
+- [Set Position Mode](https://www.bitget.com/api-doc/contract/account/Change-Hold-Mode)
+- [Place Pos TPSL](https://www.bitget.com/api-doc/contract/plan/Place-Pos-Tpsl-Order)
+- [Place TPSL Order](https://www.bitget.com/api-doc/contract/plan/Place-Tpsl-Order)
+
+---
+
+## License
+
+MIT

package/dist/credentials/BitgetTKApi.credentials.d.ts

@@ -0,0 +1,8 @@
+import { ICredentialType, INodeProperties } from 'n8n-workflow';
+export declare class BitgetTKApi implements ICredentialType {
+    name: string;
+    displayName: string;
+    documentationUrl: string;
+    properties: INodeProperties[];
+}
+//# sourceMappingURL=BitgetTKApi.credentials.d.ts.map

package/dist/credentials/BitgetTKApi.credentials.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BitgetTKApi.credentials.d.ts","sourceRoot":"","sources":["../../credentials/BitgetTKApi.credentials.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,eAAe,EAChB,MAAM,cAAc,CAAC;AAEtB,qBAAa,WAAY,YAAW,eAAe;IACjD,IAAI,SAAiB;IACrB,WAAW,SAAmB;IAC9B,gBAAgB,SAAiD;IACjE,UAAU,EAAE,eAAe,EAAE,CA4B3B;CACH"}

package/dist/credentials/BitgetTKApi.credentials.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BitgetTKApi = void 0;
+class BitgetTKApi {
+    constructor() {
+        this.name = 'bitgetTKApi';
+        this.displayName = 'Bitget TK API';
+        this.documentationUrl = 'https://www.bitget.com/api-doc/common/intro';
+        this.properties = [
+            {
+                displayName: 'API Key',
+                name: 'apiKey',
+                type: 'string',
+                typeOptions: { password: true },
+                default: '',
+                required: true,
+                description: 'Your Bitget API Key',
+            },
+            {
+                displayName: 'Secret Key',
+                name: 'secretKey',
+                type: 'string',
+                typeOptions: { password: true },
+                default: '',
+                required: true,
+                description: 'Your Bitget Secret Key',
+            },
+            {
+                displayName: 'Passphrase',
+                name: 'passphrase',
+                type: 'string',
+                typeOptions: { password: true },
+                default: '',
+                required: true,
+                description: 'Your Bitget API Passphrase',
+            },
+        ];
+    }
+}
+exports.BitgetTKApi = BitgetTKApi;
+//# sourceMappingURL=BitgetTKApi.credentials.js.map

package/dist/credentials/BitgetTKApi.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BitgetTKApi.credentials.js","sourceRoot":"","sources":["../../credentials/BitgetTKApi.credentials.ts"],"names":[],"mappings":";;;AAKA,MAAa,WAAW;IAAxB;QACE,SAAI,GAAG,aAAa,CAAC;QACrB,gBAAW,GAAG,eAAe,CAAC;QAC9B,qBAAgB,GAAG,6CAA6C,CAAC;QACjE,eAAU,GAAsB;YAC9B;gBACE,WAAW,EAAE,SAAS;gBACtB,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE;gBAC/B,OAAO,EAAE,EAAE;gBACX,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,qBAAqB;aACnC;YACD;gBACE,WAAW,EAAE,YAAY;gBACzB,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE;gBAC/B,OAAO,EAAE,EAAE;gBACX,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,wBAAwB;aACtC;YACD;gBACE,WAAW,EAAE,YAAY;gBACzB,IAAI,EAAE,YAAY;gBAClB,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE;gBAC/B,OAAO,EAAE,EAAE;gBACX,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,4BAA4B;aAC1C;SACF,CAAC;IACJ,CAAC;CAAA;AAjCD,kCAiCC"}

package/dist/nodes/BitgetTK/BitgetHelper.d.ts

@@ -0,0 +1,10 @@
+export interface BitgetCredentials {
+    apiKey: string;
+    secretKey: string;
+    passphrase: string;
+}
+export declare function createSignature(timestamp: string, method: string, requestPath: string, body: string, secretKey: string): string;
+export declare function buildHeaders(credentials: BitgetCredentials, method: string, requestPath: string, body: string): Record<string, string>;
+export declare function bitgetRequest(credentials: BitgetCredentials, method: 'GET' | 'POST', endpoint: string, body?: Record<string, unknown>): Promise<unknown>;
+export declare function cleanBody(obj: Record<string, unknown>): Record<string, unknown>;
+//# sourceMappingURL=BitgetHelper.d.ts.map

package/dist/nodes/BitgetTK/BitgetHelper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BitgetHelper.d.ts","sourceRoot":"","sources":["../../../nodes/BitgetTK/BitgetHelper.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,wBAAgB,eAAe,CAC7B,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,MAAM,EACZ,SAAS,EAAE,MAAM,GAChB,MAAM,CAMR;AAED,wBAAgB,YAAY,CAC1B,WAAW,EAAE,iBAAiB,EAC9B,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,MAAM,GACX,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAWxB;AAED,wBAAsB,aAAa,CACjC,WAAW,EAAE,iBAAiB,EAC9B,MAAM,EAAE,KAAK,GAAG,MAAM,EACtB,QAAQ,EAAE,MAAM,EAChB,IAAI,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,GACjC,OAAO,CAAC,OAAO,CAAC,CAelB;AAGD,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAS/E"}

package/dist/nodes/BitgetTK/BitgetHelper.js

@@ -0,0 +1,84 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createSignature = createSignature;
+exports.buildHeaders = buildHeaders;
+exports.bitgetRequest = bitgetRequest;
+exports.cleanBody = cleanBody;
+const crypto = __importStar(require("crypto"));
+function createSignature(timestamp, method, requestPath, body, secretKey) {
+    const message = timestamp + method.toUpperCase() + requestPath + body;
+    return crypto
+        .createHmac('sha256', secretKey)
+        .update(message)
+        .digest('base64');
+}
+function buildHeaders(credentials, method, requestPath, body) {
+    const timestamp = Date.now().toString();
+    const sign = createSignature(timestamp, method, requestPath, body, credentials.secretKey);
+    return {
+        'ACCESS-KEY': credentials.apiKey,
+        'ACCESS-SIGN': sign,
+        'ACCESS-TIMESTAMP': timestamp,
+        'ACCESS-PASSPHRASE': credentials.passphrase,
+        'Content-Type': 'application/json',
+        'locale': 'en-US',
+    };
+}
+async function bitgetRequest(credentials, method, endpoint, body = {}) {
+    const baseUrl = 'https://api.bitget.com';
+    const bodyString = method === 'POST' ? JSON.stringify(body) : '';
+    const headers = buildHeaders(credentials, method, endpoint, bodyString);
+    const url = baseUrl + endpoint;
+    const response = await fetch(url, {
+        method,
+        headers,
+        body: method === 'POST' ? bodyString : undefined,
+    });
+    const data = await response.json();
+    return data;
+}
+// Remove keys with undefined or empty string values to avoid sending blank fields
+function cleanBody(obj) {
+    const result = {};
+    for (const key of Object.keys(obj)) {
+        const v = obj[key];
+        if (v !== undefined && v !== '' && v !== null) {
+            result[key] = v;
+        }
+    }
+    return result;
+}
+//# sourceMappingURL=BitgetHelper.js.map

package/dist/nodes/BitgetTK/BitgetHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BitgetHelper.js","sourceRoot":"","sources":["../../../nodes/BitgetTK/BitgetHelper.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAQA,0CAYC;AAED,oCAgBC;AAED,sCAoBC;AAGD,8BASC;AAxED,+CAAiC;AAQjC,SAAgB,eAAe,CAC7B,SAAiB,EACjB,MAAc,EACd,WAAmB,EACnB,IAAY,EACZ,SAAiB;IAEjB,MAAM,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC,WAAW,EAAE,GAAG,WAAW,GAAG,IAAI,CAAC;IACtE,OAAO,MAAM;SACV,UAAU,CAAC,QAAQ,EAAE,SAAS,CAAC;SAC/B,MAAM,CAAC,OAAO,CAAC;SACf,MAAM,CAAC,QAAQ,CAAC,CAAC;AACtB,CAAC;AAED,SAAgB,YAAY,CAC1B,WAA8B,EAC9B,MAAc,EACd,WAAmB,EACnB,IAAY;IAEZ,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;IACxC,MAAM,IAAI,GAAG,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;IAC1F,OAAO;QACL,YAAY,EAAE,WAAW,CAAC,MAAM;QAChC,aAAa,EAAE,IAAI;QACnB,kBAAkB,EAAE,SAAS;QAC7B,mBAAmB,EAAE,WAAW,CAAC,UAAU;QAC3C,cAAc,EAAE,kBAAkB;QAClC,QAAQ,EAAE,OAAO;KAClB,CAAC;AACJ,CAAC;AAEM,KAAK,UAAU,aAAa,CACjC,WAA8B,EAC9B,MAAsB,EACtB,QAAgB,EAChB,OAAgC,EAAE;IAElC,MAAM,OAAO,GAAG,wBAAwB,CAAC;IACzC,MAAM,UAAU,GAAG,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACjE,MAAM,OAAO,GAAG,YAAY,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;IAExE,MAAM,GAAG,GAAG,OAAO,GAAG,QAAQ,CAAC;IAE/B,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;QAChC,MAAM;QACN,OAAO;QACP,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS;KACjD,CAAC,CAAC;IAEH,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;IACnC,OAAO,IAAI,CAAC;AACd,CAAC;AAED,kFAAkF;AAClF,SAAgB,SAAS,CAAC,GAA4B;IACpD,MAAM,MAAM,GAA4B,EAAE,CAAC;IAC3C,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACnC,MAAM,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;QACnB,IAAI,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;YAC9C,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAClB,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/nodes/BitgetTK/BitgetTKModifyOrder.node.d.ts

@@ -0,0 +1,6 @@
+import { IExecuteFunctions, INodeExecutionData, INodeType, INodeTypeDescription } from 'n8n-workflow';
+export declare class BitgetTKModifyOrder implements INodeType {
+    description: INodeTypeDescription;
+    execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
+}
+//# sourceMappingURL=BitgetTKModifyOrder.node.d.ts.map

package/dist/nodes/BitgetTK/BitgetTKModifyOrder.node.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BitgetTKModifyOrder.node.d.ts","sourceRoot":"","sources":["../../../nodes/BitgetTK/BitgetTKModifyOrder.node.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,iBAAiB,EACjB,kBAAkB,EAClB,SAAS,EACT,oBAAoB,EAErB,MAAM,cAAc,CAAC;AAItB,qBAAa,mBAAoB,YAAW,SAAS;IACnD,WAAW,EAAE,oBAAoB,CA6b/B;IAEI,OAAO,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC;CAgFxE"}