@botmain/execution / Class

StopOrder

Extends Order

The StopOrder constructor takes the same parameters as the parent class Order and additionally a price parameter for the stop price.

Constructor

No documentation has been provided.

Presentation

constructor(
	id: string, 
	amount: number, 
	symbol: string, 
	side: OrderSide, 
	timeInForce: TimeInForce, 
	stopPrice: number
): StopOrder;

Parameters

Name	Type	Description
id overrides `Order`	`string`	Same as in parent `Order` class.
amount overrides `Order`	`number`	Same as in parent `Order` class.
symbol overrides `Order`	`string`	Same as in parent `Order` class.
side overrides `Order`	`OrderSide`	Same as in parent `Order` class.
timeInForce overrides `Order`	`TimeInForce`	Same as in parent `Order` class.
stopPrice	`number`	The stop price for the order

Properties

Name	Type	Description
accountId inherited from `Order`	`string`	Account used to send the order
amount inherited from `Order`	`number`	Order amount in base currency
average inherited from `Order`	`number`	Average filled price
cost inherited from `Order`	`number`	'filled' * 'price' (filled price used where available)
datetime inherited from `Order`	`Date`	Date & time of order placement
exchange inherited from `Order`	`string`	Exchange of the order
fee inherited from `Order`	`Fee`	The fee object for the order
filled inherited from `Order`	`number`	Filled amount of base currency
id inherited from `Order`	`string`	The unique ID of the order. Unique even between different exchanges. Generate using `OrderProcessor.getNextValueOrderId()`
lastTradeTimestamp inherited from `Order`	`number`	Unix timestamp of the most recent trade on this order
market inherited from `Order`	`Market`	Market of the order
ooReason inherited from `Order`	`string`	Origin reason for the order
parentId inherited from `Order`	`string`	Id of the parent algo order. `undefined` if the order is issues by a user strategy
portfolio inherited from `Order`	`string`	The name of the portfolio this order belongs to. The default is `undefined`
price inherited from `Order`	`number`	Price in quote currency (may be empty for market orders)
remaining inherited from `Order`	`number`	Remaining amount pending fill
side inherited from `Order`	`OrderSide`	Side of the order Buy/Sell or BuyCover/SellCover
status inherited from `Order`	`OrderStatus`	Current status of the order
stopPrice	`number`	The stop price for the order
symbol inherited from `Order`	`string`	Instrument symbol of the order. Ex, "binanceDex-BTC/USDT"
timeInForce inherited from `Order`	`TimeInForce`	Time in Force condition for the order to remain active
timestamp inherited from `Order`	`number`	Timestamp of order placement
trades inherited from `Order`	`Trade[]`	Trade fills associated with this order
venueId inherited from `Order`	`string`	Id of the order on the exchange

Usage Notes

const stopOrder = new StopOrder(
    this.orderProcessor.getNextValueOrderId(),
    0.5,
    'binanceDex-BTC/USDT',
    OrderSide.Sell,
    TimeInForce.GTC,
    this.bars.current.low
);

this.orderProcessor.sendOrder(stopOrder);