Order

Path in Local Pack include/order.h

Description of the market order.

Methods

Name Description
id() Unique order identifier.
dir() Order direction.
price() Order price.
amount() Order initial amount.
amount_rest() Order current amount.
status() Order status.
server_time() Order placement server time.

Methods description

id()

Returns the unique numeric identifier of an order, which was received during a simulation. It can be used to aggregate some information about the order.

C++
Python
Id id() const;
def id(self)

dir()

Returns a direction of the order.

C++
Python
Dir dir() const;
def dir(self)

price()

Returns a price of the order.

C++
Python
Price price() const;
def price(self)

amount()

Returns an initial volume of the order (the amount of lots).

C++
Python
Amount amount() const;
def amount(self)

amount_rest()

Returns current volume of the order (the amount of lots which have not been matched with other orders yet).

C++
Python
Amount amount_rest() const;
def amount_rest(self)

status()

Returns an enum class value — order's status.

Possible statuses are: Adding, Active, Deleting, Deleted. Please read more in the OrderStatus class description: https://docs.hftbattle.com/en/api/CommonEnums.html#orderstatus.

C++
Python
OrderStatus status() const;
def status(self)

server_time()

Returns the server time, when the order was placed, in microseconds.

C++
Python
Microseconds server_time() const;
def server_time(self)

results matching ""

    No results matching ""