Skip to content

Latest commit

 

History

History
129 lines (107 loc) · 4.64 KB

README.md

File metadata and controls

129 lines (107 loc) · 4.64 KB
Raw

NPM

BitProphet

BitProphet is a node crypto trading platform for Binance exchange that uses Telegram as its interface. Its main purpose is the automation of trading techniques, but it can also be used as a simple order notification tracker or as an alert system for the most used technical indicators. Suggestions and pull requests are very welcome!

Features

  • Analyse hundreds of tokens in multiple intervals EVERY second
  • Technical Indicators (SMA, EMA, RSI, Stochastics, Bollinger Bands, Ichimoku and more)
  • Stop loss and trailing profits
  • Paper trading
  • Create your own strategies
  • Be notified anywhere

Telegram Interface

Installation

npm install bitprophet --save

Setting Up Telegram

First, you'll need to create a bot for Telegram. Just talk to BotFather and follow simple steps until it gives you a token for it. You'll also need to create a Telegram group, the place where you and BitProphet will communicate. After creating it, add the bot as administrator (make sure to uncheck "All Members Are Admins").

Retrieving Telegram's Group ID

In order to find out the group id you've just created, run node with the following code and then just say something in the group. The bot will reply with the chat id.

const bitprophet = require('bitprophet')
bitprophet.options({
    telegram: {
        token: "YOUR_TELEGRAM_BOT_TOKEN"
    }
})
bitprophet.listenToTelegramChatId()

Chat ID

Getting Started

This is the code to start BitProphet. If the only thing you need is to be notified of trades, you're done.

const bitprophet = require('bitprophet')
bitprophet.options({
    binance: {
        key: "YOUR_BINANCE_API_KEY",
        secret: "YOUR_BINANCE_API_SECRET"
    },
    telegram: {
        chatId: "YOUR_TELEGRAM_GROUP_ID",
        token: "YOUR_TELEGRAM_BOT_TOKEN"
    }
})

bitprophet.start()

You should now see a message in Telegram telling you BitProphet has started.

In Telegram type list and you'll see all the available strategies listed with the respective ids. If a strategy listed has the [PT] prefix, it means it has Paper Trading active. To start a strategy, just type start strategy_id. For example, start buydip.

Getting Started

Adding Strategies

Add the following option naming a new directory for your strategies.

bitprophet.options({
    strategiesDir: "./path/my/strategies"
})

Create index.js inside that folder with the configuration for all your strategies

module.exports = {
    strategies: {
        alertsbb: {
            name: "Alerts Bollinger Bands",
            targetMarket: "BTC"
        },
        quickdip: {
            name: "Quick Dip",
            //buyAmountMarket: 0.012,
            buyPercentageAccount: 0.01,
            profitTarget: 1.4,
            maxLoss: 0.8,
            maxTradingPairs: 4,
            targetMarket: "BTC"
        },
        ichitest: {
            name: "Ichimoku Test",
            paperTrading: true,
            buyAmountMarket: 0.012,
            profitTarget: 1.4,
            maxTradingPairs: 8,
            targetMarket: "BTC"
        },
        //...
    }
}

Create your strategies based on the examples.

Telegram BitProphet Cheat Sheet

  • status / st - Check BitProphet's version and status
  • account / total / ttl - Total balance in BTC and USDT, plus BNB amount
  • btc - BTC value
  • profits / % - Profits
  • profits + / % + - Profits detailed
  • left / l - Trades left
  • pause - Pause system (ongoing trades won't be paused)
  • exit token / sell token - Sells token, if it's currently trading
  • exit token price / sell token price - Sells token@price, if it's currently trading
  • cancel token - Cancel currently trading token
  • orders token - Show account open orders. If token is provided, only open orders for that pair will be returned
  • start strategyId - Starts strategy
  • stop strategyId - Stops strategy
  • list - Lists all strategies
  • list strategyId - Lists all valid / trading pairs for the given strategy
  • restart - Kills the platform. Useful when using a keep alive process manager like pm2.

Contributors: supershwa, ionutgalita