Click here for the Version 1 Web Interface Guide

This guide will provide information on everything that you see in the web GUI. With default settings you can access the GUI when the bot is running by visiting http://localhost:8081 on the same computer as the bot.


Contents

Common Areas

These sections are visible on every page of the GUI.

Along the very top row you'll see the following information.

  • BAL (Balance) - The amount of your chosen market currency you have available in your exchange wallet.
  • TCV (Total Current Value) - The current value of your coins. It's the sum of your BAL (balance) and the actual value of your coins on the market (it's how much you could get if you sold them at the top bid price right now). This includes the sum of your current values in Pairs Log plus DCA Log plus Dust Log to calculate the TCV.
  • Profit - The amount you earned within the last week (LW), yesterday (YD) and today (TD) displayed in your chosen market currency rounded to 3 decimal places.
  • Trend - The percentage trend of your MARKET during the last 24 hours (samples top 20 coins).
  • MARKET (BTC, ETH, etc) - The current price of the market currency you chose and its % trend compared to USD over 24 hours.
  • Test Mode - When in test mode you will see this red indicator in the header.

Along the bottom of the header you have links to all the pages in the GUI. The number will change to RED when it has changed.

Click on the image below to view each section.

Settings Cog

On the right hand side of the header the blue text will display the name of the active configuration.

The green/yellow dot indicates the status of the data cycle. Yellow indicates it is refreshing and gathering the latest data from the exchange. Green indicates it successfully retrieved the data a short time ago. You should see a yellow refresh every 5 seconds or less.

The diagonal arrows in the top right corner will enable/disable full screen mode.

The cog icon will open a menu with two subheadings, Heartbeats and Settings.

Heartbeats

Heartbeats displays the 3 types of heartbeats the bot produces. Cache, Normal and DCA heartbeats should each occur every 10 minutes.

Settings

Settings displays several options

  • Adv. Config - Toggle between Basic and Advanced configuration editing.
  • SHOW BUY/SELL - Toggle the Buy and Sell buttons in the Pairs and DCA logs.
  • Active - Use the drop down menu to switch the active configuration.
  • Logout - Logout from the current session and require a password to be entered when accessed again.
  • Stop ProfitTrailer - Safely shut down the bot. Note: If using pm2 the bot may be configured to restart immediately.
  • Reset - Reset Test Mode data. This will clear Test Sales, Pairs and DCA data.
  • Change Passwords - Change the passwords used to log in to the Web GUI for the Admin and/or Guests.

Notifications Bell

The bell symbol opens up a list of the latest bot notifications. It can be expanded for less recent notifications by clicking View all. You can disable these from displaying in this menu using server.disable_notification

In the footer you'll see the following information.

  • PT Ver - The Version number of your ProfitTrailer bot.
  • Market - The exchange and the market you have chosen.
  • UTC - The UTC time.
  • Uptime - The length of time your ProfitTrailer instance has been running.
  • $ - The chosen currency that fiat values will be displayed in based on server.currency. Hover over it to see the 3 letter code (e.g USD).
  • flag - The flag indicates the language the bot is displaying for you. Configured with server.language
  • SOM - Displays if “Sell Only Mode” is on (true) or off (false). Hover to see the reason for SOM.
  • SOMO - Displays if “Sell Only Mode Override” is on (true) or off (false).
  • Config - Displays if editing the bots configuration files within the GUI is enabled (On) or disabled (Off). Configured with server.disable_config.


TOP


Monitoring Page

In the center of the monitoring page there are 16 tiles with varying information as described below.

In Orange:

In Blue:

  • The TCV (Total Current value) of all holdings the bot can see excluding dust.
  • The estimated USD value of your TCV.
  • The TCV of all holdings the bot can see including dust.

In Dark Green:

In Pale Green:

  • The average trend of altcoins against your market currency over the last 24 hours.

Box One:

  • The current price of your chosen market currency and trend against USD over 24 hours.

Box Two:

  • The current price and trend against USD of the top 5 marketcap coins over 24 hours.

Box Three:

  • The total market capitalisation in USD.
  • The total value of all volume traded in the last 24 hours in USD.
  • The percentage of the Market Cap that is made up by bitcoin.

Box Four:

  • The estimated USD value trend of the top 20 altcoins on CoinMarketCap in the last hour.
  • The estimated USD value trend of the top 20 altcoins on CoinMarketCap in the last 24 hours.
  • The estimated USD value trend of the top 20 altcoins on CoinMarketCap in the last 7 days.

