n8n-nodes-bybit 1.0.0

package/LICENSE

@@ -0,0 +1,46 @@
+Business Source License 1.1
+
+License text copyright (c) 2017 MariaDB Corporation Ab.
+
+Licensor:
+Velocity BPA, LLC
+https://velobpa.com
+
+Licensed Work:
+This repository and all source code, documentation, and associated artifacts
+contained herein, including all n8n community nodes published by Velocity BPA.
+
+Additional Use Grant:
+You may use, modify, and run the Licensed Work free of charge for:
+- Personal use
+- Educational use
+- Research use
+- Internal business use, provided such use does not involve resale,
+  redistribution, or offering the Licensed Work as part of a commercial
+  product or service.
+
+Commercial Use Restriction:
+Commercial Use of the Licensed Work is prohibited without a valid
+Commercial License issued by the Licensor.
+
+Commercial Use includes, but is not limited to:
+- Use of the Licensed Work within any Software-as-a-Service (SaaS),
+  Platform-as-a-Service (PaaS), or hosted application that is sold,
+  licensed, or monetized in any form
+- Offering the Licensed Work as part of a managed services engagement
+- Bundling or redistributing the Licensed Work with a paid product
+- Reselling, sublicensing, or white-labeling the Licensed Work
+- Embedding the Licensed Work into any commercial automation platform,
+  integration product, or solution offering
+
+Change Date:
+January 1, 2030
+
+Change License:
+Apache License, Version 2.0
+
+For commercial licensing inquiries:
+licensing@velobpa.com
+
+Business Source License 1.1 full text:
+https://mariadb.com/bsl11/

package/README.md

