Supported commands

Open market order

To open a market order you need to specify:

Optionally you can specify:

Examples:

Buy 0.01 lots of EUR/USD at market

symbol=EURUSD side=buy quantity=0.01

Sell EUR/USD at market using 5% of equity

symbol=EUR/USD side=short quantity=5% action=create

Changing of market order

To open a market order you need to specify:

Optionally you can specify:

Closing a position

To close a market order you need to specify:

Optionally you can specify:

To close a positon you need to set action=position in the command.

Example:

symbol=EURUSD action=close (close all positions for EURUSD)
symbol=EURUSD action=close side=long (close all long positions for EURUSD)
order-id=12345 action=close (close single position)

Command syntax

Action

Action to do.

Syntax:

order-id=12345 action=create symbol=eurusd quantity=1 side=long
order-id=12345 action=change

Order id

Order id. Can be used for changing stop loss/take profit/order or closing/deleting the trade/order

Syntax:

order-id=12345

Symbol

Syntax:

symbol=your_symbol
symbol=your_symbol

Examples:

symbol=EURUSD
symbol=EUR/USD

Order side

Syntax

side=buy/sell/short/long/B/S

Specifies the side of the order.

Examples:

side=buy
side=short

Lot size

Syntax:

quantity=number
or
quantity=number% (% of equity)
or
quantity=number%r (risk % of equity. The stop loss should be specified as well)

Specifies the lot size of the order. Could be specified in absolute value or percentage or available equity.

quantity=0.01
quantity=5%
quantity=1%r

Stop loss

Optional.

stop-loss=0.0
or 
stop-loss=0.0pip

Take profit

Optional.

take-profit=0.0
or
take-profit=0.0pip

Breakeven

Optional. Moves/sets the stop to the specifed level when the profit hits the specified amount.

breakeven-when=10pips breakeven-to=5pips // move stop to +5 pips profit after 10 pips of profit is reached
breakeven-when=10pips // move stop to 0 pips profit (breakeven point) after 10 pips of profit is reached

Trailing

Optional. Trail the stop each n pips of price movement in the favor direction.

trailing-when=10pip trailing-step=1pip // move price in 1 pip steps after 10 pips profit is reached
trailing-step=0.5pip // move price in 0.5 pip steps