In Yellow:

  • The number of sales in the last 7 Days.
  • The total profit from within the last 7 days.
  • The estimated value of the profit with the last 7 days.
  • The total volume you have traded in the last 7 days.
  • The estimated gain relative to your traded volume in the last 7 days.

In Grey-Blue:

  • The number of sales yesterday.
  • The total profit yesterday.
  • The estimated value of the profit from yesterday.
  • The total volume you traded yesterday.
  • The estimated gain relative to your traded volume yesterday.

In Red:

  • The number of sales today.
  • The total profit today.
  • The estimated value of the profit from today.
  • The total volume you traded today.
  • The estimated gain relative to your traded volume today.

In Dark Grey:

  • PW - Displays if the Web GUI is password protected (on) or not (off). See server.disable_password.
  • CON - Displays if editing the bots configuration files within the GUI is enabled (On) or disabled (Off). See server.disable_config.
  • SOM - Displays if Sell Only Mode is on (true) or off (false). Hover to see the reason for SOM.
  • SOMO - Displays if “Sell Only Mode Override” is on (true) or off (false).
  • PT Ver - The version of your ProfitTrailer Bot.
  • Market The exchange and the market you have chosen.

Pairs Log:

  • The Current Value (CV) of all pairs in the Pairs Log.
  • The Difference (D) between the Current Value and the Bought Cost.
  • The Bought Cost (BC) of all pairs in the Pairs Log.

DCA Log:

  • The Current Value (CV) of all pairs in the DCA Log.
  • The Difference (D) between the Current Value and the Bought Cost.
  • The Bought Cost (BC) of all pairs in the DCA Log.

Pending Log:

  • The Current Value (CV) of all pairs in the Pending Log.
  • The Difference (D) between the Current Value and the Target Value.
  • The Target Value (TV) of all pairs in the Pending Log.

Sales Log:

  • The Bought Cost (BC) of all pairs in the Sales Log.
  • The Difference (D) between the Bought Cost and the Sold Value.
  • The Sold Value (SV) of all pairs in the Sales Log.


TOP


Possible Buy Log (PBL)

The possible Buy Log page contains a table of all coins that are enabled and meet your DEFAULT_min_buy_volume and DEFAULT_min_buy_price criteria.

Coin - The pair name formatted according to the exchange and the relative price change of the coin over 24 hours. Click the coin name to be taken to the exchange or custom server.exchange_url set.

Ask Price - The lowest Ask Price currently on the order book for the coin.

VOL - The Volume, measured in the market currency, of the coin traded in the last 24 hours.

Buy - The Buy Strategies in use for the coin. See DEFAULT_A_buy_strategy. It will indicate (true) if in the buy zone and (true trailing) if all strategies are true and the bot is trailing. You might also see a reason why the coin will not be bought. Possible reasons are:

  • (false_cross) - When using a CROSS strategy this indicates a cross has not occurred within the required cross_candles.
  • (false_spread) - When using a CROSS strategy this indicates the required spread has not been reached.
  • TOO NEW - The coin is newer than allowed by pair_min_listed_days.
  • MAX PAIRS - You have more pairs than allowed by max_trading_pairs
  • MAX SPREAD - The spread between lowest ask and highest bid is greater than allowed by DEFAULT_max_buy_spread
  • SOM ENABLED - Sell Only Mode is on so new purchases will not be made.
  • REBUY TIMEOUT - The coin was recently sold and is on a cool down (shown in minutes). Set with DEFAULT_rebuy_timeout.
  • MIN BUY VOLUME - The coins 24 hour volume is below your DEFAULT_min_buy_volume setting.
  • ORDERBOOK LOW - ProfitTrailer is looking at the lowest ask price in the orderbook when buying. The volume at that price does not meet your requirements. See DEFAULT_buy_min_orderbook_volume_percentage.
  • PANIC SELL ENABLED - You have DEFAULT_panic_sell_enabled = true. Buying now will cause an instant loss.
  • SELL WALL DETECTED - A large sell order has been detected. See DEFAULT_sell_wall_diff_percentage and DEFAULT_sell_wall_orderbook_depth
  • BALANCE CANNOT BE 0 - The bot will not trade if your balance in your market currency is 0. This is an API error safeguard.
  • MIN/MAX CHANGE PERC - The 24 hour price change is outside the range set. See DEFAULT_buy_min_change_percentage and DEFAULT_buy_max_change_percentage
  • INSUFFICIENT BALANCE - You do not have sufficient balance available to the bot to complete this purchase.
  • BUY VALUE BELOW DUST - your DEFAULT_initial_cost is below the exchange trade minimum.

