Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

opentrader

Package Overview
Dependencies
Maintainers
0
Versions
59
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

opentrader

  • 1.0.0-beta.2
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
6.5K
increased by2274.91%
Maintainers
0
Weekly downloads
 
Created
Source

OpenTrader logo

GitHub Actions Workflow Status GitHub commit activity Static Badge

OpenTrader is an advanced cryptocurrency trading bot offering high-frequency, cross-exchange arbitrage and event-based strategies, including technical analysis with indicators. Features a user-friendly management UI, robust backtesting capabilities, and support for 100+ exchanges via CCXT.

Strategies:

  • Grid: A grid trading strategy that profits from the price fluctuation of an asset.
  • RSI: A Relative Strength Index (RSI) strategy that buys and sells based on the RSI indicator.
  • DCA: Dollar-Cost Averaging (DCA) strategy that buys an asset at regular intervals.
  • ARB: Arbitrage strategy that takes advantage of price differences through cross-exchange trading.

Quick start

Get started with OpenTrader in just a few steps. Follow this quick guide to install, configure, and run your crypto trading bot.

Installation

  1. Install OpenTrader globally using npm:
npm install -g opentrader
  1. Set an admin password for later accessing the OpenTrader UI:
opentrader set-password <password>
  1. Start the OpenTrader app
opentrader up

The app will start the RPC server and listen on port 8000.

Tip: Use opentrader up -d to start the app as a daemon. To stop it, run opentrader down.

Usage

UI

The user interface allows managing multiple bots and strategies, viewing backtest results, and monitoring live trading.

UI Preview

You can access the OpenTrader UI on: http://localhost:8000

CLI

Connect an exchange

Copy the exchanges.sample.json5 file to exchanges.json5 and add your API keys.

Available exchanges: OKX, BYBIT, BINANCE, KRAKEN, COINBASE, GATEIO

Choose a strategy

Create the strategy configuration file config.json5. We will use the grid strategy as an example.

{
  // Grid strategy params
  settings: {
    highPrice: 70000, // upper price of the grid
    lowPrice: 60000, // lower price of the grid
    gridLevels: 20, // number of grid levels
    quantityPerGrid: 0.0001, // quantity in base currency per each grid
  },
  pair: "BTC/USDT",
  exchange: "DEFAULT",
}

Currently supported strategies: grid, rsi

Run a backtest

Command: opentrader backtest <strategy> --from <date> --to <date> -t <timeframe>

Example running a grid strategy on 1h timeframe.

opentrader backtest grid --from 2024-03-01 --to 2024-06-01 -t 1h

To get more accurate results, use a smaller timeframe, e.g. 1m, however, it will take more time to download OHLC data from the exchange.

Running a Live Trading

Command: opentrader trade <strategy>

Example running a live trading with grid strategy.

opentrader trade grid

To stop the live trading, run opentrader stop

Project structure

🪪 License

Licensed under the Apache 2.0 License. See the LICENSE file for more information.

Disclaimer

This software is for educational purposes only. USE THE SOFTWARE AT YOUR OWN RISK. THE AUTHORS AND ALL AFFILIATES ASSUME NO RESPONSIBILITY FOR YOUR TRADING RESULTS. Do not risk money that you are afraid to lose. There might be bugs in the code - this software DOES NOT come with ANY warranty.

FAQs

Package last updated on 14 Aug 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc