All Orders

Testnet Env

https://testnet.trade.vessel.finance

GET

/api/v1/gateway/user/history/allOrders

Last modified:2024-10-15 06:23:56

All Orders provides comprehensive details about all historical orders for a specific trading pair on our platform. This includes both filled, expired and canceled orders.

Request

Query Params

symbol

string

optional

The trading pair symbol for the order.

Example:

WBTCUSDC

limit

string

optional

Default 500; max 1000.

startTime

string

optional

The start of the time range for the claim history in Unix milliseconds.

endTime

string

optional

Specifies the ending time (Unix timestamps in milliseconds & UTC) for retrieving deposit history. Only deposits made before or at this timestamp will be included in the result.

side

string

optional

Specifies the order side, either "BUY" for a buy order or "SELL" for a sell order.

type

string

optional

Specifies the order type. either "LIMIT" for a limit order or "MARKET" for a market order.

fromId

string

optional

The ID from which to start fetching records. In this API, since the order is descending (backwards), if fromId is set to 100, the system will return records starting from the ID just before 100 and continue moving backwards. The retrieval will proceed until the limit is reached.

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

curl --location --request GET 'https://testnet.trade.vessel.finance/api/v1/gateway/user/history/allOrders?symbol=WBTCUSDC&startTime&endTime&side&type&fromId' \
--header 'VESSEL-API-KEY;' \
--header 'VESSEL-PASSPHRASE;' \
--header 'VESSEL-SIGNATURE;' \
--header 'VESSEL-TIMESTAMP;'

Responses

🟢200OK

application/json

Body

orders

array [object {13}]

required

An array containing details for each historical order.

clientOrderId

string

required

Unique identifier assigned by the client to the order.

cumulativeQuoteQty

string

required

Cumulative amount in the quote currency that has been traded.

executedQty

string

required

Quantity of the asset that has been executed.

orderId

string

required

Unique identifier for the order.

orderTime

string

required

Timestamp that the order was placed (Unix timestamps in milliseconds & UTC).

origQty

string

required

Original quantity of the asset in the order.

price

string

required

Price specified for the order.

side

string

required

Side of the order, indicating whether it's a "BUY" or "SELL" order.

status

string

required

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.

symbol

string

required

Trading pair symbol for the order.

timeInForce

string

required

Time in force for the order. "GTC" for Good Til Canceled, "FOK" for Fill Or Kill, and "IOC" Immediate Or Cancel.

type

string

required

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

workingTime

string

required

Last timestamp that the order was processed by the match engine (Unix timestamps in milliseconds & UTC).

Example

{
  "orders": [
    {
      "clientOrderId": "1728719827204",
      "cumulativeQuoteQty": "0",
      "executedQty": "0",
      "orderId": "1728711700276119",
      "orderTime": "1728719833436",
      "origQty": "0.5",
      "price": "2400",
      "side": "BUY",
      "status": "CANCELED",
      "symbol": "ETH01USDC",
      "timeInForce": "GTC",
      "type": "LIMIT",
      "workingTime": "1728719848823"
    }
  ]
}

Completed Orders

Query Order