Get order details by id [Private]

get https://{BASE_URL_PROD}/v4/order/private/details/{id}

Get order details by order id (e.g. 4802bc23-45e9-4299-b878-48a41432ef17). Returns an order object. Also, may include an array of trades if withTrades = true.

This is a private route, so the api-key parameter should be sent in the header.

Data dictionary

Name	Type	Parameter type	Required	Range	Description
id	string	PATH	YES	-	The UUID of the order to show details.
withTrades	bool	QUERY	NO	`true, false`	Specify if the response should include trades associated with the order.

Exemplary request

If you do not have any orders created yet, please create a new order using Create a new order endpoint first.
You should receive an order id in the response, which should then be added to the path of this request: {{baseURL}}/v4/order/private/details/{{ORDER_ID}}

Response structure

You will receive a JSON in the response with data object, structured like this example:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "id": "6ae80635-5434-4b85-a1c2-38856b50d295",     // Unique identifier of an order
    "type": "Limit",                                  // Type of an order
    "quantity": "0.01",                               // Original order quantity
    "executedQuantity": "0.00",                       // Traded quantity is 0 if no trades 
    "pair": "BTC_USDT",                               // Traded pair
    "price": "16700",                                 // Price to trade
    "status": "Open",                                 // The status of the order
    "createdAt": "2022-10-01T12:08:55.444Z",          // Date-time of order creation, UTC
    "startAt": "2022-10-01T12:08:55.444Z",            // Date-time of beginning order execution, UTC
}

If you also add withTrades=true and trades were executed for the order, then the data object will include trades array, for example:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
        
{
    "id": "6ae80635-5434-4b85-a1c2-38856b50d295",     // Unique identifier of an order
    "type": "Limit",                                  // Type of an order
    "quantity": "0.01",                               // Original order quantity
    "executedQuantity": "0.01",                       // Total traded quantity, if there were trades
    "pair": "BTC_USDT",                               // Traded pair
    "price": "16700",                                 // Price to trade
    "status": "Closed",                               // The status of the order
    "createdAt": "2022-10-01T12:08:55.444Z",          // Date-time of order creation, UTC
    "startAt": "2022-10-01T12:08:55.444Z",            // Date-time of beginning order execution, UTC
    "trades": [
        {
            "id": "73f4cf03-c79b-461f-9bbe-257c1c957073",           // Unique identifier of a trade
            "orderId": "6ae80635-5434-4b85-a1c2-38856b50d295",      // Unique identifier of an associated order
            "pair": "BTC_USDT",                                     // Traded pair
            "quantity": "0.01",                                     // Traded quantity
            "price": "19083",                                       // Traded price
            "isTaker": false,                                       // Various fees for Makers and Takers; "Market" orders are always `true`
            "fee": "0.477075",                                      // Exchange commission fee
            "feeCurrency": "BTC",                                   // Currency of the commission
            "isBuyer": false,                                       // Buy or sell the base asset
            "quoteQuantity": "190.83",                              // Quote asset quantity
            "createdAt": "2022-10-01T12:08:55.465Z"                 // Date-time of trade execution, UTC
        }
    ]
}

Errors

Status	Error code	Message	Parameter	Description
404	NotFoundException	Order with id: {SOME_ID} not found!	`id`	Order with such ID either does not exist or belongs to another user
500	WrongRequestException	id must be a UUID	`id`	Incorrect order id received
500	WrongRequestException	property uuid should not exist	`id`	Sent UUID as QUERY parameter, but should be sent as PATH