Query Order - Vessel Finance API

Query Order provides detailed information about a specific order on our platform using the trading pair symbol and either the orderId or clientOrderId. It only returns data for closed orders within the last 14 days or open orders. If you need to retrieve information about orders that were closed more than 14 days ago, please refer to the All Orders endpoint.

Request

Query Params

orderId

string

optional

A unique identifier for the order. Either the orderId or clientOrderId should be provided to uniquely identify the order.

Example:

23113

symbol

string

required

The trading pair symbol for the order.

Example:

WBTCUSDT

clientOrderId

string

optional

The unique identifier assigned by the client to the order.

Header Params

VESSEL-API-KEY

string

required

Default:

VESSEL-PASSPHRASE

string

required

Default:

VESSEL-SIGNATURE

string

required

Use signRequest script to generate

VESSEL-TIMESTAMP

string

required

Use signRequest script to set

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

symbol

string

required

The trading pair symbol for the order.

orderId

string

required

A unique identifier for the order.

clientOrderId

string

required

The unique identifier assigned by the client to the order.

price

string

required

The price specified for the order.

origQty

string

required

The original quantity of the asset in the order.

executedQty

string

required

The quantity of the asset that has been executed.

cumulativeQuoteQty

string

required

The cumulative amount in the quote currency that has been traded.

status

string

required

The current status of the order. Possible values include:
NEW: The order has been created and is awaiting processing.
PARTIALLY_FILLED: The order has been partially filled.
FILLED: The order has been completely filled.
CANCELED: The order has been canceled.
REJECTED: The order has been rejected.
EXPIRED: The order has expired.

timeInForce

string

required

The time in force for the order (e.g., "GTC" for Good 'Til Canceled).

type

string

required

The type of the order (e.g., "LIMIT" or "MARKET").

side

string

required

The side of the order, indicating whether it's a buy or sell order.

workingTime

string

required

The last time the order was processed by the match engine.

orderTime

string

required

The time that the order was placed.

Example

{
    "symbol": "WBTCUSDT",
    "orderId": "1728555634983152",
    "clientOrderId": "1728623775719",
    "price": "64516.18",
    "origQty": "0.0001",
    "executedQty": "0",
    "cumulativeQuoteQty": "0",
    "status": "NEW",
    "timeInForce": "GTC",
    "type": "LIMIT",
    "side": "SELL",
    "workingTime": "1728623778176",
    "orderTime": "1728623778175"
}