Edit Order by Label

Method: private/edit_by_label

Parameters

Request Example

{
  "rid": 41001,
  "method": "private/edit_by_label",
  "params": {
    "label": "test-label-edit-1760339620424",
    "quantity": "3",
    "contracts": null,
    "price": "58000",
    "postOnly": true,
    "rejectPostOnly": null,
    "reduceOnly": null,
    "triggerPrice": null,
    "triggerOffset": null,
    "advanced": null,
    "mmp": null,
    "validUntil": null,
    "instrumentName": "BTC-PERPETUAL"
  }
}

Response

order Object

| quote | boolean | if order is a quote. Present only if true. | | triggered | boolean | Whether the trigger order has been triggered | | mobile | boolean | optional field with value true added only when created with Mobile Application | | implv | string | Implied volatility in percent. (Only if advanced="implv") | | refreshAmount | string | The initial display amount of iceberg order. Iceberg order display amount will be refreshed to that value after match consuming actual display amount. Absent for other types of orders | | usd | string | Option price in USD (Only if advanced="usd") | | otoOrderIds | array of string | The Ids of the orders that will be triggered if the order is filled | | api | boolean | true if created with API | | averagePrice | string | Average fill price of the order | | advanced | string | advanced type: "usd" or "implv" (Only for options; field is omitted if not applicable) | | orderId | string | Unique order identifier | | postOnly | boolean | true for post-only orders only | | filledQuantity | string | Filled amount of the order. For perpetual and futures the filled_amount is in USD units, for options - in units or corresponding cryptocurrency contracts, e.g., BTC or ETH. | | trigger | string | Trigger type (only for trigger orders). Allowed values: "index_price", "mark_price", "last_price". | | triggerOrderId | string | Id of the trigger order that created the order (Only for orders that were created by triggered orders) | | side | string | Direction: buy, or sell | | contracts | string | It represents the order size in contract units. (Optional, may be absent in historical data) | | isSecondaryOto | boolean | true if the order is an order that can be triggered by another order, otherwise not present. | | replaced | boolean | true if the order was edited (by user or - in case of advanced options orders - by pricing engine), otherwise false. | | mmpGroup | string | Name of the MMP group supplied in the private/mass_quote request. Only present for quote orders. | | mmp | boolean | true if the order is a MMP order, otherwise false | | lastUpdatedAt | long | The timestamp (milliseconds since the Unix epoch) | | createdAt | long | The timestamp (milliseconds since the Unix epoch) | | cancelReason | string | Enumerated reason behind cancel | | mmpCancelled | boolean | true if order was cancelled by mmp trigger (optional) | | quoteId | string | The same QuoteID as supplied in the private/mass_quote request. Only present for quote orders | | orderState | string | Order state: "open", "filled", "rejected", "cancelled", "untriggered" | | isRebalance | boolean | Optional (only for spot). true if order was automatically created during cross-collateral balance restoration | | rejectPostOnly | boolean | If an order is considered post-only and this field is set to true then the order is put to the order book unmodified or the request is rejected. Only valid in combination with "post_only" set to true | | label | string | User defined label | | isLiquidation | boolean | Optional (not added for spot). true if order was automatically created during liquidation | | price | string | Price in base currency or "market_price" in case of open trigger market orders | | web | boolean | true if created via Deribit frontend (optional) | | timeInforce | string | Order time in force: "good_til_cancelled", "good_til_day", "fill_or_kill" or "immediate_or_cancel" | | triggerReferencePrice | string | The price of the given trigger at the time when the order was placed (Only for trailing trigger orders) | | displayAmount | string | The actual display amount of iceberg order. Absent for other types of orders. | | orderType | string | Order type: "limit", "market", "stop_limit", "stop_market" | | isPrimaryOtoco | boolean | true if the order is an order that can trigger an OCO pair, otherwise not present. | | originalOrderType | string | Original order type. Optional field | | blockTrade | boolean | true if order made from block_trade trade, added only in that case. | | triggerPrice | string | Trigger price (Only for future trigger orders) | | ocoRef | string | Unique reference that identifies a one_cancels_others (OCO) pair. | | triggerOffset | string | The maximum deviation from the price peak beyond which the order will be triggered (Only for trailing trigger orders) | | quoteSetId | string | Identifier of the QuoteSet supplied in the private/mass_quote request. Only present for quote orders. | | autoReplaced | boolean | Options, advanced orders only - true if last modification of the order was performed by the pricing engine, otherwise false | | reduceOnly | boolean | Optional (not added for spot). 'true for reduce-only orders only' | | quantity | string | It represents the requested order size. For perpetual and inverse futures the amount is in USD units. For options and linear futures and it is the underlying base currency coin. | | riskReducing | boolean | true if the order is marked by the platform as a risk reducing order (can apply only to orders placed by PM users), otherwise false | | instrumentName | string | Unique instrument identifier | | triggerFillCondition | string | The fill condition of the linked order (Only for linked order types), default: first_hit. Allowed values: "first_hit" - any execution of the primary order will fully cancel/place all secondary orders; "complete_fill" - a complete execution (meaning the primary order no longer exists) will cancel/place the secondary orders; "incremental" - any fill of the primary order will cause proportional partial cancellation/placement of the secondary order. The amount that will be subtracted/added to the secondary order will be rounded down to the contract size | | primaryOrderId | string | Unique order identifier |

trades Array

Response Example

{
  "rid": 41001,
  "result": {
    "order": {
      "api": true,
      "averagePrice": "0.0",
      "orderId": "66543741389",
      "postOnly": true,
      "filledQuantity": "0.0",
      "side": "buy",
      "contracts": "5.0",
      "replaced": true,
      "mmp": false,
      "lastUpdatedAt": 1760341294779,
      "createdAt": 1760341294460,
      "orderState": "Open",
      "rejectPostOnly": false,
      "label": "test-label-edit-1760341289973",
      "isLiquidation": false,
      "price": "58000",
      "web": false,
      "timeInForce": "good_til_cancelled",
      "orderType": "limit",
      "reduceOnly": false,
      "quantity": "50.0",
      "riskReducing": false,
      "instrumentName": "BTC-PERPETUAL"
    },
    "trades": []
  }
}