StrategySummary#

API documentation for tradeexecutor.strategy.summary.StrategySummary Python class in Trading Strategy framework.

class StrategySummary[source]#

Bases: object

Strategy summary.

  • Helper class to render strategy tiles data

  • Contains mixture of static metadata, trade executor crash status, latest strategy performance stats and visualisation

  • Is not stored as the part of the strategy state. In the case of a restart, summary statistics are calculated again.

  • See /summary API endpoint where it is constructed before returning to the client

__init__(name, short_description, long_description, icon_url, on_chain_data, started_at, executor_running, frozen_positions, summary_statistics=<factory>, error_message=None, backtest_available=False, crashed_at=None, badges=<factory>, tags=<factory>, fees=<factory>)#
Parameters:
Return type:

None

Methods

__init__(name, short_description, ...[, ...])

from_dict(kvs, *[, infer_missing])

from_json(s, *[, parse_float, parse_int, ...])

schema(*[, infer_missing, only, exclude, ...])

to_dict([encode_json])

to_json(*[, skipkeys, ensure_ascii, ...])

Attributes

backtest_available

Can the server server backtest files

crashed_at

When the executor bailed out with an exception

error_message

Exception message from the run-time loop

name

Strategy name

short_description

1 sentence

long_description

Multiple paragraphs.

icon_url

For <img src>

on_chain_data

List of smart contracts and related web3 interaction information for this strategy.

started_at

When the instance was started last time

executor_running

Is the executor main loop running or crashed.

frozen_positions

Number of frozen positions this strategy has and need to manual intervention

summary_statistics

Strategy statistics for summary tiles

badges

List of strategy tile badges

tags

List of strategy tile badges

fees

Fees charged by the strategy
name: str#

Strategy name

short_description: Optional[str]#

1 sentence

long_description: Optional[str]#

Multiple paragraphs.

icon_url: Optional[str]#

For <img src>

on_chain_data: OnChainData#

List of smart contracts and related web3 interaction information for this strategy.

started_at: float#

When the instance was started last time

Unix timestamp, as UTC

executor_running: bool#

Is the executor main loop running or crashed.

Use /status endpoint to get the full exception info.

Not really a part of metadata, but added here to make frontend queries faster. See also tradeexecutor.state.executor_state.ExecutorState.

frozen_positions: int#

Number of frozen positions this strategy has and need to manual intervention

summary_statistics: StrategySummaryStatistics#

Strategy statistics for summary tiles

Helps rendering the web tiles.

error_message: str | None = None#

Exception message from the run-time loop

backtest_available: bool = False#

Can the server server backtest files

crashed_at: datetime.datetime | None = None#

When the executor bailed out with an exception

badges: List[str]#

List of strategy tile badges

See Metadata.badges for description.

tags: Set[StrategyTag]#

List of strategy tile badges

See Metadata.tags for description.

fees: Dict[str, float]#

Fees charged by the strategy

See Metadata.fees for description.

__init__(name, short_description, long_description, icon_url, on_chain_data, started_at, executor_running, frozen_positions, summary_statistics=<factory>, error_message=None, backtest_available=False, crashed_at=None, badges=<factory>, tags=<factory>, fees=<factory>)#
Parameters:
Return type:

None