Naming Dictionary

Reference table of all enum values and data structures used by the crypto trading API.

side (Trade Direction)

Value	Description
`BUY`	Buy
`SELL`	Sell

Value	Description
`TIF_GTC`	Good Till Cancel — active until manually cancelled. Applies to `LIMIT`, `TAKE_PROFIT_LIMIT`, `STOP_LOSS_LIMIT`
`TIF_IOC`	Immediate Or Cancel — fill immediately, cancel any unfilled remainder. Applies to `MARKET`, `TAKE_PROFIT_MARKET`, `STOP_LOSS_MARKET`

Value	Description
`PENDING_TRIGGER`	Pending trigger (conditional order)
`PENDING_NEW`	Pending new
`NEW`	New order
`PARTIAL_FILLED`	Partially filled
`FILLED`	Fully filled
`CANCELED`	Cancelled
`REJECTED`	Rejected
`CANCELLED_PART`	Partially filled then cancelled
`EXPIRED`	Expired
`FAILED`	Order placement failed

The order object returned by order query endpoints.

Field	Type	Description
`order_id`	string	Order ID, unchanged throughout the order lifecycle
`version`	uint32	Order version number; required when modifying an order (must be the latest value)
`symbol_pair`	SymbolPair	Trading pair
`side`	side	Trade direction
`order_qty`	string	Order quantity
`price`	string	Order price
`order_amount`	string	Order amount
`cum_qty`	string	Cumulative filled quantity
`avg_px`	string	Average fill price
`fill_amount`	string	Total fill amount
`ord_type`	ord_type	Order type
`time_in_force`	time_in_force	Order time in force
`create_time`	int64	Order creation time (Unix microseconds)
`update_time`	int64	Order last update time (Unix microseconds)
`ord_status`	ord_status	Order status
`order_show_id`	string	Display order ID for client UI
`is_close`	bool	Whether the order has reached a terminal state
`trigger_price`	string	Trigger price for conditional orders; empty string for non-conditional orders
`trigger_time`	int64	Trigger time for conditional orders (Unix microseconds); `0` if not yet triggered
`cash_order_qty`	string	Amount for amount-based orders; empty string for quantity-based orders

The fill object returned by fill query endpoints.