Cancel Order - Vessel Finance API

Request

Query Params

symbol

string

required

The trading pair symbol for the order.

orderId

string

required

The unique identifier for the order to be canceled.

address

string

optional

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

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request DELETE 'https://testnet.trade.vessel.finance/api/v1/order?symbol=&orderId=' \
--header 'VESSEL-API-KEY;' \
--header 'VESSEL-PASSPHRASE;' \
--header 'VESSEL-SIGNATURE;' \
--header 'VESSEL-TIMESTAMP;'

Responses

🟢200OK

application/json

Body

symbol

string

required

The trading pair symbol for the canceled order.

orderId

string

required

The unique identifier for the canceled order.

transactTime

string

required

The timestamp representing the time when the cancel request was received by our server.

price

string

required

The price specified for the canceled order.

origQty

string

required

The original quantity of the asset in the canceled order.

executedQty

string

required

The quantity of the asset that was executed before the order was canceled.

status

string

required

The current status of the canceled order (e.g., "CANCELED").

timeInForce

string

required

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

type

string

required

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

side

string

required

The side of the canceled order, indicating whether it was a "BUY" or "SELL" order.

Example

{
  "symbol": "WBTCUSDT",
  "orderId": "1728555634983152",
  "transactTime": "1728623789364",
  "price": "64516.18",
  "origQty": "0.0001",
  "executedQty": "0",
  "status": "CANCELED",
  "timeInForce": "GTC",
  "type": "LIMIT",
  "side": "SELL"
}