Enums

About enums

Enumsopen in new window represent possible sets of values for a field.

OrderStatus

Order status.

Value	Description
CANCELED	Removed from order book at exchange.
CLOSED	Order has been either filled or cancelled.
EXPIRED	Order has expired it’s time to live or trading session and been removed from order book.
FILLED	Fully match against opposite order on order book at exchange.
NEW	Initial order when placed on the order book at exchange.
OPEN	Order is open and waiting to be filled.
PARTIALLY_CANCELED	Order partially canceled at exchange.
PARTIALLY_FILLED	Partially match against opposite order on order book at exchange.
PENDING_CANCEL	Waiting to be removed from order book at exchange.
PENDING_NEW	Initial order when instantiated.
PENDING_REPLACE	Waiting to be replaced by another order on order book at exchange.
REJECTED	Order has been rejected by exchange and not place on order book.
REPLACED	Order has been replaced by another order on order book at exchange.
STOPPED	Order has been triggered at stop price.
UNKNOWN	The exchange returned a state which is not in the exchange’s API documentation. The state of the order cannot be confirmed.

OrderType

Order type.

Value	Description
ASK	Selling.
BID	Buying.

PositionStatus

Position status.

Value	Description
CLOSED	Closed - the sell order has been accepted.
CLOSING	Closing - a sell order has been made but not yet completed.
CLOSING_FAILURE	Closing failure - the sell order did not succeed.
OPENED	Opened - the buy order has been accepted.
OPENING	Opening - a position has been created, a buy order has been made but not yet completed.
OPENING_FAILURE	Opening failure - a position has been created, but the buy order did not succeed.

PositionType

Position type.

Value	Description
LONG	Long position is nothing but buying share and selling them later for more.
SHORT	Short position is nothing but selling share and buying back later for less.

TradeType

Trade type.

Value	Description
ASK	Selling.
BID	Buying.