Limit Order

This section documents the limit_order action

circle-info

This action is used to create a Limit Order.

  • Order will be placed at a specified price using a limit order

  • This action can be used for both opening and closing positions (including adding/reducing size)

  • Limit orders are using the ALO order type, ensuring all orders are resting in the order book (Maker fees)

  • Some parameters are only available for Perps


Example Request

This example will open a long position on BTC at a price of 100,000 using a size of $100 USD, with 1% stop-loss and 2% take-profit

{
  "action": "limit_order", 
  "coin": "BTC",
  "is_buy": true,
  "price": 100000,
  "size_usd": 100,
  "sl_pct": 0.01,
  "tp_pct": 0.02,
  "reduce_only": false,
  "bot_id": BOT_ID,
  "api_key": "API_KEY"
}

This example will close a long position on BTC at a price of 105,000 using 100% of current position size


coin*

This required parameter indicates which coin to use for the action.

circle-info

You can whitelist coins allowed for trading in your Bot Settingsarrow-up-right


is_buy*

This required parameter indicates the direction of the trade.

  • True can open a Long position or close a Short position

  • False can open a Short position or close a Long position


reduce_only*

This required parameter indicates whether the order is allowed to only reduce position size or not.

circle-exclamation
  • A value of true will only allow closing/reducing position

  • A value of false will allow both opening and closing position


price*

This required parameter indicates the price to place the order.

  • A value of 105000 places a limit order at the price 105,000

circle-info

Price must be below current coin price for long positions, and above for short positions. To achieve this behavior you can use the Stop Market Order action instead.


Sizes*

circle-info

3 size types are available to use: size, size_pct, size_usd.

size

This parameter indicates a size.

  • A value of 0.005 is equal to 0.005 BTC

size_usd

This parameter indicates a size in USD.

  • A value of 100 is equal to $100 USD

size_pct

This parameter indicates either a size in percentage of available balance when opening an order, or a size in percentage of current position when closing an order.

  • A value of 0.1 is equal to 10%

circle-info
  • When opening an order (reduce_only=false), a size_pct of 0.1 means 10% of available account balance

  • When closing an order (reduce_only=true), a size_pct of 0.1 means 10% of current position size


Take-Profit & Stop-Loss

These parameters allows you to add single take-profit and stop-loss orders.

circle-exclamation
circle-info
  • Single TP/SL orders will market-close a percentage of the current order size

  • Percentage-based TP/SL are calculated based on entry prices (not ROE %)

sl_pct

This parameter indicates the % from entry to place your stop-loss.

  • A value of 0.01 is equal to a 1% stop-loss

tp_pct

This parameter indicates the % from entry to place your take-profit.

  • A value of 0.01 is equal to a 1% take-profit

sl

This parameter indicates a direct price to place your stop-loss.

tp

This parameter indicates a direct price to place your take-profit.


delay

This parameter indicates a number of seconds to wait before triggering the action.

  • A value of 5 is equal to a 5 seconds delay

  • Max. allowed delay is 10 seconds

Last updated