This app is working with server maintenance.
- Wex
- Poloniex
- Bittrex
- Exmo
- Bitfinex
- Liqui
Before asking questions, please read the FAQ RU. Most of the answers you will find in it.
-
Install node.js or use hosting (heroku, pivotal, UltraVDS, Zomro and etc.)
-
Copy the repository and install the dependency packages:
$ git clone https://github.com/steeply/gbot-trader.git
$ cd gbot-trader
$ npm i
If you use the option TELEGRAM_OFF, then this paragraph is not necessary.
Use the /newbot command to create a new bot. The BotFather will ask you for a name and username, then generate an authorization token for your new bot.
The name of your bot is displayed in contact details and elsewhere.
The Username is a short name, to be used in mentions and telegram.me links. Usernames are 5-32 characters long and are case insensitive, but may only include Latin characters, numbers, and underscores. Your bot's username must end in ‘bot’, e.g. ‘trade_bot’ or ‘TradeBot’.
The token is a string along the lines of 110201543:AAHdqTcvCH1vGWJxfSeofSAs0K5PALDsaw that is required to authorize the bot and send requests to the Bot API.
- Set the parameters API Exchange:
KEY,SECRETandTELEGRAM_TOKEN. - Run GBot Trader.
- Write your Telegram bot (which you created earlier using @BotFather) any message, you will receive your id number.
- Turn Off GBot Trader.
- Set the parameters
TELEGRAM_ID.
| Option | Description | Type | Default |
|---|---|---|---|
| KEY | API key | string | - |
| SECRET | API secret | string | - |
| NAME_COIN | Trading currency | string | ltc |
| NAME_COIN_TWO | Trading currency | string | usd |
| EXCHANGE | The choice of the exchange wex poloniex (inverted pairs) bittrex (inverted pairs) exmo bitfinex liqui |
string | wex |
| EXCHANGE_HOST | Host exchange API. If the primary host is not available. | string | - |
| TELEGRAM_TOKEN | Telegram token | string | - |
| TELEGRAM_ID | Your User ID Telegram | number | - |
| TELEGRAM_OFF | Disable Telegram | boolean | false |
Option TELEGRAM_OFF disables the ability to use Telegram in the bot. All management and all notifications sent via Telegram are the same are disabled!
By default, the bot will work at default settings. You can change them using the following options.
| Option | Description | Type | Default |
|---|---|---|---|
| TIME_UPDATE_AUTO_SETTINGS | Update time of auto settings (min) | number | 2 |
| DEPOSIT_LIMIT_PERCENT | Deposit consuming percent | number | 100 |
| DEPOSIT_LIMIT_CURRENCY | The size of the used part of the Deposit in the currency NAME_COIN_TWO. For exchanges with inverted currency in the currency of the parameter NAME_COIN |
number | 0 |
| COUNT_ORDERS | Quantity all orders. How many will be installed. |
number | Calculated based on deposit amount |
| QUANTITY_ORDERS_IN_BLOCKS | Quantity orders in blocks How many orders will be simultaneously on the market. |
number | 0 |
| SIZE_FIRST_ORDERS_CURRENCY | The size of the first order in the currency being traded | number | 0 |
| SIZE_FIRST_ORDERS_INSECOND_CURRENCY | The size of the first order in the base currency | number | 0 |
| SIZE_FIRST_ORDERS_PERCENT | The size of the first order in percent | number | 0 |
| SIZE_ORDERS_MARTINGALE | The size of the orders for Martingale (for Exponential - %, Linear - absolute number) | number | 0 |
| MARTINGALE_TYPE | Type Martingale: 1 - exponential 2 - linear |
number | 1 |
| CONTINUE_MARTINGALE_GRID | To continue the grid Martingale when you restart the bot (saves the order size) | boolean | false |
Important!
The size of the order for
SIZE_FIRST_ORDERS_INSECOND_CURRENCYwill be calculated by the formula SIZE_FIRST_ORDERS_INSECOND_CURRENCY / price
SIZE_FIRST_ORDERS_CURRENCY,SIZE_FIRST_ORDERS_INSECOND_CURRENCYorSIZE_FIRST_ORDERS_PERCENTselect only 1 of the parameters!
With the manual size of the first order RANGE_OFFSET does not work, and COUNT_ORDERS will be calculated automatically.
The parameter CONTINUE_MARTINGALE_GRID does not restore indentation when using OFFSET_ORDERS_EXPONENTIAL.
The possible indentation of the orders. Select one of the offered.
| Option | Description | Type | Default |
|---|---|---|---|
| OFFSET_ORDERS_POINTS | Position difference between orders in points | number | 10 |
| OFFSET_ORDERS_PERCENT | Position difference between orders in % | number | 0 |
| OFFSET_ORDERS_EXPONENTIAL | Position difference between orders is exponentially in % | number | 0 |
| RANGE_OFFSET | Range offset | number | 0 |
| OFFSET_FIRST_ORDERS_PERCENT | Position difference of the first order in % | number | 0 |
| OFFSET_FIRST_ORDERS_POINTS | Position difference of the first order in points | number | 0 |
Parameter OFFSET_FIRST_ORDERS_PERCENT or OFFSET_FIRST_ORDERS_POINTS can be used in conjunction with any of the selected options.
To set the first order in the market, use
OFFSET_FIRST_ORDERS_PERCENT=-1orOFFSET_FIRST_ORDERS_POINTS=-1
| Option | Description | Type | Default |
|---|---|---|---|
| DISABLE_GRID_SELL | Disable order placement on the grid for Sell orders | boolean | false |
| DISABLE_GRID_BUY | Disable order placement on the grid for Buy orders | boolean | false |
| Option | Description | Type | Default |
|---|---|---|---|
| DANGER_PRICE_STOP | Bot stopping according to the price spike | boolean | false |
| DANGER_PRICE_STOP_PERCENT | The percentage of the price spike for the bot stopping | number | 9 |
| DYNAMIC_SETTINGS_TIME | Dynamic time updating for auto options | boolean | false |
| DYNAMIC_OFFSET_ORDERS | Dynamic order allocation | boolean | false |
| TREND_DEFINITION | Trend determination (Experimentally) | boolean | false |
| ABRUPT_CHANGE_TREND | Rapid trend reversal (Experimentally) | boolean | false |
| OFF_MODULES_AUTO_SETTINGS | Disabling all Autotune Modules | boolean | false |
Options TREND_DEFINITION ABRUPT_CHANGE_TREND only for strategy Scalper.
The option OFF_MODULES_AUTO_SETTINGS controls DANGER_PRICE_STOP, DYNAMIC_SETTINGS_TIME, DYNAMIC_OFFSET_ORDERS, TREND_DEFINITION, ABRUPT_CHANGE_TREND
All the strategies are mutually exclusive. If no strategy is selected, use the strategy of "Scalper".
| Option | Description | Type | Default |
|---|---|---|---|
| TIME_CLOSE_ORDERS | Closing time of unused orders (min) | number | 5 |
| TIME_CLOSE_ORDERS_INACTIVITY | Closing time of undemanded orders (min) | number | 15 |
| STEP_BREAKEVEN_PERCENT | Percentage of breakeven (Only for "Scalper") | number | 50 |
| Option | Description | Type | Default |
|---|---|---|---|
| BBANDS | Bollinger Bands (Trend strategy!) | boolean | false |
| BBANDS_DEVIATION | Deviation | number | 2 |
| BBANDS_PERIOD | Period BBANDS | number | 20 |
| RSI_PERIOD | Period RSI | number | 14 |
| RSI_RANGE_SELL | RSI range for sell Values are specified in the format start/end of the range. |
string | 70/100 |
| RSI_RANGE_BUY | RSI range for buy | string | 1/30 |
| BBANDS_INTERVAL | Interval of interrogation of the prices (minutes) | number | 1 |
If
RSI_PERIOD = 0, then the indicator is disabled and trading occurs only on the BBANDS indicator!
When you start the strategy of "Sell One, Buy a lot" the initial state of the balance of the base currency in the pair is ignored!
| Option | Description | Type | Default |
|---|---|---|---|
| ONE_ORDERS_SELL | Strategy: "One Sell a lot Buy" | boolean | false |
| ONE_ORDERS_BUY | Strategy: "One Buy a lot Sell" | boolean | false |
| ONE_ORDERS_OFFSET | The difference between LastPrice and first order in the stack of orders in %. Will pull the order, if this value is exceeded. |
number | 2 |
| ONE_ORDERS_PROFIT_PERCENT | Specifies the percentage desired profit | number | 1 |
| INTEGRITY_CONTROL_ORDERS | Integrity control orders (soft or hard) | string | soft |
| TYPE_DATA_USED | Where to get information about the used orders: active - active orders history - trading history |
string | active |
| FIRST_LOADING_HISTORY | Download the history when you start the bot | boolean | false |
| NUMBER_ROWS_LOAD_HISTORY | Number of rows to load history | number | 100 |
| CYCLES_AUTO_EXIT | How many cycles to make the exit | number | 0 |
| STOP_LOSS_PERCENT | Stop Loss percentage | number | 0 |
| DISABLE_CAPITALIZATION | Disable capitalization in profit order | boolean | false |
If the parameter INTEGRITY_CONTROL_ORDERS in
hardmode, then a sell order will be installed only if the volume installed and executed buy orders will be the same.
If the parameter FIRST_LOADING_HISTORY included, will be loaded into the cache the first
NUMBER_ROWS_LOAD_HISTORYBUY orders before the first SELL order for the selected pair and put a SELL order on the basis of these data.
Option DISABLE_CAPITALIZATION=true activates
INTEGRITY_CONTROL_ORDERSon hard.
| Option | Description | Type | Default |
|---|---|---|---|
| NOTIFICATION_PAIR | Notification pair of rate changing (For example: btc/usd, ltc/usd or all/all for all pair) |
string | - |
| NOTIFICATION_DEVIATION_PERCENT | Relation of deviation percentage from current price for notification will work | number | 600 |
| MONITORING_PAIR | Pairs for monitoring. (For example: btc/usd, ltc/usd, or just a pair currency, for example: btc). If none of that is set, ALL available pairs will be monitored on the exchange. |
string | All pairs |
| NOTIFICATION_ERROR_COUNT | The number of errors in 5 minutes for notification | number | 0 |
| NOTIFICATION_ORDER_IS_EXECUTED | Notice of execution of one orders | boolean | false |
| Option | Description | Type | Default |
|---|---|---|---|
| EMAIL_REPORT_ADDRESS | Email for notifications of network incidences and errors | string | - |
| HOST_SMTP | Mail server address | string | smtp.yandex.ru |
| EMAIL_AUTH_USER | Authorization login of the mail server | string | - |
| EMAIL_AUTH_PASS | Mail server password | string | - |
| Option | Description | Type | Default |
|---|---|---|---|
| TIME_ZONE | Time zone Database Time Zones | string | Asia/Yekaterinburg |
| LOG | Calculating log output of auto settings | boolean | false |
| LOG_DEBUG | The output of the debug log | boolean | false |
| LOG_TRANSPORTS | Where to write the log: 0 - console 1 - file 2 - console and file |
number | 0 |
| LOG_PATH | A custom path to the directory with the log | string | Folder with bot |
| LOG_TREE | Save logs by directory year/month/day | boolean | false |
| RESTART_TRADER_TIME | How many seconds to wait before re-querying the data after network errors | number | 5 |
| EXCHANGE_FEE | The Commission for transactions of the exchange | number | 0.25 |
| DELAY_REQUEST_API | The delay of requests to the API in milliseconds | number | 500 |
| DELAY_BETWEEN_MODULES | Then delay in seconds between execution of consecutive modules. | number | 3 |
| TITLE | The title of the console window. | string | GBot |
| LANGUAGE | The language of the interface (ru or en) |
string | ru |
| NODE_ENV | Value production activate: 1. notification about the start of a Telegram bot. 2. error notifications by E-mail. 3. prohibits the use of conf-dev.js. 4. disabling colors in logs. 5. disables TITLE |
string | dev |
| URL_STATISTICS | URL of the server where the statistics will be sent in post json format | string | - |
Important:
- If you've changed LANGUAGE send a command
/startin Telegram bot for a new language initialization in Telegram
$ npm start
For Windows
SET TELEGRAM_TOKEN=110201543:AAHdqTcvCH1vGWJxfSeofSAs0K5PALDsaw
SET TELEGRAM_ID=12345678
....
npm start
For Heroku
heroku ps:scale web=0
heroku ps:scale worker=1
To launch the control panel in a Telegram, send a message to:
/start
Additional commands:
/info - list of all commands
/version - The version of the bot
/params - Parameters which can be changed via Telegram
/config - Is a possible configuration parameters via a configuration file
/martin [cache] - A theoretical calculation of the orders of the martingale (parameters are taken from config)
/ticker coin_name - Shows a quote of a pair coin_name
/stop [codeExit] - The application shutsdown. codeExit - an optional exit code.
/sell_all - Sell on the market immediately. (Attention: The sale will be made without confirmation!)
/restart - Restart GBot Trader
/stats - Trading statistics
/note [ignore text] - The text in this line will be ignored. It can be used as a comment.
/stoploss - Displays StopLoss information