order_status

order_status uuid

The order_status method returns the data of the order with the selected uuid created by the AtomicDEX API node. The response is different for maker and taker orders.

Argument

Structure	Type	Description
uuid	string	uuid of order to display

Command

POST

order_status

{
  "userpass": "testpsw",
  "method": "order_status",
  "uuid": "c3b3105c-e914-4ed7-9f1c-604783b054a1"
}

Response (No order found)

{ "error": "Order with uuid c3b3105c-e914-4ed7-9f1c-604783b054a1 is not found" }

Maker Order Response

Structure	Type	Description
type	string	type of the order ("Maker" or "Taker")
order	object	order data
order.base	string	base currency
order.rel	string	rel currency
order.price	number	order price as decimal number
order.price_rat	rational number	order price as rational number
order.max_base_vol	number	Maximum trade volume
order.max_base_vol_rat	rational number	Maximum trade volume as rational number
order.min_base_vol	number	Minimum trade volume
order.min_base_vol_rat	rational number	Minimum trade volume as rational number
order.created_at	number	timestamp of order creation
order.updated_at	number	timestamp of last order update
order.matches	list	UUIDS of matching orders
order.started_swaps	list	UUIDS of swaps started
order.uuid	string	UUID of this order
order.conf_settings	object	Confirmation / Notarisation settings for order
order.base_orderbook_ticker	string	the ticker of the base currency if `orderbook_ticker` is configured for the base currency in `coins` file. If not defined, will return a null value.
order.rel_orderbook_ticker	string	the ticker of the rel currency if `orderbook_ticker` is configured for the rel currency in `coins` file. If not defined, will return a null value.
order.cancellable	boolean	`true` if order is in a state which it can be cancelled. `false` if not (e.g. swap is in progress)
order.cancellation_reason	string	`Cancelled` indicates order was withdrawn by user. `Fulfilled` indicates order was swapped successfully. `TimedOut` indicates a taker order with type `FillOrKill` expired before matching.
order.available_amount	string	Funds available for order to be matched against, taking into account current spendable balance and `max_volume`

📌 Maker Order Examples

Response: Taker Orders

Structure	Type	Description
type	string	type of the order ("Maker" or "Taker")
order	object	order data
order.created_at	number	timestamp of order creation
order.request	object	details of requested trade
order.request.base	string	base currency
order.request.base_amount	number	base currency amount
order.request.base_amount_rat	rational number	base currency amount as rational number
order.request.rel	string	rel currency
order.request.rel_amount	number	rel currency amount
order.request.rel_amount_rat	rational number	rel currency amount as rational number
order.request.action	string	`buy` or `sell`
order.request.uuid	string	Taker order UUID
order.request.method	string	Deprecated field, which always has the value `request`.
order.request.sender_pubkey	string	Pubkey of Taker
order.request.dest_pub_key	string	reserved for future use. The `dest_pub_key` allows the user to choose the P2P node that is eligible to match with the request. This value defaults to "zero pubkey", meaning that `anyone` can match
order.request.match_by.type	string	`Orders` to select specific uuids; `Pubkeys` to select specific nodes; Defaults to `Any`
order.request.conf_settings	object	base/rel confirmation/notarisation settings
order.matches	object	Details of matching Maker Order UUIDs
order.order_type	object	A standard OrderType object.
order.matches	list	UUIDS of matching orders
order.base_orderbook_ticker	string	the ticker of the base currency if `orderbook_ticker` is configured for the base currency in `coins` file. If not defined, will return a null value.
order.rel_orderbook_ticker	string	the ticker of the rel currency if `orderbook_ticker` is configured for the rel currency in `coins` file. If not defined, will return a null value.
order.cancellable	boolean	`true` if order is in a state which it can be cancelled. `false` if not (e.g. swap is in progress)
cancellation_reason	string	`Cancelled` indicates order was withdrawn by user. `Fulfilled` indicates order was swapped successfully. `TimedOut` indicates a taker order with type `FillOrKill` expired before matching.

order_status

Argument

Command

Response (No order found)

Maker Order Response

📌 Maker Order Examples

Response: Taker Orders

📌 Taker Order Examples