stable/freqtrade/rpc/api_server/api_schemas.py

408 lines
8.9 KiB
Python
Raw Normal View History

2020-12-27 08:02:35 +00:00
from datetime import date, datetime
from typing import Any, Dict, List, Optional, Union
2020-12-27 08:02:35 +00:00
from pydantic import BaseModel
2020-12-27 08:02:35 +00:00
from freqtrade.constants import DATETIME_PRINT_FORMAT
2022-01-26 06:10:38 +00:00
from freqtrade.enums import OrderTypeValues, SignalDirection
from freqtrade.enums.tradingmode import TradingMode
2020-12-27 08:02:35 +00:00
class Ping(BaseModel):
status: str
2020-12-25 12:11:01 +00:00
2020-12-25 14:50:19 +00:00
class AccessToken(BaseModel):
access_token: str
class AccessAndRefreshToken(AccessToken):
refresh_token: str
2020-12-25 12:11:01 +00:00
class Version(BaseModel):
version: str
2020-12-25 19:07:12 +00:00
class StatusMsg(BaseModel):
status: str
2020-12-26 16:33:27 +00:00
class ResultMsg(BaseModel):
result: str
class Balance(BaseModel):
currency: str
free: float
balance: float
used: float
est_stake: float
stake: str
class Balances(BaseModel):
currencies: List[Balance]
total: float
symbol: str
value: float
stake: str
note: str
starting_capital: float
starting_capital_ratio: float
starting_capital_pct: float
starting_capital_fiat: float
starting_capital_fiat_ratio: float
starting_capital_fiat_pct: float
2020-12-26 14:54:22 +00:00
class Count(BaseModel):
current: int
max: int
total_stake: float
2020-12-26 15:43:15 +00:00
class PerformanceEntry(BaseModel):
pair: str
profit: float
2021-10-31 09:42:42 +00:00
profit_ratio: float
profit_pct: float
2021-05-15 17:39:46 +00:00
profit_abs: float
2020-12-26 15:43:15 +00:00
count: int
class Profit(BaseModel):
profit_closed_coin: float
profit_closed_percent_mean: float
profit_closed_ratio_mean: float
profit_closed_percent_sum: float
profit_closed_ratio_sum: float
profit_closed_percent: float
profit_closed_ratio: float
2020-12-26 15:43:15 +00:00
profit_closed_fiat: float
profit_all_coin: float
profit_all_percent_mean: float
profit_all_ratio_mean: float
profit_all_percent_sum: float
profit_all_ratio_sum: float
profit_all_percent: float
profit_all_ratio: float
2020-12-26 15:43:15 +00:00
profit_all_fiat: float
trade_count: int
closed_trade_count: int
first_trade_date: str
first_trade_timestamp: int
latest_trade_date: str
latest_trade_timestamp: int
avg_duration: str
best_pair: str
best_rate: float
best_pair_profit_ratio: float
2020-12-26 15:43:15 +00:00
winning_trades: int
losing_trades: int
class SellReason(BaseModel):
wins: int
losses: int
draws: int
class Stats(BaseModel):
sell_reasons: Dict[str, SellReason]
durations: Dict[str, Optional[float]]
2020-12-26 16:33:27 +00:00
class DailyRecord(BaseModel):
date: date
abs_profit: float
fiat_value: float
trade_count: int
class Daily(BaseModel):
data: List[DailyRecord]
fiat_display_currency: str
stake_currency: str
2021-11-06 15:12:25 +00:00
class UnfilledTimeout(BaseModel):
2021-11-30 19:46:47 +00:00
buy: Optional[int]
sell: Optional[int]
unit: Optional[str]
2021-11-06 15:12:25 +00:00
exit_timeout_count: Optional[int]
class OrderTypes(BaseModel):
2021-11-24 19:11:04 +00:00
buy: OrderTypeValues
sell: OrderTypeValues
emergencysell: Optional[OrderTypeValues]
forcesell: Optional[OrderTypeValues]
forcebuy: Optional[OrderTypeValues]
stoploss: OrderTypeValues
2021-11-06 15:12:25 +00:00
stoploss_on_exchange: bool
stoploss_on_exchange_interval: Optional[int]
2021-01-02 14:48:33 +00:00
class ShowConfig(BaseModel):
2021-11-06 15:12:25 +00:00
version: str
2021-12-04 13:49:45 +00:00
strategy_version: Optional[str]
2021-11-23 06:06:53 +00:00
api_version: float
2021-02-20 18:17:10 +00:00
dry_run: bool
trading_mode: str
short_allowed: bool
2021-01-02 14:48:33 +00:00
stake_currency: str
stake_amount: str
2021-07-14 18:51:42 +00:00
available_capital: Optional[float]
stake_currency_decimals: int
2021-01-02 14:48:33 +00:00
max_open_trades: int
minimal_roi: Dict[str, Any]
stoploss: Optional[float]
trailing_stop: Optional[bool]
2021-01-02 14:48:33 +00:00
trailing_stop_positive: Optional[float]
trailing_stop_positive_offset: Optional[float]
trailing_only_offset_is_reached: Optional[bool]
2021-11-06 15:12:25 +00:00
unfilledtimeout: UnfilledTimeout
order_types: Optional[OrderTypes]
use_custom_stoploss: Optional[bool]
timeframe: Optional[str]
2021-01-02 14:48:33 +00:00
timeframe_ms: int
timeframe_min: int
exchange: str
strategy: Optional[str]
2021-01-02 14:48:33 +00:00
forcebuy_enabled: bool
ask_strategy: Dict[str, Any]
bid_strategy: Dict[str, Any]
bot_name: str
2021-01-02 14:48:33 +00:00
state: str
runmode: str
2022-01-21 00:35:22 +00:00
position_adjustment_enable: bool
max_entry_position_adjustment: int
2021-01-02 14:48:33 +00:00
2021-01-01 18:36:03 +00:00
class TradeSchema(BaseModel):
2021-01-01 18:38:28 +00:00
trade_id: int
2021-01-01 18:36:03 +00:00
pair: str
is_open: bool
is_short: bool
2021-01-01 18:36:03 +00:00
exchange: str
amount: float
amount_requested: float
stake_amount: float
strategy: str
2021-11-21 09:05:56 +00:00
buy_tag: Optional[str] # Deprecated
2021-11-21 08:24:20 +00:00
enter_tag: Optional[str]
2021-01-01 18:38:28 +00:00
timeframe: int
2021-01-01 18:36:03 +00:00
fee_open: Optional[float]
fee_open_cost: Optional[float]
fee_open_currency: Optional[str]
fee_close: Optional[float]
fee_close_cost: Optional[float]
fee_close_currency: Optional[str]
open_date: str
open_timestamp: int
open_rate: float
open_rate_requested: Optional[float]
open_trade_value: float
close_date: Optional[str]
close_timestamp: Optional[int]
close_rate: Optional[float]
close_rate_requested: Optional[float]
close_profit: Optional[float]
close_profit_pct: Optional[float]
close_profit_abs: Optional[float]
profit_ratio: Optional[float]
profit_pct: Optional[float]
profit_abs: Optional[float]
2021-04-02 10:20:38 +00:00
profit_fiat: Optional[float]
2021-01-01 18:36:03 +00:00
sell_reason: Optional[str]
sell_order_status: Optional[str]
stop_loss_abs: Optional[float]
stop_loss_ratio: Optional[float]
stop_loss_pct: Optional[float]
stoploss_order_id: Optional[str]
stoploss_last_update: Optional[str]
stoploss_last_update_timestamp: Optional[int]
initial_stop_loss_abs: Optional[float]
initial_stop_loss_ratio: Optional[float]
initial_stop_loss_pct: Optional[float]
min_rate: Optional[float]
max_rate: Optional[float]
open_order_id: Optional[str]
leverage: Optional[float]
interest_rate: Optional[float]
funding_fees: Optional[float]
trading_mode: Optional[TradingMode]
2021-01-01 18:36:03 +00:00
2021-01-01 18:38:28 +00:00
class OpenTradeSchema(TradeSchema):
stoploss_current_dist: Optional[float]
stoploss_current_dist_pct: Optional[float]
stoploss_current_dist_ratio: Optional[float]
stoploss_entry_dist: Optional[float]
stoploss_entry_dist_ratio: Optional[float]
current_profit: float
current_profit_abs: float
current_profit_pct: float
current_rate: float
open_order: Optional[str]
2021-01-01 18:36:03 +00:00
class TradeResponse(BaseModel):
trades: List[TradeSchema]
trades_count: int
total_trades: int
2021-01-01 18:36:03 +00:00
2022-01-26 06:10:38 +00:00
class ForceEnterResponse(BaseModel):
__root__: Union[TradeSchema, StatusMsg]
2021-01-02 14:11:40 +00:00
2020-12-26 16:33:27 +00:00
class LockModel(BaseModel):
2021-03-01 18:50:39 +00:00
id: int
2020-12-26 16:33:27 +00:00
active: bool
lock_end_time: str
lock_end_timestamp: int
lock_time: str
lock_timestamp: int
pair: str
reason: str
class Locks(BaseModel):
lock_count: int
locks: List[LockModel]
2021-03-01 18:50:39 +00:00
class DeleteLockRequest(BaseModel):
pair: Optional[str]
lockid: Optional[int]
2020-12-26 16:33:27 +00:00
class Logs(BaseModel):
log_count: int
logs: List[List]
2022-01-26 06:10:38 +00:00
class ForceEnterPayload(BaseModel):
pair: str
2022-01-26 06:10:38 +00:00
side: SignalDirection = SignalDirection.LONG
price: Optional[float]
2021-11-24 19:11:04 +00:00
ordertype: Optional[OrderTypeValues]
stakeamount: Optional[float]
2022-02-11 14:31:15 +00:00
entry_tag: Optional[str]
2022-01-26 19:17:00 +00:00
class ForceExitPayload(BaseModel):
tradeid: str
2021-11-27 08:10:18 +00:00
ordertype: Optional[OrderTypeValues]
2020-12-26 16:33:27 +00:00
class BlacklistPayload(BaseModel):
blacklist: List[str]
class BlacklistResponse(BaseModel):
blacklist: List[str]
blacklist_expanded: List[str]
errors: Dict
length: int
method: List[str]
class WhitelistResponse(BaseModel):
whitelist: List[str]
length: int
method: List[str]
class DeleteTrade(BaseModel):
cancel_order_count: int
result: str
result_msg: str
trade_id: int
2020-12-26 19:05:27 +00:00
2021-01-02 14:11:40 +00:00
class PlotConfig_(BaseModel):
2020-12-31 10:01:50 +00:00
main_plot: Dict[str, Any]
subplots: Dict[str, Any]
2020-12-26 19:05:27 +00:00
class PlotConfig(BaseModel):
__root__: Union[PlotConfig_, Dict]
2021-01-02 14:11:40 +00:00
2020-12-26 19:05:27 +00:00
class StrategyListResponse(BaseModel):
strategies: List[str]
class StrategyResponse(BaseModel):
strategy: str
code: str
class AvailablePairs(BaseModel):
length: int
pairs: List[str]
pair_interval: List[List[str]]
2020-12-27 08:02:35 +00:00
class PairHistory(BaseModel):
strategy: str
pair: str
timeframe: str
timeframe_ms: int
columns: List[str]
data: List[Any]
length: int
buy_signals: int
sell_signals: int
enter_long_signals: int
exit_long_signals: int
enter_short_signals: int
exit_short_signals: int
2020-12-27 08:02:35 +00:00
last_analyzed: datetime
last_analyzed_ts: int
data_start_ts: int
data_start: str
data_stop: str
data_stop_ts: int
class Config:
json_encoders = {
datetime: lambda v: v.strftime(DATETIME_PRINT_FORMAT),
}
2021-01-02 14:13:32 +00:00
class BacktestRequest(BaseModel):
strategy: str
timeframe: Optional[str]
timeframe_detail: Optional[str]
2021-01-02 14:13:32 +00:00
timerange: Optional[str]
max_open_trades: Optional[int]
stake_amount: Optional[str]
enable_protections: bool
2021-02-28 08:56:13 +00:00
dry_run_wallet: Optional[float]
2021-01-02 14:13:32 +00:00
class BacktestResponse(BaseModel):
status: str
running: bool
status_msg: str
2021-03-11 18:16:18 +00:00
step: str
progress: float
2021-03-12 18:11:17 +00:00
trade_count: Optional[float]
2021-01-02 14:13:32 +00:00
# TODO: Properly type backtestresult...
backtest_result: Optional[Dict[str, Any]]
2021-10-06 17:36:28 +00:00
class SysInfo(BaseModel):
cpu_pct: List[float]
ram_pct: float
class Health(BaseModel):
last_process: datetime
last_process_ts: int