- Manually attempt an initial buy. See What do the Buy and Sell Buttons do.

BSV - The Buy Strategy Value is the current calculated value for the corresponding strategy.

BST - The Buy Strategy Trigger is the buy_value set for the corresponding strategy.

BSL - The Buy Strategy Limit is the buy_value_limit set for the corresponding strategy.


TOP


Pairs Log

Date - The Date and Time of the most recent buy of the coin. In brackets, the number of days since the last purchase.

Coin - The pair name formatted according to the exchange and the relative price change of the coin over 24 hours. Click the coin name to be taken to the exchange or custom server.exchange_url set.

Sell - The Sell Strategies in use for the coin. See DEFAULT_A_Sell_strategy. It will indicate (true) if in the sell zone and (true trailing) if all strategies are true and the bot is trailing. You may also see:

  • (false_cross) - When using a CROSS strategy this indicates a cross has not occurred within the required cross_candles.
  • (false_spread) - When using a CROSS strategy this indicates the required spread has not been reached.
  • WATCHMODE - The coin is not enabled for trading and will not be bought or sold.
  • SPECIFY A GAIN - GAIN is a mandatory sell strategy. You always have to have GAIN as one of your strategies.
  • BALANCE CANNOT BE 0 - The bot will not trade if your balance in your market currency is 0. This is an API error safeguard.

- Manually attempt to sell the coin. See What do the Buy and Sell Buttons do.

SSV - The Sell Strategy Value is the current value calculated for the corresponding strategy. SSV for GAIN will show the highest gain reached for as long as the price stays above SST. This is useful for seeing how far the bot has trailed.

SST - The Sell Strategy Trigger is the sell_value set for the corresponding strategy.

P% - The Profit Percentage is the difference between your Bought Price and the highest Buy Order on the exchange. If you could sell to the highest bidder right now this is the profit you would have. If orderbook_profit_calculation = true a second Profit calculation will be shown beneath when Profit > 0. This will only look at the highest Buy Order with at least the same volume as your holding. (The exchange maximum fee is taken into account)

Bid Price - The current highest Bid Price in the order book for the coin.
Bought Price - The Price you have paid for the quantity of the coin you currently own.

Current Value - The Current Value of your holding of the coin based on the highest Bid Order on the order book.
Bought Cost - The Bought Cost of your holding of the coin. i.e What you have spent buying it.

USD - The Current Value and Bought Cost converted to your selected currency.

VOL - The Volume, measured in the market currency, of the coin traded in the last 24 hours.

TAM - The Total Amount of the coin that you own.


TOP


DCA Log

Date - The Date and Time of the last purchase of the coin. (new DCA buys will reset this) In brackets, the number of days since the last purchase.

Coin - The pair name formatted according to the exchange and the relative price change of the coin over 24 hours. Click the coin name to be taken to the exchange or custom server.exchange_url set.

Bid.Pr - The current highest Bid Price in the order book for the coin.
Avg.Pr - The Average Price you have paid for quantity of the coin you currently own.
- The number of times the coin has been bought using DCA logic since the initial purchase.

Buy - The Buy Strategies in use for the coin. See DEFAULT_DCA_A_buy_strategy. It will indicate (true) if in the buy zone and (true trailing) if all strategies are true and the bot is trailing. You might also see a reason why the coin will not be bought. Possible reasons are:

- Manually attempt the next DCA purchase. See What do the Buy and Sell Buttons do.

BSV - The Buy Strategy Value is the current calculated value for the corresponding strategy.

BST - The Buy Strategy Trigger is the buy_value set for the corresponding strategy and DCA level.

BSTV - The Buy Strategy Trigger Value is the DEFAULT_DCA_buy_trigger for the current DCA level.

BT% - The Buy Trigger Percentage is the difference between the Average Price and the lowest Sell Order on the exchange. When the bot is looking to DCA it is looking at this figure not Profit %.

Sell - The Sell Strategies in use for the coin. See DEFAULT_DCA_A_Sell_strategy. It will indicate (true) if in the sell zone and (true trailing) if all strategies are true and the bot is trailing. You might also see:

  • (false_cross) - When using a CROSS strategy this indicates a cross has not occurred within the required cross_candles.
  • (false_spread) - When using a CROSS strategy this indicates the required spread has not been reached.
  • SPECIFY A GAIN - GAIN is a mandatory sell strategy. You always have to have GAIN as one of your strategies.

- Manually attempt to sell the coin. See What do the Buy and Sell Buttons do.

