n8n-nodes-crypto-com-exchange
v1.0.0
Published
A comprehensive n8n community node for Crypto.com Exchange providing spot trading, derivatives, margin trading, wallet management, and market data operations with HMAC-SHA256 authentication.
Maintainers
Readme
n8n-nodes-crypto-com-exchange
[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 [email protected].
A comprehensive n8n community node for Crypto.com Exchange providing spot trading, derivatives, margin trading, wallet management, and market data operations with HMAC-SHA256 authentication.
Features
- Spot Account Management: View balances, transaction history, deposit/withdrawal operations
- Spot Trading: Place orders (limit, market, stop), cancel orders, view order history and trades
- Derivatives Trading: Manage positions, transfers between spot and derivatives accounts
- Margin Trading: Borrow/repay funds, view loan and interest history
- Market Data: Access real-time tickers, order books, candlesticks, and instrument data
- Wallet Operations: Manage deposit addresses, withdrawals across multiple networks
- HMAC-SHA256 Authentication: Secure API authentication with proper signature generation
- Comprehensive Error Handling: All Crypto.com API error codes properly mapped
Installation
Community Nodes (Recommended)
- Open your n8n instance
- Go to Settings > Community Nodes
- Click Install a community node
- Enter
n8n-nodes-crypto-com-exchange - Click Install
Manual Installation
# Navigate to your n8n installation directory
cd ~/.n8n
# Install the package
npm install n8n-nodes-crypto-com-exchangeDevelopment Installation
# 1. Extract the zip file
unzip n8n-nodes-crypto-com-exchange.zip
cd n8n-nodes-crypto-com-exchange
# 2. Install dependencies
npm install
# 3. Build the project
npm run build
# 4. Create symlink to n8n custom nodes directory
# For Linux/macOS:
mkdir -p ~/.n8n/custom
ln -s $(pwd) ~/.n8n/custom/n8n-nodes-crypto-com-exchange
# For Windows (run as Administrator):
# mklink /D %USERPROFILE%\.n8n\custom\n8n-nodes-crypto-com-exchange %CD%
# 5. Restart n8n
n8n startCredentials Setup
Creating API Credentials
- Log in to Crypto.com Exchange
- Navigate to Settings > API Management
- Create a new API key with the required permissions
- Save both the API Key and Secret Key securely
Configuring in n8n
| Field | Description | |-------|-------------| | API Key | Your Crypto.com Exchange API Key | | API Secret | Your Crypto.com Exchange Secret Key |
Note: For security, store your API credentials securely and never share them.
Resources & Operations
Spot Account (7 operations)
| Operation | Description | |-----------|-------------| | Get Account Summary | Get all account balances | | Get Account Balance | Get balance for a specific currency | | Get Transaction History | List account transactions | | Get Deposit Address | Get crypto deposit address | | Create Withdrawal | Initiate a withdrawal | | Get Withdrawal History | List withdrawals | | Get Deposit History | List deposits |
Spot Trading (7 operations)
| Operation | Description | |-----------|-------------| | Create Order | Place a new order (LIMIT, MARKET, STOP_LIMIT, etc.) | | Cancel Order | Cancel an order by ID | | Cancel All Orders | Cancel all open orders | | Get Open Orders | List all open orders | | Get Order Detail | Get details of a specific order | | Get Order History | List historical orders | | Get Trades | Get trade history |
Derivatives (5 operations)
| Operation | Description | |-----------|-------------| | Get Positions | List all open positions | | Get Position | Get a specific position | | Close Position | Close an open position | | Get Transfer History | List transfers between spot and derivatives | | Transfer | Transfer funds between spot and derivatives |
Margin (6 operations)
| Operation | Description | |-----------|-------------| | Get Margin Account | Get margin account details | | Borrow | Borrow funds for margin trading | | Repay | Repay margin loan | | Get Loan History | List loan history | | Get Interest History | List interest charges | | Get Margin Trading User | Get margin trading user status |
Market Data (7 operations)
| Operation | Description | |-----------|-------------| | Get Instruments | List all available trading pairs | | Get Order Book | Get order book for an instrument | | Get Ticker | Get ticker data for an instrument | | Get All Tickers | Get ticker data for all instruments | | Get Public Trades | Get recent public trades | | Get Candlestick | Get OHLC candlestick data | | Get Valuations | Get price valuations |
Wallet (5 operations)
| Operation | Description | |-----------|-------------| | Get Currency Networks | Get available networks for a currency | | Get Deposit Address | Generate a deposit address | | Create Withdrawal | Initiate a withdrawal | | Get Deposit History | List deposit history | | Get Withdrawal History | List withdrawal history |
Usage Examples
Get Account Balance
// Configure the node:
// Resource: Spot Account
// Operation: Get Account Summary
// Returns all currency balancesPlace a Limit Order
// Configure the node:
// Resource: Spot Trading
// Operation: Create Order
// Instrument Name: BTC_USDT
// Side: BUY
// Type: LIMIT
// Quantity: 0.001
// Price: 40000Get Market Data
// Configure the node:
// Resource: Market Data
// Operation: Get Candlestick
// Instrument Name: BTC_USDT
// Timeframe: 1h
// Options:
// Count: 100API Concepts
Instrument Names
Trading pairs are formatted as BASE_QUOTE, for example:
BTC_USDT- Bitcoin/TetherETH_USDT- Ethereum/TetherCRO_USDT- Cronos/Tether
Order Types
| Type | Description | |------|-------------| | LIMIT | Order at a specific price | | MARKET | Order at current market price | | STOP_LIMIT | Limit order triggered at stop price | | STOP_LOSS | Market order triggered at stop price | | TAKE_PROFIT_LIMIT | Limit order triggered at take profit price |
Time in Force
| Value | Description | |-------|-------------| | GTC | Good Till Cancelled | | IOC | Immediate or Cancel | | FOK | Fill or Kill |
Candlestick Timeframes
Supported intervals: 1m, 5m, 15m, 30m, 1h, 4h, 6h, 12h, 1D, 7D, 14D, 1M
Error Handling
The node handles all Crypto.com API error codes:
| Code | Description | |------|-------------| | 0 | Success | | 10001 | System error | | 10002 | Invalid request | | 10004 | IP rate limit exceeded | | 10005 | User rate limit exceeded | | 10007 | Invalid signature | | 20001 | Insufficient balance | | 30003 | Invalid instrument_name | | 40001 | Order not found |
Security Best Practices
- API Key Permissions: Only enable the permissions you need
- IP Whitelisting: Restrict API access to specific IPs
- Credential Storage: Use n8n's credential system, never hardcode
- Test Environment: Test with small amounts first
- Rate Limiting: Be aware of API rate limits to avoid blocks
Development
# Install dependencies
npm install
# Build the project
npm run build
# Run tests
npm test
# Run tests with coverage
npm run test:coverage
# Lint code
npm run lint
# Fix linting issues
npm run lint:fix
# Watch mode for development
npm run devAuthor
Velocity BPA
- Website: velobpa.com
- GitHub: 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: [email protected]
See LICENSE, COMMERCIAL_LICENSE.md, and LICENSING_FAQ.md for details.
Contributing
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
Support
- Issues: GitHub Issues
- Documentation: Crypto.com Exchange API
- Email: [email protected]
Acknowledgments
- Crypto.com for their comprehensive Exchange API
- n8n for the workflow automation platform
- The n8n community for their continued support
