Overview

TIP

If you are new to trading, you can read our tutorial "Trading basics".

Introduction

A trading bot is a computer program that can automatically place orders to a market or exchange without the need for human intervention. They are working for you 24/7 and never lose their focus.

Cassandre trading bot (available as a Spring boot starter (opens new window)) allows you to create and execute your trading strategy in seconds on most crypto exchanges. We also provide a dry mode and a spring boot starter to backtest your bot on historical and/or real-time data.

Once the starter is added to your Spring Boot project, it will search for a class having the @CassandreStrategy (opens new window) annotation and extending BasicCassandreStrategy (opens new window) or BasicTa4jCassandreStrategy (opens new window).

BasicCassandreStrategy

For a BasicCassandreStrategy (opens new window), you have to implement :

• getRequestedCurrencyPairs() (opens new window) to indicate the list of currency pairs tickers you want to receive.
• getTradeAccount() (opens new window) to indicate which account is your trading account.

BasicTa4jCassandreStrategy

For a BasicTa4jCassandreStrategy (opens new window), you have to implement :

• getRequestedCurrencyPair() (opens new window) to indicate the currency pair tickers you want to receive.
• getTradeAccount() (opens new window) to indicate which account is your trading account.
• getMaximumBarCount() (opens new window) to indicate how many bars you want to keep.
• getDelayBetweenTwoBars() (opens new window) to indicate the delay between two bars.
• getStrategy() (opens new window) to implement your own strategy.
• shouldEnter() (opens new window) to indicate what you want to do when it's time to buy.
• shouldExit() (opens new window) to indicate what you want to do when it's time to sell.

Data updates

To be notified of new data, you can override the following methods :

• onAccountUpdate() (opens new window) to receive updates about your account.
• onTickerUpdate() (opens new window) to receive new tickers.
• onOrderUpdate() (opens new window) to receive updates about your orders.
• onTradeUpdate() (opens new window) to receive updates about your trades.
• onPositionUpdate() (opens new window) to receive updates about your positions.
• onPositionStatusUpdate() (opens new window) to receive updates about position status change.

Buying/selling

Inside your strategy, you can create market orders with the methods :

• createBuyMarketOrder() (opens new window)
• createSellMarketOrder() (opens new window)

And limit orders with :

• createBuyLimitOrder() (opens new window)
• createSellLimitOrder() (opens new window)

Positions

You can also create positions with :

• createLongPosition() (opens new window)
• createShortPosition() (opens new window)

On Positions, you can get the:

• The lowest calculated gain with getLowestPrice() (opens new window)
• The highest calculated gain with getHighestGainPrice() (opens new window)
• The latest calculated gain with getLatestGainPrice() (opens new window)

On a closed position, you can get the gain & fees with getGain() (opens new window)

TIP

If you don't know what a position is, read this position system explanation.