SSV - The Sell Strategy Value is the current value calculated for the corresponding strategy. SSV for GAIN will show the highest gain reached for as long as the price stays above SST. This is useful for seeing how far the bot has trailed.

SST - The Sell Strategy Trigger is the sell_value set for the corresponding strategy.

P% - The Profit Percentage is the difference between your bought price and the highest Buy Order on the exchange. If you could sell to the highest bidder right now this is the profit you would have. If DCA_orderbook_profit_calculation = true a second Profit calculation will be shown beneath when Profit > 0. This will only look at the highest Buy Order with at least the same volume as your holding. (The exchange maximum fee is taken into account)

VOL - The Volume, measured in the market currency, of the coin traded in the last 24 hours.

TAM - The Total Amount of the coin that you own.

Cur.Val - The Current Value of your holding of the coin based on the highest Bid Order on the order book.
Tot.Cost - The Total Cost of your holding of the coin. i.e What you have spent buying it.

USD - The Current Value and Total Cost converted to your selected currency.


TOP


Pending Log

The Pending Log contains coins that have limit sell orders placed on the exchange. Often created manually by the user or by use of DEFAULT_pending_order_wait_time or DEFAULT_DCA_pending_order_wait_time.

Note: Coins in the pending log will not show in the sales log once sold.

Coin - The pair name formatted according to the exchange and the relative price change of the coin over 24 hours. Click the coin name to be taken to the exchange or custom server.exchange_url set.

Sell - The Sell Strategy is FIXED as the order is already placed on the exchange.

Bid Price - The current highest Bid Price in the order book for the coin.
Target Price - The Target Price shows the price at which the sell order has been set.

P% - The Profit Percentage is the difference between the Target Price and the Bid Price. If you set a high sell value then this will show how far away you are from that sale (fees are considered)

CP% - If the same coin is bought again and is in the Pairs or DCA log the Combined Profit in Percentage is displayed to show your combined position for that coin. (averages the two holdings)

TAM - The Total Amount of the coin that is in the fixed sell order.

Cur.Val - The Current Value of the coins in the sell order based on the highest Bid Order on the order book.
Tar.Val - The Target Value of the coins in the sell order based on the Target Price.

USD - The Current Value and Target Value converted to your selected currency.


TOP


Buy Log

Use the search box to filter any data in the Sales Log (excluding the number of days in brackets in the Date Column).

Use the drop down box to select how many rows to show per page. 10, 25, 50, 100 or all.

  • Date - The Date and Local Time of the purchase of the coin. In brackets, the number of days since the buy.
  • Order Number - The unique exchange order number associated with this trade.
  • Coin - The pair name formatted according to the exchange. Click the coin name to be taken to the exchange or custom server.exchange_url set.
  • Bought Price - The price paid at the time of the buy. - The number of DCA buy times if the coin was DCA'd.
  • VOL - The market currency volume of the coin at the time of the buy
  • Buy Type - DCA or initial purchase
  • Buy - The Buy Strategies used to make the purchase.
  • BSV - The Buy Strategy Value is the calculated value for the corresponding strategy at the time of the buy.
  • BST - The Buy Strategy Trigger is the buy_value used for the corresponding strategy.
  • BSL - The Buy Strategy Limit is the buy_value_limit used for the corresponding strategy.

Sales Log

Use the search box to filter any data in the Sales Log (excluding the number of days in brackets in the Date Column).

Use the drop down box to select how many rows to show per page. 10, 25, 50, 100 or all.

Date - The Date and Local Time of the sale of the coin. In brackets, the number of days since the sale.

Coin - The pair name formatted according to the exchange. Click the coin name to be taken to the exchange or custom server.exchange_url set.

Sell - The Sell Strategies used in the sale of the coin. You might also see other sell reasons shown such as:

P% - The Profit Percentage is the percentage of profit you made on the trade based on the Bought Price and Sell Price recorded and taking the highest possible fee charged by the exchange into account.

Profit BTC - The Profit from the trade in the configured market. (minus the highest possible fee charged by the exchange.)

USD - The Profit from the trade converted to your chosen currency based on today's conversion rate.

SAM - The Sold Amount of the coin.

Bought Price - The average price paid for the coins that were sold in the market currency.
Sold Price - The sold price for the coins in the market currency.
- The number of DCA buy times if the coin was DCA'd.

Bought Cost - The total spent on the purchase of the coins in the market currency.
Sold Value - The total value of the sale in the market currency.

USD - The Bought Cost and Sold Value converted to your selected currency.


TOP


Dust Log

