Skip to content

orders.md

Latest commit

 

History

History
61 lines (49 loc) · 2.3 KB

orders.md

File metadata and controls

61 lines (49 loc) · 2.3 KB

Orders

Orders can be created using the following keywords:

  • market
  • limit
  • stop_loss
  • trailing_market

Amount

Each order accept the following optional arguments:

  • amount: for spot and futures trading
  • target_position: futures trading only

To specify the amount per order, use the following syntax:

  • 0.1 to trade 0.1 BTC on BTC/USD
  • 2% to trade 2% of the total portfolio value
  • 12%a to trade 12% of the available holdings
# create a buy market order using 10% of the total portfolio
await op.market(ctx, "buy", amount="10%")

Price

Orders set their price using the offset argument.

To specify the order price, use the following syntax:

  • 10 to set the price 10 USD above the current BTC/USD market price
  • 2% to set the price 2% USD above the current BTC/USD market price
  • @15555 to set the price at exactly 15555 USD regardless of the current BTC/USD market price
# create a buy limit order of 0.2 units (BTC when trading BTC/USD) 
# with a price at 1% bellow the current price
await op.limit(ctx, "buy", amount="0.2", offset="-1%")

Note: market orders do not accept the offset argument.

Automated take profit and stop losses

When creating orders, it is possible to automate the associated stop loss and / or take profits. When doing to, the associated take profit/stop loss will have the same amount as the initial order.

Their price can be set according to the same rules as the initial order price (the offset argument) using the following optional argument:

  • stop_loss_offset: automate a stop loss creation when the initial order is filled and set the stop loss price
  • take_profit_offset: automate a take profit creation when the initial order is filled and set the take profit price
# create a buy limit order of 0.2 units (BTC when trading BTC/USD) with: 
# - price at 1% bellow the current price
# - stop loss at 10% loss
# - take profit at 15% profit
await op.limit(ctx, "buy", amount="0.2", offset="-1%", stop_loss_offset="-10%", take_profit_offset="15%")

{% hint style="info" %} When using both stop_loss_offset and take_profit_offset, two orders will be created after the initial order fill. Those two orders will be grouped together, meaning that if one is cancelled or filled, the other will be cancelled. {% endhint %}