stable/freqtrade/rpc/rpc.py

498 lines
19 KiB
Python
Raw Normal View History

2018-02-13 03:45:59 +00:00
"""
This module contains class to define a RPC communications
"""
2018-03-25 19:37:14 +00:00
import logging
from abc import abstractmethod
2018-06-22 02:08:51 +00:00
from datetime import timedelta, datetime, date
2018-03-17 21:44:47 +00:00
from decimal import Decimal
from enum import Enum
2018-07-22 12:35:29 +00:00
from typing import Dict, Any, List, Optional
2018-03-17 21:44:47 +00:00
2018-03-02 15:22:00 +00:00
import arrow
2018-02-13 03:45:59 +00:00
import sqlalchemy as sql
from numpy import mean, nan_to_num, NAN
from pandas import DataFrame
2018-03-17 21:44:47 +00:00
from freqtrade import TemporaryError, DependencyException
2018-03-17 21:44:47 +00:00
from freqtrade.misc import shorten_date
2018-02-13 03:45:59 +00:00
from freqtrade.persistence import Trade
from freqtrade.rpc.fiat_convert import CryptoToFiatConverter
2018-02-13 03:45:59 +00:00
from freqtrade.state import State
2018-07-12 20:21:52 +00:00
from freqtrade.strategy.interface import SellType
2018-02-13 03:45:59 +00:00
2018-03-25 19:37:14 +00:00
logger = logging.getLogger(__name__)
class RPCMessageType(Enum):
STATUS_NOTIFICATION = 'status'
2018-08-15 02:39:32 +00:00
WARNING_NOTIFICATION = 'warning'
CUSTOM_NOTIFICATION = 'custom'
BUY_NOTIFICATION = 'buy'
SELL_NOTIFICATION = 'sell'
def __repr__(self):
return self.value
2018-06-08 02:52:50 +00:00
class RPCException(Exception):
"""
Should be raised with a rpc-formatted message in an _rpc_* method
if the required state is wrong, i.e.:
raise RPCException('*Status:* `no active trade`')
"""
def __init__(self, message: str) -> None:
super().__init__(self)
self.message = message
def __str__(self):
return self.message
2018-06-08 02:52:50 +00:00
2018-02-13 03:45:59 +00:00
class RPC(object):
"""
RPC class can be used to have extra feature, like bot data, and access to DB data
"""
2018-07-24 22:08:40 +00:00
# Bind _fiat_converter if needed in each RPC handler
2018-07-22 12:35:29 +00:00
_fiat_converter: Optional[CryptoToFiatConverter] = None
2018-07-21 18:44:38 +00:00
2018-02-13 03:45:59 +00:00
def __init__(self, freqtrade) -> None:
"""
Initializes all enabled rpc modules
:param freqtrade: Instance of a freqtrade bot
:return: None
"""
2018-06-08 22:20:10 +00:00
self._freqtrade = freqtrade
2018-02-13 03:45:59 +00:00
@property
def name(self) -> str:
""" Returns the lowercase name of the implementation """
return self.__class__.__name__.lower()
@abstractmethod
2018-06-08 02:52:50 +00:00
def cleanup(self) -> None:
""" Cleanup pending module resources """
@abstractmethod
2018-06-24 22:04:27 +00:00
def send_msg(self, msg: Dict[str, str]) -> None:
""" Sends a message to all registered rpc modules """
def _rpc_trade_status(self) -> List[Dict[str, Any]]:
2018-02-13 03:45:59 +00:00
"""
Below follows the RPC backend it is prefixed with rpc_ to raise awareness that it is
a remotely exposed function
"""
# Fetch open trade
trades = Trade.get_open_trades()
if not trades:
raise RPCException('no active trade')
2018-02-13 03:45:59 +00:00
else:
results = []
2018-02-13 03:45:59 +00:00
for trade in trades:
order = None
if trade.open_order_id:
2018-06-17 19:24:36 +00:00
order = self._freqtrade.exchange.get_order(trade.open_order_id, trade.pair)
2018-02-13 03:45:59 +00:00
# calculate profit and send message to user
try:
current_rate = self._freqtrade.get_sell_rate(trade.pair, False)
except DependencyException:
current_rate = NAN
2018-02-13 03:45:59 +00:00
current_profit = trade.calc_profit_percent(current_rate)
2018-07-04 18:53:45 +00:00
fmt_close_profit = (f'{round(trade.close_profit * 100, 2):.2f}%'
if trade.close_profit else None)
results.append(dict(
trade_id=trade.id,
pair=trade.pair,
base_currency=self._freqtrade.config['stake_currency'],
date=arrow.get(trade.open_date),
open_rate=trade.open_rate,
close_rate=trade.close_rate,
current_rate=current_rate,
amount=round(trade.amount, 8),
2019-04-04 10:06:45 +00:00
stake_amount=round(trade.stake_amount, 8),
close_profit=fmt_close_profit,
current_profit=round(current_profit * 100, 2),
stop_loss=trade.stop_loss,
2019-04-03 18:35:37 +00:00
stop_loss_pct=(trade.stop_loss_pct * 100)
if trade.stop_loss_pct else None,
initial_stop_loss=trade.initial_stop_loss,
2019-04-03 18:35:37 +00:00
initial_stop_loss_pct=(trade.initial_stop_loss_pct * 100)
if trade.initial_stop_loss_pct else None,
open_order='({} {} rem={:.8f})'.format(
2019-04-03 18:28:03 +00:00
order['type'], order['side'], order['remaining']
) if order else None,
))
return results
2018-02-13 03:45:59 +00:00
2018-06-08 02:52:50 +00:00
def _rpc_status_table(self) -> DataFrame:
trades = Trade.get_open_trades()
if not trades:
raise RPCException('no active order')
2018-02-13 03:45:59 +00:00
else:
trades_list = []
for trade in trades:
# calculate profit and send message to user
try:
current_rate = self._freqtrade.get_sell_rate(trade.pair, False)
except DependencyException:
current_rate = NAN
2018-07-04 18:53:45 +00:00
trade_perc = (100 * trade.calc_profit_percent(current_rate))
2018-02-13 03:45:59 +00:00
trades_list.append([
trade.id,
trade.pair,
shorten_date(arrow.get(trade.open_date).humanize(only_distance=True)),
2018-07-04 18:53:45 +00:00
f'{trade_perc:.2f}%'
2018-02-13 03:45:59 +00:00
])
2018-03-02 15:22:00 +00:00
2018-02-13 03:45:59 +00:00
columns = ['ID', 'Pair', 'Since', 'Profit']
df_statuses = DataFrame.from_records(trades_list, columns=columns)
df_statuses = df_statuses.set_index(columns[0])
2018-06-08 02:52:50 +00:00
return df_statuses
2018-02-13 03:45:59 +00:00
2018-06-08 02:52:50 +00:00
def _rpc_daily_profit(
self, timescale: int,
2018-06-08 02:52:50 +00:00
stake_currency: str, fiat_display_currency: str) -> List[List[Any]]:
2018-02-13 03:45:59 +00:00
today = datetime.utcnow().date()
2018-06-02 11:43:51 +00:00
profit_days: Dict[date, Dict] = {}
2018-03-02 15:22:00 +00:00
2018-02-13 03:45:59 +00:00
if not (isinstance(timescale, int) and timescale > 0):
raise RPCException('timescale must be an integer greater than 0')
2018-03-02 15:22:00 +00:00
2018-02-13 03:45:59 +00:00
for day in range(0, timescale):
profitday = today - timedelta(days=day)
trades = Trade.query \
.filter(Trade.is_open.is_(False)) \
.filter(Trade.close_date >= profitday)\
.filter(Trade.close_date < (profitday + timedelta(days=1)))\
.order_by(Trade.close_date)\
.all()
curdayprofit = sum(trade.calc_profit() for trade in trades)
profit_days[profitday] = {
2018-07-04 18:53:45 +00:00
'amount': f'{curdayprofit:.8f}',
2018-02-13 03:45:59 +00:00
'trades': len(trades)
}
2018-03-02 15:22:00 +00:00
2018-06-08 02:52:50 +00:00
return [
2018-02-13 03:45:59 +00:00
[
key,
'{value:.8f} {symbol}'.format(
value=float(value['amount']),
symbol=stake_currency
),
'{value:.3f} {symbol}'.format(
2018-07-22 12:35:29 +00:00
value=self._fiat_converter.convert_amount(
2018-02-13 03:45:59 +00:00
value['amount'],
stake_currency,
fiat_display_currency
2018-07-21 18:44:38 +00:00
) if self._fiat_converter else 0,
2018-02-13 03:45:59 +00:00
symbol=fiat_display_currency
),
2018-03-02 15:22:00 +00:00
'{value} trade{s}'.format(
value=value['trades'],
s='' if value['trades'] < 2 else 's'
),
2018-02-13 03:45:59 +00:00
]
for key, value in profit_days.items()
]
2018-06-08 02:52:50 +00:00
def _rpc_trade_statistics(
self, stake_currency: str, fiat_display_currency: str) -> Dict[str, Any]:
""" Returns cumulative profit statistics """
2018-02-13 03:45:59 +00:00
trades = Trade.query.order_by(Trade.id).all()
2018-03-02 15:22:00 +00:00
2018-02-13 03:45:59 +00:00
profit_all_coin = []
profit_all_percent = []
profit_closed_coin = []
profit_closed_percent = []
durations = []
2018-03-02 15:22:00 +00:00
2018-02-13 03:45:59 +00:00
for trade in trades:
2018-06-02 11:43:51 +00:00
current_rate: float = 0.0
2018-03-02 15:22:00 +00:00
2018-02-13 03:45:59 +00:00
if not trade.open_rate:
continue
if trade.close_date:
durations.append((trade.close_date - trade.open_date).total_seconds())
2018-03-02 15:22:00 +00:00
2018-02-13 03:45:59 +00:00
if not trade.is_open:
profit_percent = trade.calc_profit_percent()
profit_closed_coin.append(trade.calc_profit())
profit_closed_percent.append(profit_percent)
else:
# Get current rate
try:
current_rate = self._freqtrade.get_sell_rate(trade.pair, False)
except DependencyException:
current_rate = NAN
2018-02-13 03:45:59 +00:00
profit_percent = trade.calc_profit_percent(rate=current_rate)
2018-03-02 15:22:00 +00:00
profit_all_coin.append(
trade.calc_profit(rate=Decimal(trade.close_rate or current_rate))
)
2018-02-13 03:45:59 +00:00
profit_all_percent.append(profit_percent)
2018-03-02 15:22:00 +00:00
best_pair = Trade.session.query(
2018-03-17 23:27:57 +00:00
Trade.pair, sql.func.sum(Trade.close_profit).label('profit_sum')
).filter(Trade.is_open.is_(False)) \
.group_by(Trade.pair) \
2018-03-02 15:22:00 +00:00
.order_by(sql.text('profit_sum DESC')).first()
2018-02-13 03:45:59 +00:00
if not best_pair:
raise RPCException('no closed trade')
2018-03-02 15:22:00 +00:00
2018-02-13 03:45:59 +00:00
bp_pair, bp_rate = best_pair
2018-03-02 15:22:00 +00:00
2018-02-13 03:45:59 +00:00
# Prepare data to display
profit_closed_coin_sum = round(sum(profit_closed_coin), 8)
profit_closed_percent = round(nan_to_num(mean(profit_closed_percent)) * 100, 2)
2018-07-21 18:44:38 +00:00
profit_closed_fiat = self._fiat_converter.convert_amount(
profit_closed_coin_sum,
2018-02-13 03:45:59 +00:00
stake_currency,
fiat_display_currency
2018-07-21 18:44:38 +00:00
) if self._fiat_converter else 0
profit_all_coin_sum = round(sum(profit_all_coin), 8)
profit_all_percent = round(nan_to_num(mean(profit_all_percent)) * 100, 2)
2018-07-21 18:44:38 +00:00
profit_all_fiat = self._fiat_converter.convert_amount(
profit_all_coin_sum,
2018-02-13 03:45:59 +00:00
stake_currency,
fiat_display_currency
2018-07-21 18:44:38 +00:00
) if self._fiat_converter else 0
2018-02-13 03:45:59 +00:00
num = float(len(durations) or 1)
2018-06-08 02:52:50 +00:00
return {
'profit_closed_coin': profit_closed_coin_sum,
2018-06-08 02:52:50 +00:00
'profit_closed_percent': profit_closed_percent,
'profit_closed_fiat': profit_closed_fiat,
'profit_all_coin': profit_all_coin_sum,
2018-06-08 02:52:50 +00:00
'profit_all_percent': profit_all_percent,
'profit_all_fiat': profit_all_fiat,
'trade_count': len(trades),
'first_trade_date': arrow.get(trades[0].open_date).humanize(),
'latest_trade_date': arrow.get(trades[-1].open_date).humanize(),
'avg_duration': str(timedelta(seconds=sum(durations) / num)).split('.')[0],
'best_pair': bp_pair,
'best_rate': round(bp_rate * 100, 2),
}
2018-06-22 02:08:51 +00:00
def _rpc_balance(self, fiat_display_currency: str) -> Dict:
2018-06-08 02:52:50 +00:00
""" Returns current account balance per crypto """
2018-02-13 03:45:59 +00:00
output = []
total = 0.0
2018-06-17 19:24:36 +00:00
for coin, balance in self._freqtrade.exchange.get_balances().items():
2018-05-14 21:31:56 +00:00
if not balance['total']:
continue
2018-02-13 03:45:59 +00:00
if coin == 'BTC':
2018-05-14 21:31:56 +00:00
rate = 1.0
2018-02-13 03:45:59 +00:00
else:
2018-08-08 19:55:48 +00:00
try:
if coin == 'USDT':
rate = 1.0 / self._freqtrade.get_sell_rate('BTC/USDT', False)
2018-08-08 19:55:48 +00:00
else:
rate = self._freqtrade.get_sell_rate(coin + '/BTC', False)
except (TemporaryError, DependencyException):
2018-08-08 19:55:48 +00:00
continue
2018-05-14 21:31:56 +00:00
est_btc: float = rate * balance['total']
total = total + est_btc
2018-06-22 02:08:51 +00:00
output.append({
'currency': coin,
'available': balance['free'],
'balance': balance['total'],
'pending': balance['used'],
'est_btc': est_btc,
})
2018-05-14 21:31:56 +00:00
if total == 0.0:
raise RPCException('all balances are zero')
2018-05-14 21:31:56 +00:00
2018-02-13 03:45:59 +00:00
symbol = fiat_display_currency
2018-07-21 18:44:38 +00:00
value = self._fiat_converter.convert_amount(total, 'BTC',
symbol) if self._fiat_converter else 0
2018-06-22 02:08:51 +00:00
return {
'currencies': output,
'total': total,
'symbol': symbol,
'value': value,
}
2018-02-13 03:45:59 +00:00
def _rpc_start(self) -> Dict[str, str]:
2018-06-08 02:52:50 +00:00
""" Handler for start """
2018-06-08 22:20:10 +00:00
if self._freqtrade.state == State.RUNNING:
return {'status': 'already running'}
2018-03-02 15:22:00 +00:00
2018-06-08 22:20:10 +00:00
self._freqtrade.state = State.RUNNING
return {'status': 'starting trader ...'}
2018-02-13 03:45:59 +00:00
def _rpc_stop(self) -> Dict[str, str]:
2018-06-08 02:52:50 +00:00
""" Handler for stop """
2018-06-08 22:20:10 +00:00
if self._freqtrade.state == State.RUNNING:
self._freqtrade.state = State.STOPPED
return {'status': 'stopping trader ...'}
2018-03-02 15:22:00 +00:00
return {'status': 'already stopped'}
2018-02-13 03:45:59 +00:00
def _rpc_reload_conf(self) -> Dict[str, str]:
""" Handler for reload_conf. """
self._freqtrade.state = State.RELOAD_CONF
return {'status': 'reloading config ...'}
def _rpc_stopbuy(self) -> Dict[str, str]:
"""
Handler to stop buying, but handle open trades gracefully.
"""
if self._freqtrade.state == State.RUNNING:
# Set 'max_open_trades' to 0
self._freqtrade.config['max_open_trades'] = 0
2019-03-18 05:27:44 +00:00
return {'status': 'No more buy will occur from now. Run /reload_conf to reset.'}
2019-04-30 04:23:14 +00:00
def _rpc_forcesell(self, trade_id) -> Dict[str, str]:
2018-02-13 03:45:59 +00:00
"""
Handler for forcesell <id>.
Sells the given trade at current price
"""
def _exec_forcesell(trade: Trade) -> None:
2018-02-13 03:45:59 +00:00
# Check if there is there is an open order
if trade.open_order_id:
2018-06-17 19:24:36 +00:00
order = self._freqtrade.exchange.get_order(trade.open_order_id, trade.pair)
2018-03-02 15:22:00 +00:00
2018-02-13 03:45:59 +00:00
# Cancel open LIMIT_BUY orders and close trade
if order and order['status'] == 'open' \
and order['type'] == 'limit' \
and order['side'] == 'buy':
2018-06-17 19:24:36 +00:00
self._freqtrade.exchange.cancel_order(trade.open_order_id, trade.pair)
trade.close(order.get('price') or trade.open_rate)
# Do the best effort, if we don't know 'filled' amount, don't try selling
if order['filled'] is None:
return
trade.amount = order['filled']
2018-03-02 15:22:00 +00:00
2018-02-13 03:45:59 +00:00
# Ignore trades with an attached LIMIT_SELL order
if order and order['status'] == 'open' \
and order['type'] == 'limit' \
and order['side'] == 'sell':
2018-02-13 03:45:59 +00:00
return
2018-03-02 15:22:00 +00:00
2018-02-13 03:45:59 +00:00
# Get current rate and execute sell
current_rate = self._freqtrade.get_sell_rate(trade.pair, False)
2018-07-11 17:57:01 +00:00
self._freqtrade.execute_sell(trade, current_rate, SellType.FORCE_SELL)
2018-02-13 03:45:59 +00:00
# ---- EOF def _exec_forcesell ----
2018-06-08 22:20:10 +00:00
if self._freqtrade.state != State.RUNNING:
raise RPCException('trader is not running')
2018-03-02 15:22:00 +00:00
2018-02-13 03:45:59 +00:00
if trade_id == 'all':
# Execute sell for all open orders
for trade in Trade.get_open_trades():
2018-02-13 03:45:59 +00:00
_exec_forcesell(trade)
2018-10-09 19:08:56 +00:00
Trade.session.flush()
2019-04-30 04:23:14 +00:00
return {'result': 'Created sell orders for all open trades.'}
2018-03-02 15:22:00 +00:00
2018-02-13 03:45:59 +00:00
# Query for trade
trade = Trade.query.filter(
sql.and_(
Trade.id == trade_id,
Trade.is_open.is_(True)
)
).first()
if not trade:
2018-03-25 19:37:14 +00:00
logger.warning('forcesell: Invalid argument received')
raise RPCException('invalid argument')
2018-03-02 15:22:00 +00:00
2018-02-13 03:45:59 +00:00
_exec_forcesell(trade)
2018-06-08 00:35:10 +00:00
Trade.session.flush()
2019-05-01 14:21:14 +00:00
return {'result': f'Created sell order for trade {trade_id}.'}
2018-02-13 03:45:59 +00:00
2018-10-09 17:25:43 +00:00
def _rpc_forcebuy(self, pair: str, price: Optional[float]) -> Optional[Trade]:
"""
Handler for forcebuy <asset> <price>
Buys a pair trade at the given or current price
"""
if not self._freqtrade.config.get('forcebuy_enable', False):
raise RPCException('Forcebuy not enabled.')
if self._freqtrade.state != State.RUNNING:
raise RPCException('trader is not running')
# Check pair is in stake currency
stake_currency = self._freqtrade.config.get('stake_currency')
if not pair.endswith(stake_currency):
raise RPCException(
f'Wrong pair selected. Please pairs with stake {stake_currency} pairs only')
# check if valid pair
# check if pair already has an open pair
trade = Trade.query.filter(Trade.is_open.is_(True)).filter(Trade.pair.is_(pair)).first()
if trade:
raise RPCException(f'position for {pair} already open - id: {trade.id}')
# gen stake amount
2018-11-04 17:51:54 +00:00
stakeamount = self._freqtrade._get_trade_stake_amount(pair)
2018-10-09 17:25:43 +00:00
# execute buy
if self._freqtrade.execute_buy(pair, stakeamount, price):
trade = Trade.query.filter(Trade.is_open.is_(True)).filter(Trade.pair.is_(pair)).first()
return trade
else:
return None
2018-06-08 02:52:50 +00:00
def _rpc_performance(self) -> List[Dict]:
2018-02-13 03:45:59 +00:00
"""
Handler for performance.
Shows a performance statistic from finished trades
"""
2018-03-02 15:22:00 +00:00
2018-02-13 03:45:59 +00:00
pair_rates = Trade.session.query(Trade.pair,
sql.func.sum(Trade.close_profit).label('profit_sum'),
sql.func.count(Trade.pair).label('count')) \
.filter(Trade.is_open.is_(False)) \
.group_by(Trade.pair) \
.order_by(sql.text('profit_sum DESC')) \
.all()
2018-06-08 02:52:50 +00:00
return [
{'pair': pair, 'profit': round(rate * 100, 2), 'count': count}
for pair, rate, count in pair_rates
]
2018-03-02 15:22:00 +00:00
2019-04-06 18:01:29 +00:00
def _rpc_count(self) -> Dict[str, float]:
2018-06-08 02:52:50 +00:00
""" Returns the number of trades running """
2018-06-08 22:20:10 +00:00
if self._freqtrade.state != State.RUNNING:
raise RPCException('trader is not running')
2018-03-02 15:22:00 +00:00
trades = Trade.get_open_trades()
return {
'current': len(trades),
2019-04-06 18:01:29 +00:00
'max': float(self._freqtrade.config['max_open_trades']),
'total_stake': sum((trade.open_rate * trade.amount) for trade in trades)
}
2018-11-10 19:07:09 +00:00
def _rpc_whitelist(self) -> Dict:
""" Returns the currently active whitelist"""
2018-12-03 19:31:25 +00:00
res = {'method': self._freqtrade.pairlists.name,
2019-03-24 15:08:48 +00:00
'length': len(self._freqtrade.active_pair_whitelist),
2018-11-10 19:07:09 +00:00
'whitelist': self._freqtrade.active_pair_whitelist
}
return res
2019-03-24 15:08:48 +00:00
2019-03-24 15:28:14 +00:00
def _rpc_blacklist(self, add: List[str]) -> Dict:
2019-03-24 15:08:48 +00:00
""" Returns the currently active blacklist"""
2019-03-24 15:28:14 +00:00
if add:
stake_currency = self._freqtrade.config.get('stake_currency')
for pair in add:
if (pair.endswith(stake_currency)
and pair not in self._freqtrade.pairlists.blacklist):
self._freqtrade.pairlists.blacklist.append(pair)
2019-03-24 15:28:14 +00:00
2019-03-24 15:08:48 +00:00
res = {'method': self._freqtrade.pairlists.name,
'length': len(self._freqtrade.pairlists.blacklist),
'blacklist': self._freqtrade.pairlists.blacklist,
2019-03-24 15:08:48 +00:00
}
return res
2019-03-25 09:16:09 +00:00
def _rpc_edge(self) -> List[Dict[str, Any]]:
2019-03-24 21:36:33 +00:00
""" Returns information related to Edge """
if not self._freqtrade.edge:
raise RPCException(f'Edge is not enabled.')
2019-04-03 12:14:47 +00:00
return self._freqtrade.edge.accepted_pairs()