The Dust Log is filled with small amounts of coins leftover from trades that are below the minimum trading size on the exchange, if they grow in value they can return to pairs and be sold. They can also be combined with any new purchases of the coin sold by ProfitTrailer.

Date - The Date and Time of The last purchase of the coin. In brackets, the number of days since that date.

Coin - The pair name formatted according to the exchange and the relative price change of the coin over 24 hours. Click the coin name to be taken to the exchange or custom server.exchange_url set.

P% - The Profit Percentage is the difference between your bought price and the highest Buy Order on the exchange. If you could sell to the highest bidder right now this is the profit you would have. (fees are considered)

Bid Price - The current highest Bid Price in the order book for the coin.
Bought Price - The Average Price you paid for quantity of the coin in dust.

Current Value - The Current Value of your holding of the coin based on the highest Bid Order on the order book.
Bought Cost - The Bought Cost of your holding of the coin. i.e What you have spent buying it.

USD - The Current Value and Bought Cost converted to your selected currency.

VOL - The Volume, measured in the market currency, of the coin traded in the last 24 hours.

TAM - The Total Amount of the coin that you own.


TOP


Config

The Config is the only method for editing the PAIRS, DCA and INDICATORS configuration files.

You have two viewing options: Basic and Advanced. Toggle between them in the Settings Menu

Whether in Basic or Advanced editing mode you can change the config you wish to edit by selecting config name to reveal a drop down menu. Choosing a config here does not change the active configuration that ProfitTrailer is using. Edits made to the active configuration are immediately used by ProfitTrailer.


Basic

The Basic config editor is designed to make things simpler, easier to read and prevent typos from stopping ProfitTrailer functioning how you intended.

  • Config Name - The name of the config that is being displayed/edited. Click to select a different config.
  • DEFAULT - Select the coin name to edit Coin Specific values.
  • - Open a dialog box in order to enter HotConfig commands. (Only displays when active Config is selected)
  • - In Advanced, open a search dialog.
  • - Click this to delete the configuration being displayed. (You will not have the option to delete the Active Config)
  • - Save any changed you have made.
  • - Copy the config displayed and save with a new name
  • - Download the 3 configuration files for the displayed config.
  • Pairs - View/configure the pairs.properties file for the editing config.
  • DCA - View/configure the dca.properties file for the editing config.
  • Indicators - View/configure the indicators.properties file for the editing config.

Just to the right of the config name is the coin dropdown. Use this to switch to a specific coin and configure Coin Specific Settings

Basic Pairs

click to expand

The Pairs log is broken up into 5 sections.

  • The top left green section contains initial buy settings.
  • The top right yellow section contains Sell only mode settings.
  • The middle left blue section contains buy settings.
  • The middle right red section contains sell settings.
  • The bottom section contains toggles for parameters that have true/false options.
  • - Use this button to toggle DEFAULT_A_buy_on_first_signal.
  • - Click to add and use the strategy on this row.
  • - Click to remove the strategy on this row.

The button on the pairs page allows you to easily manage the coins you wish to blacklist.

  • - View only coins that are blacklisted.
  • - View only coins that are not blacklisted.
  • - View all coins.

From the All Coins menu you can see both blacklsited coins and non blacklisted coins.


Basic DCA

click to expand

The DCA log is broken up into 4 sections.

  • The top green section contains general dca settings.
  • The middle left blue section contains buy settings.
  • The middle right red section contains sell settings.
  • The bottom section contains toggles for parameters that have true/false options.

Basic Indicators

click to expand


Advanced

  • Config Name - The name of the config that is being displayed/edited. Click to select a different config.
  • DEFAULT - Select the coin name to edit Coin Specific values.
  • - In Advanced, open a search dialog.
  • - Click this to delete the configuration being displayed. (You will not have the option to delete the Active Config)
  • - Save any changed you have made.
  • - Copy the config displayed and save with a new name
  • - Download the 3 configuration files for the displayed config.
  • Pairs - View/configure the pairs.properties file for the editing config.
  • DCA - View/configure the dca.properties file for the editing config.
  • Indicators - View/configure the indicators.properties file for the editing config.
  • Hot Config - Open the Hotconfig to enter one time commands. Leaving the page will clear it.

Advanced Pairs

Select Pairs to edit pairs.properties.


Advanced DCA

Select DCA to edit dca.properties.


Advanced Indicators

Select Indicators to edit indicators.properties.


Advanced Hotconfig

Select Hotconfig to access the hotconfig.


TOP

Enter your comment:
 
  • web_interface_guide.txt
  • Last modified: 6 days ago
  • by sgtbatten