Trading
Matching Engine
Private

Changed on

Cancels a specific order identified by its order ID. The order must be open (not yet filled or cancelled) to be cancelled successfully.

Once cancelled, the order is removed from the order book and cannot be restored. Any unfilled portion of the order will be cancelled.

Scope: trade:read_write

Try in API console

get/private/cancel

Request

  • Base URL
    https://test.deribit.com/api/v2
  • URL
    https://test.deribit.com/api/v2/private/cancel
  • Auth
    none declared

Query parameters

order_idstring required

Unique order identifier

Example:ETH-100234

The order id

Response

Success response

jsonrpc'2.0' required

The JSON-RPC version (2.0)

idinteger

The id that was sent in the request

Example response

{
  "result": {
    "order_id": "ETH-100234",
    "instrument_name": "BTC-PERPETUAL",
    "creation_timestamp": 1536569522277,
    "last_update_timestamp": 1536569522277,
    "starbase_last_update_timestamp": 1536569522277000000,
    "block_trade": true,
    "trigger_order_id": "SLIB-370",
    "combo_order_id": "103148386169",
    "starbase_order_id": 103148386170,
    "app_name": "Example Application",
    "mmp_cancelled": true,
    "oto_order_ids": [
      "ETH-100234"
    ],
    "primary_order_id": "ETH-100234"
  }
}

Changes

  • 6e5c000c82a8Revision changes
    • info

      added the optional property / to the response with the status

  • 430b3f0bc67cRevision changes
    • info

      removed the speed_bumped enum value from the / response property for the response status