Open Position

This section documents the open_position action

This action is used to open new positions.

• Positions will be opened immediately with a Market Order

• This action can only be used to open a new position or to switch direction (can't be used for adding/reducing size, use market_order instead)

• Previous positions will be closed automatically when switching direction (long>short | short>long)

---

Example Request

This example opens a long position on BTC using a size of 10% of available balance, with 1% stop-loss and 2% take-profit.

{
  "action": "open_position", 
  "coin": "BTC",
  "is_buy": true,
  "size_pct": 0.1,
  "sl_pct": 0.01,
  "tp_pct": 0.02,
  "bot_id": BOT_ID,
  "api_key": "API_KEY"
}

---

coin*

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

"coin": "BTC"

You can whitelist coins allowed for trading in your Bot Settings

---

is_buy*

This required parameter indicates the direction to open the trade.

• True will open a Long position

• False will open a Short position

"is_buy": true

---

Sizes*

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

size

This parameter indicates a size in contracts.

• A value of 0.005 is equal to 0.005 BTC

"size": 0.005

size_usd

This parameter indicates a size in USD.

• A value of 100 is equal to $100 USD

"size_usd": 100

size_pct

This parameter indicates a size in percentage of available balance.

• A value of 0.1 is equal to 10% of account balance

"size_pct": 0.1

i.e. You have $1,000 USD in your account and open a position with 10% of your balance:

• A new position will be opened with a size of $100 USD

• This size is not affected by leverage, the position size will be $100 for both 1x or 10x leverage

• Leverage only changes the % of margin used, not the position size.

• *At 10x leverage, you can send a max. size_pct of 10 (1000%), which in this example would result in a total position size of $10,000 USD

---

Take-Profit & Stop-Loss

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

• Position TP/SL orders will market-close the entire position when triggered (even if its size has increased)

• 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

"sl_pct": 0.01

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

"tp_pct": 0.01

sl

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

"sl": 62500

tp

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

"tp": 72500

---

Multiple Take-Profit & Stop-Loss

These parameters allows you to place multiple take-profit and stop-loss orders.

• Additional TP/SL orders will market-close a percentage of the current position size

tps

This parameter allows you to place multiple take-profit orders.

• You can specify TPs using a percentage from entry or a direct price:

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

  • A tp value of 120500 indicates a direct price to place your take-profit.

• A size_pct value of 0.5 will close 50% of your order

"tps": [
    {"tp_pct": 0.01, "size_pct": 0.5},
    {"tp": 120500, "size_pct": 1}
]

sls

This parameter allows you to place multiple stop-loss orders.

• You can specify SLs using a percentage from entry or a direct price:

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

  • A sl value of 120500 indicates a direct price to place your stop-loss.

• A size_pct value of 1 will close 100% of your order

"sls": [
    {"sl_pct": 0.01, "size_pct": 0.5},
    {"sl": 120500, "size_pct": 1}
]

---

slippage_pct

This parameter indicates the Max. % slippage allowed for the trade to execute.

• A value of 0.05 is equal to 5%

"slippage_pct": 0.05

Default to 5% when not specified

---

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

"delay": 5