Trading Strategy Executor Framework

[!WARNING] Algoritmic trading is a risky activity and running this bot can lead to loss of funds.

Python Strategy Executor

A simple trading strategy executor framework to run trading strategies written in Python.

Video Tutorial

Trading Bot API | Explainer Video

Starting the Strategy Executor

The easiest way to spin up the strategy executor is to use the make file:

make start-bb

This is going to spin up all the necessary services. The backend serving the bot-api and the strategy executor running the example strategy.

But before doing this: please make sure to update the .env file.

It should contain the following configuration settings:

CORE_MAESTRO_API_KEY=xxx
MAESTRO_API_KEY=yyy
SERVER_API_KEY=zzz
SEED_PHRASE=[road, road, road, road, road, anger, anger, anger, anger, anger, antenna, antenna, antenna, antenna, token, token, token, cart, cart, cart, cart, cart, cart, cart]

• The CORE_MAESTRO_API_KEY and the MAESTRO_API_KEY are the maestro keys used for different purposes. For details see the dex-contracts-api documentation.
• SERVER_API_KEY: is used to define an api-key that restricts access to the bot api backend. This must be passed with each request.
• SEED_PHRASE contains a YAML array with the words of the recovery phrase which is used to derive the wallet managed by the backend.

[!IMPORTANT] To use the Maestro provider backend on the bot server, you must have at least a Composer Maestro subscription because the Maestro DeFi Market API is only available starting from this tier. For more information, please visit the Maestro Subscription Details page.

Example strategies

[!WARNING] The example strategy implementations are intended only as reference implemnentations.

These examples are not production-ready and are only intended as code examples with the goal to make it easier for trading strategy developers to implement their own trading strategies based on the existing code examples in the strategies folder.

Some example strategies are available in the strategies folder. These can be started by using make.

 > make start-bb # starts strategy
 > make stop # stops the executor

For details please see the Makefile.

Starting example strategies

To start the example strategy placing and cancelling orders based on the Bollinger Bands, you can use make:

> make start-bb

To start the example strategy b, you can use make, but please make sure to stop the previously running strategy first, so there won't be any issues around the used ports:

> make stop
> make start-bb

Developing strategies

After spinning up a strategy; one might want to change something in the source code.

This can be easily done in the python code and the changes can be deployed by simply calling make start-bb again. This is going to deploy the strategy changes, but won't restart the server, so the changes of the strategy logic could be quickly tested.