@@ -0,0 +1,353 @@
+# n8n-nodes-bybit
+
+> [Velocity BPA Licensing Notice]
+>
+> This n8n node is licensed under the Business Source License 1.1 (BSL 1.1).
+>
+> Use of this node by for-profit organizations in production environments requires a commercial license from Velocity BPA.
+>
+> For licensing information, visit https://velobpa.com/licensing or contact licensing@velobpa.com.
+
+A comprehensive n8n community node for **Bybit** cryptocurrency exchange, providing full integration with the Bybit V5 unified API for spot trading, derivatives (USDT perpetuals, inverse perpetuals), options, and more.
+
+![n8n](https://img.shields.io/badge/n8n-community_node-ff6d5a)
+![Bybit](https://img.shields.io/badge/Bybit-V5_API-F7A600)
+![License](https://img.shields.io/badge/license-BSL--1.1-blue)
+
+## Features
+
+- **11 Resource Categories** with 100+ operations
+- **Unified Trading Account (UTA)** support
+- **All Product Types**: Spot, Linear (USDT/USDC perpetuals), Inverse, Options
+- **Complete Trading Operations**: Place, amend, cancel orders (single and batch)
+- **Position Management**: Leverage, margin modes, TP/SL, trailing stops
+- **Asset Management**: Transfers, deposits, withdrawals
+- **Sub-Account Support**: Create and manage sub-accounts and API keys
+- **Leveraged Tokens**: Purchase and redeem leveraged tokens
+- **Institutional Lending**: Loan and repayment operations
+- **Poll-Based Triggers**: 10 trigger types for automation
+- **Testnet Support**: Full testnet integration for development
+
+## Installation
+
+### Community Nodes (Recommended)
+
+1. Go to **Settings** > **Community Nodes** in n8n
+2. Select **Install**
+3. Enter `n8n-nodes-bybit`
+4. Agree to the risks and click **Install**
+
+### Manual Installation
+
+```bash
+# Navigate to your n8n custom nodes directory
+cd ~/.n8n/custom
+
+# Clone or extract the node package
+npm install n8n-nodes-bybit
+```
+
+### Development Installation
+
+```bash
+# Clone the repository
+git clone https://github.com/Velocity-BPA/n8n-nodes-bybit.git
+cd n8n-nodes-bybit
+
+# Install dependencies
+npm install
+
+# Build the project
+npm run build
+
+# Create symlink to n8n custom nodes directory
+mkdir -p ~/.n8n/custom
+ln -s $(pwd) ~/.n8n/custom/n8n-nodes-bybit
+
+# Restart n8n
+n8n start
+```
+
+## Credentials Setup
+
+| Field | Description | Required |
+|-------|-------------|----------|
+| API Key | Your Bybit API key | Yes |
+| API Secret | Your Bybit API secret | Yes |
+| Environment | `mainnet` or `testnet` | Yes |
+| Receive Window | Request validity window (ms), default: 5000 | No |
+
+### Getting API Keys
+
+1. Log in to [Bybit](https://www.bybit.com) or [Bybit Testnet](https://testnet.bybit.com)
+2. Go to **Account & Security** > **API Management**
+3. Create a new API key with required permissions
+4. Enable IP whitelisting for security (recommended)
+
+## Resources & Operations
+
+### Market Data
+- Get kline (candlestick) data
+- Get mark price, index price, premium index klines
+- Get instruments info
+- Get orderbook depth
+- Get tickers
+- Get funding rate history
+- Get public trading history
+- Get open interest
+- Get historical volatility (options)
+- Get insurance fund data
+- Get risk limits
+- Get delivery price
+- Get long/short ratio
+- Get server time
+
+### Trade
+- Place order (with TP/SL support)
+- Amend order
+- Cancel order
+- Cancel all orders
+- Get open orders
+- Get order history
+- Get trade history
+- Batch place/amend/cancel orders (up to 10)
+- Get spot borrow check
+- Set disconnect cancel all (DCP)
+
+### Position (Derivatives)
+- Get position info
+- Set leverage
+- Switch margin mode (cross/isolated)
+- Set TP/SL mode
+- Switch position mode (one-way/hedge)
+- Set risk limit
+- Set trading stop (TP/SL/trailing)
+- Set auto add margin
+- Add/reduce margin
+- Get closed PnL
+- Move positions
+
+### Account
+- Get wallet balance
+- Get account info
+- Upgrade to Unified Account
+- Get borrow/repay history
+- Get collateral info
+- Get coin Greeks (options)
+- Get fee rates
+- Get transaction log
+- Set margin mode
+- Set spot hedging
+- Set collateral switch
+
+### Asset
+- Get delivery/settlement records
+- Get coin exchange records
+- Get all coins balance
+- Internal transfers
+- Universal transfers
+- Get deposit records
+- Get deposit address
+- Get coin info
+- Withdraw funds
+- Cancel withdrawal
+
+### User (Sub-Accounts)
+- Create sub-account
+- Create/modify/delete API keys
+- Freeze/unfreeze sub-account
+- Get API key info
+- Get affiliate user info
+
+### Spot Leverage Token
+- Get leveraged token info
+- Get market info
+- Purchase tokens
+- Redeem tokens
+- Get purchase/redeem records
+
+### Spot Margin (UTA)
+- Get VIP margin data
+- Toggle margin trade
+- Set leverage
+- Get margin state
+
+### Institutional Lending
+- Get product info
+- Get margin coin info
+- Get loan/repay orders
+- Get LTV info
+- Bind/unbind UID
+
+### Pre-Upgrade Data
+- Get pre-upgrade order history
+- Get pre-upgrade trade history
+- Get pre-upgrade closed PnL
+- Get pre-upgrade transactions
+- Get pre-upgrade option delivery
+
+### Utility
+- Get server time
+- Get announcements
+
+## Trigger Node
+
+The Bybit Trigger node supports poll-based automation:
+
+| Trigger Type | Description |
+|--------------|-------------|
+| New Order | Trigger when a new order is created |
+| Order Filled | Trigger when an order is filled |
+| Order Canceled | Trigger when an order is canceled |
+| Position Opened | Trigger when a new position is opened |
+| Position Closed | Trigger when a position is closed |
+| Price Alert | Trigger when price crosses threshold |
+| Funding Rate Alert | Trigger on funding rate threshold |
+| Liquidation Alert | Trigger when near liquidation |
+| Balance Changed | Trigger on balance change |
+| PnL Threshold | Trigger when PnL exceeds threshold |
+
+## Usage Examples
+
+### Place a Market Order
+
+```javascript
+// Node configuration
+Resource: Trade
+Operation: Place Order
+Category: linear
+Symbol: BTCUSDT
+Side: Buy
+Order Type: Market
+Quantity: 0.001
+```
+
+### Get Account Balance
+
+```javascript
+// Node configuration
+Resource: Account
+Operation: Get Wallet Balance
+Account Type: UNIFIED
+Coin: USDT
+```
+
+### Set Position Leverage
+
+```javascript
+// Node configuration
+Resource: Position
+Operation: Set Leverage
+Category: linear
+Symbol: BTCUSDT
+Buy Leverage: 10
+Sell Leverage: 10
+```
+
+## Bybit Concepts
+
+| Concept | Description |
+|---------|-------------|
+| Category | Product type: `spot`, `linear`, `inverse`, `option` |
+| UTA | Unified Trading Account - single account for all products |
+| Position Mode | One-way (single position) or Hedge (long/short separate) |
+| Margin Mode | Cross (shared margin) or Isolated (per-position margin) |
+| DCP | Disconnect Cancel Protection - auto-cancel on disconnect |
+| Position Idx | 0=one-way, 1=hedge buy, 2=hedge sell |
+
+## Networks
+
+| Network | REST API | Use Case |
+|---------|----------|----------|
+| Mainnet | https://api.bybit.com | Production trading |
+| Testnet | https://api-testnet.bybit.com | Development & testing |
+
+## Error Handling
+
+The node includes comprehensive error handling for Bybit API error codes:
+
+- `10001` - Parameter error
+- `10002` - Request timeout
+- `10003` - Server busy
+- `10004` - Invalid sign
+- `10005` - Permission denied
+- `110001` - Order not found
+- `110007` - Insufficient balance
+- `110012` - Insufficient available balance
+- And many more...
+
+## Security Best Practices
+
+1. **API Key Permissions**: Only enable required permissions
+2. **IP Whitelisting**: Restrict API access to known IPs
+3. **Testnet First**: Test workflows on testnet before production
+4. **Secure Storage**: Use n8n's credential encryption
+5. **Monitor Activity**: Regularly review API key usage
+
+## Development
+
+```bash
+# Install dependencies
+npm install
+
+# Build
+npm run build
+
+# Run tests
+npm test
+
+# Run tests with coverage
+npm run test:coverage
+
+# Lint
+npm run lint
+
+# Format code
+npm run format
+```
+
+## Author
+
+**Velocity BPA**
+- Website: [velobpa.com](https://velobpa.com)
+- GitHub: [Velocity-BPA](https://github.com/Velocity-BPA)
+
+## Licensing
+
+This n8n community node is licensed under the **Business Source License 1.1**.
+
+### Free Use
+Permitted for personal, educational, research, and internal business use.
+
+### Commercial Use
+Use of this node within any SaaS, PaaS, hosted platform, managed service,
+or paid automation offering requires a commercial license.
+
+For licensing inquiries:
+**licensing@velobpa.com**
+
+See [LICENSE](LICENSE), [COMMERCIAL_LICENSE.md](COMMERCIAL_LICENSE.md), and [LICENSING_FAQ.md](LICENSING_FAQ.md) for details.
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Run tests and linting
+5. Submit a pull request
+
+## Support
+
+- **Documentation**: [Bybit V5 API Docs](https://bybit-exchange.github.io/docs/v5/intro)
+- **Issues**: [GitHub Issues](https://github.com/Velocity-BPA/n8n-nodes-bybit/issues)
+- **Commercial Support**: licensing@velobpa.com
+
+## Acknowledgments
+
+- [n8n](https://n8n.io) - Workflow automation platform
+- [Bybit](https://bybit.com) - Cryptocurrency exchange
+- The open-source community
+
+---
+
+**Disclaimer**: This node is not officially affiliated with Bybit. Use at your own risk. Always test on testnet first and never risk more than you can afford to lose.

package/dist/credentials/BybitApi.credentials.d.ts

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"BybitApi.credentials.d.ts","sourceRoot":"","sources":["../../credentials/BybitApi.credentials.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACX,oBAAoB,EACpB,sBAAsB,EACtB,eAAe,EACf,eAAe,EACf,MAAM,cAAc,CAAC;AAEtB,qBAAa,QAAS,YAAW,eAAe;IAC/C,IAAI,SAAc;IAClB,WAAW,SAAe;IAC1B,gBAAgB,SAAoD;IAEpE,UAAU,EAAE,eAAe,EAAE,CA2C3B;IAEF,YAAY,EAAE,oBAAoB,CAGhC;IAEF,IAAI,EAAE,sBAAsB,CAM1B;CACF"}

package/dist/credentials/BybitApi.credentials.js

@@ -0,0 +1,73 @@
+"use strict";
+/*
+ * Copyright (c) Velocity BPA, LLC
+ * Licensed under the Business Source License 1.1
+ * Commercial use requires a separate commercial license.
+ * See LICENSE file for details.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BybitApi = void 0;
+class BybitApi {
+    constructor() {
+        this.name = 'bybitApi';
+        this.displayName = 'Bybit API';
+        this.documentationUrl = 'https://bybit-exchange.github.io/docs/v5/intro';
+        this.properties = [
+            {
+                displayName: 'API Key',
+                name: 'apiKey',
+                type: 'string',
+                typeOptions: { password: true },
+                default: '',
+                required: true,
+                description: 'Your Bybit API key',
+            },
+            {
+                displayName: 'API Secret',
+                name: 'apiSecret',
+                type: 'string',
+                typeOptions: { password: true },
+                default: '',
+                required: true,
+                description: 'Your Bybit API secret',
+            },
+            {
+                displayName: 'Environment',
+                name: 'environment',
+                type: 'options',
+                options: [
+                    {
+                        name: 'Mainnet',
+                        value: 'mainnet',
+                    },
+                    {
+                        name: 'Testnet',
+                        value: 'testnet',
+                    },
+                ],
+                default: 'mainnet',
+                description: 'Select the Bybit environment',
+            },
+            {
+                displayName: 'Receive Window (ms)',
+                name: 'recvWindow',
+                type: 'number',
+                default: 5000,
+                description: 'Time window for request validity in milliseconds',
+            },
+        ];
+        this.authenticate = {
+            type: 'generic',
+            properties: {},
+        };
+        this.test = {
+            request: {
+                baseURL: '={{$credentials.environment === "testnet" ? "https://api-testnet.bybit.com" : "https://api.bybit.com"}}',
+                url: '/v5/market/time',
+                method: 'GET',
+            },
+        };
+    }
+}
+exports.BybitApi = BybitApi;
+//# sourceMappingURL=BybitApi.credentials.js.map

package/dist/credentials/BybitApi.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BybitApi.credentials.js","sourceRoot":"","sources":["../../credentials/BybitApi.credentials.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AASH,MAAa,QAAQ;IAArB;QACC,SAAI,GAAG,UAAU,CAAC;QAClB,gBAAW,GAAG,WAAW,CAAC;QAC1B,qBAAgB,GAAG,gDAAgD,CAAC;QAEpE,eAAU,GAAsB;YAC/B;gBACC,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,oBAAoB;aACjC;YACD;gBACC,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,uBAAuB;aACpC;YACD;gBACC,WAAW,EAAE,aAAa;gBAC1B,IAAI,EAAE,aAAa;gBACnB,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE;oBACR;wBACC,IAAI,EAAE,SAAS;wBACf,KAAK,EAAE,SAAS;qBAChB;oBACD;wBACC,IAAI,EAAE,SAAS;wBACf,KAAK,EAAE,SAAS;qBAChB;iBACD;gBACD,OAAO,EAAE,SAAS;gBAClB,WAAW,EAAE,8BAA8B;aAC3C;YACD;gBACC,WAAW,EAAE,qBAAqB;gBAClC,IAAI,EAAE,YAAY;gBAClB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,IAAI;gBACb,WAAW,EAAE,kDAAkD;aAC/D;SACD,CAAC;QAEF,iBAAY,GAAyB;YACpC,IAAI,EAAE,SAAS;YACf,UAAU,EAAE,EAAE;SACd,CAAC;QAEF,SAAI,GAA2B;YAC9B,OAAO,EAAE;gBACR,OAAO,EAAE,yGAAyG;gBAClH,GAAG,EAAE,iBAAiB;gBACtB,MAAM,EAAE,KAAK;aACb;SACD,CAAC;IACH,CAAC;CAAA;AA9DD,4BA8DC"}

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * n8n-nodes-bybit
+ *
+ * [Velocity BPA Licensing Notice]
+ * This n8n node is licensed under the Business Source License 1.1 (BSL 1.1).
+ * Use of this node by for-profit organizations in production environments requires
+ * a commercial license from Velocity BPA.
+ * For licensing information, visit https://velobpa.com/licensing or contact licensing@velobpa.com.
+ */
+export { BybitApi } from './credentials/BybitApi.credentials';
+export { Bybit } from './nodes/Bybit/Bybit.node';
+export { BybitTrigger } from './nodes/Bybit/BybitTrigger.node';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAGH,OAAO,EAAE,QAAQ,EAAE,MAAM,oCAAoC,CAAC;AAG9D,OAAO,EAAE,KAAK,EAAE,MAAM,0BAA0B,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC"}

package/dist/index.js

@@ -0,0 +1,21 @@
+"use strict";
+/**
+ * n8n-nodes-bybit
+ *
+ * [Velocity BPA Licensing Notice]
+ * This n8n node is licensed under the Business Source License 1.1 (BSL 1.1).
+ * Use of this node by for-profit organizations in production environments requires
+ * a commercial license from Velocity BPA.
+ * For licensing information, visit https://velobpa.com/licensing or contact licensing@velobpa.com.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BybitTrigger = exports.Bybit = exports.BybitApi = void 0;
+// Export credentials
+var BybitApi_credentials_1 = require("./credentials/BybitApi.credentials");
+Object.defineProperty(exports, "BybitApi", { enumerable: true, get: function () { return BybitApi_credentials_1.BybitApi; } });
+// Export nodes
+var Bybit_node_1 = require("./nodes/Bybit/Bybit.node");
+Object.defineProperty(exports, "Bybit", { enumerable: true, get: function () { return Bybit_node_1.Bybit; } });
+var BybitTrigger_node_1 = require("./nodes/Bybit/BybitTrigger.node");
+Object.defineProperty(exports, "BybitTrigger", { enumerable: true, get: function () { return BybitTrigger_node_1.BybitTrigger; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG;;;AAEH,qBAAqB;AACrB,2EAA8D;AAArD,gHAAA,QAAQ,OAAA;AAEjB,eAAe;AACf,uDAAiD;AAAxC,mGAAA,KAAK,OAAA;AACd,qEAA+D;AAAtD,iHAAA,YAAY,OAAA"}

package/dist/nodes/Bybit/Bybit.node.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Bybit n8n Node
+ *
+ * [Velocity BPA Licensing Notice]
+ * This n8n node is licensed under the Business Source License 1.1 (BSL 1.1).
+ * Use of this node by for-profit organizations in production environments requires
+ * a commercial license from Velocity BPA.
+ * For licensing information, visit https://velobpa.com/licensing or contact licensing@velobpa.com.
+ */
+import type { IExecuteFunctions, INodeExecutionData, INodeType, INodeTypeDescription } from 'n8n-workflow';
+export declare class Bybit implements INodeType {
+    description: INodeTypeDescription;
+    execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
+}
+//# sourceMappingURL=Bybit.node.d.ts.map

package/dist/nodes/Bybit/Bybit.node.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Bybit.node.d.ts","sourceRoot":"","sources":["../../../nodes/Bybit/Bybit.node.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EACX,iBAAiB,EACjB,kBAAkB,EAClB,SAAS,EACT,oBAAoB,EAEpB,MAAM,cAAc,CAAC;AA6BtB,qBAAa,KAAM,YAAW,SAAS;IACtC,WAAW,EAAE,oBAAoB,CA+G/B;IAEI,OAAO,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC;CAmEvE"}