@botmain/execution / Class

Order

No documentation has been provided.

Constructor

No documentation has been provided.

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

Name	Type	Description
id	`string`	The unique ID of the order. Unique even between different exchanges. Generate using `OrderProcessor.getNextValueOrderId()`
amount	`number`	The amount of the order on the base currency
symbol	`string`	The symbol for the order. For ex, "binanceDex-BTC/USDT"
side	`OrderSide`	The side of the order (Buy/Sell or BuyCover/SellCover)
timeInForce	`TimeInForce`	The time in force condition for the order to remain active (GTC, IOC, FOK, or PO)

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