The fill condition of the linked order (Only for linked order types), default: `first_hit`.
Execution instruction of the quote. Default - `any_part_of`
The order price in base currency (Only for limit and stop_limit orders)
When adding an order with advanced=usd, the field price should be the option price value in USD.
When adding an order with advanced=implv, the field price should be a value of implied volatility in percentages. For example, price=100, means implied volatility of 100%
", "in": "query", "name": "price", "required": false, "schema": { "type": "number" } }, { "description": "Specifies how long the order remains in effect. Default `\"good_til_cancelled\"`
If true, the order is considered post-only. If the new price would cause the order to be filled immediately (as taker), the price will be changed to be just below the spread.
Only valid in combination with time_in_force=`\"good_til_cancelled\"`
", "in": "query", "name": "post_only", "required": false, "schema": { "default": true, "type": "boolean" } }, { "description": "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
", "in": "query", "name": "reject_post_only", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "If `true`, the order is considered reduce-only which is intended to only reduce a current position", "in": "query", "name": "reduce_only", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Trigger price, required for trigger orders only (Stop-loss or Take-profit orders)", "in": "query", "name": "trigger_price", "required": false, "schema": { "type": "number" } }, { "description": "The maximum deviation from the price peak beyond which the order will be triggered", "in": "query", "name": "trigger_offset", "required": false, "schema": { "type": "number" } }, { "description": "Defines the trigger type. Required for `\"Stop-Loss\"`, `\"Take-Profit\"` and `\"Trailing\"` trigger orders", "in": "query", "name": "trigger", "required": false, "schema": { "$ref": "#/components/schemas/trigger" } }, { "description": "Advanced option order type. (Only for options. Advanced USD orders are not supported for linear options.)", "in": "query", "name": "advanced", "required": false, "schema": { "$ref": "#/components/schemas/advanced" } }, { "description": "Order MMP flag, only for order_type 'limit'", "in": "query", "name": "mmp", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Timestamp, when provided server will start processing request in Matching Engine only before given timestamp, in other cases `timed_out` error will be responded. Remember that the given timestamp should be consistent with the server's time, use /public/time method to obtain current server time.", "in": "query", "name": "valid_until", "required": false, "schema": { "type": "integer" } }, { "description": "The type of the linked order.
The fill condition of the linked order (Only for linked order types), default: `first_hit`.
The order price in base currency.
When editing an option order with advanced=usd, the field price should be the option price value in USD.
When editing an option order with advanced=implv, the field price should be a value of implied volatility in percentages. For example, price=100, means implied volatility of 100%
", "in": "query", "name": "price", "required": false, "schema": { "type": "number" } }, { "description": "If true, the order is considered post-only. If the new price would cause the order to be filled immediately (as taker), the price will be changed to be just below or above the spread (accordingly to the original order type).
Only valid in combination with time_in_force=`\"good_til_cancelled\"`
", "in": "query", "name": "post_only", "required": false, "schema": { "default": true, "type": "boolean" } }, { "description": "If `true`, the order is considered reduce-only which is intended to only reduce a current position", "in": "query", "name": "reduce_only", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "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
", "in": "query", "name": "reject_post_only", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Advanced option order type. If you have posted an advanced option order, it is necessary to re-supply this parameter when editing it (Only for options)", "in": "query", "name": "advanced", "required": false, "schema": { "$ref": "#/components/schemas/advanced" } }, { "description": "Trigger price, required for trigger orders only (Stop-loss or Take-profit orders)", "in": "query", "name": "trigger_price", "required": false, "schema": { "type": "number" } }, { "description": "The maximum deviation from the price peak beyond which the order will be triggered", "in": "query", "name": "trigger_offset", "required": false, "schema": { "type": "number" } }, { "description": "Order MMP flag, only for order_type 'limit'", "in": "query", "name": "mmp", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Timestamp, when provided server will start processing request in Matching Engine only before given timestamp, in other cases `timed_out` error will be responded. Remember that the given timestamp should be consistent with the server's time, use /public/time method to obtain current server time.", "in": "query", "name": "valid_until", "required": false, "schema": { "type": "integer" } }, { "description": "Initial display amount for iceberg order. Has to be at least 100 times minimum amount for instrument and ratio of hidden part vs visible part has to be less than 100 as well.", "in": "query", "name": "display_amount", "required": false, "schema": { "default": 1, "type": "number" } } ], "requestBody": { "content": { "application/json": { "examples": { "request": { "description": "JSON-RPC Request Example", "value": { "id": 3725, "jsonrpc": "2.0", "method": "private/edit", "params": { "advanced": "implv", "amount": 4, "order_id": "438994", "price": 222 } } } } } }, "description": "JSON-RPC request body" }, "responses": { "200": { "$ref": "#/components/responses/PrivateEditResponse" } }, "tags": [ "Trading", "Matching Engine", "Private" ], "x-mint": { "href": "/api-reference/trading/private-edit", "metadata": { "keywords": [ "private/edit", "order_id", "amount", "contracts", "price", "post_only", "reduce_only", "reject_post_only", "advanced", "trigger_price", "trigger_offset", "mmp", "valid_until", "display_amount", "order", "trades", "order_state", "order_type", "original_order_type", "time_in_force", "is_rebalance", "is_liquidation", "instrument_name", "creation_timestamp", "last_update_timestamp", "direction", "label", "api", "web", "mobile", "refresh_amount", "filled_amount", "average_price", "implv", "usd", "triggered", "trigger", "trigger_reference_price", "block_trade", "risk_reducing", "replaced", "auto_replaced", "quote", "mmp_group", "quote_set_id", "quote_id", "trigger_order_id", "app_name", "mmp_cancelled", "cancel_reason", "oto_order_ids", "trigger_fill_condition", "oco_ref", "primary_order_id", "is_secondary_oto", "is_primary_otoco", "trade_id", "trade_seq", "timestamp", "matching_id", "tick_direction", "index_price", "iv", "underlying_price", "liquidation", "liquidity", "fee", "fee_currency", "state", "block_trade_id", "block_rfq_id", "block_rfq_quote_id", "profit_loss", "mark_price", "legs", "combo_id", "combo_trade_id", "trade_allocations", "user_id", "client_info", "client_id", "client_link_id", "name" ], "og:title": "private/edit", "title": "private/edit" } } } }, "/private/edit_block_rfq_quote": { "get": { "security": [ { "ApiKey": [ "trade" ] }, { "OAuth2": [ "wallet:buys:create" ] } ], "description": "**Maker method**\n\nEdits a Block RFQ quote using the specified `block_rfq_quote_id`. Alternatively, you can use a combination of `block_rfq_id` and `label` to edit the quote.\n\nUse [private/add_block_rfq_quote](https://docs.deribit.com/api-reference/block-rfq/private-add_block_rfq_quote) to add new quotes, or [private/cancel_block_rfq_quote](https://docs.deribit.com/api-reference/block-rfq/private-cancel_block_rfq_quote) to cancel quotes.\n\n**📖 Related Article:** [Deribit Block RFQ API walkthrough](https://docs.deribit.com/articles/block-rfq-api-walkthrough)\n\n[Try in API console](https://test.deribit.com/api_console?method=%2Fprivate%2Fedit_block_rfq_quote)\n\n", "parameters": [ { "description": "List of legs used for Block RFQ quote", "explode": true, "in": "query", "name": "legs", "required": true, "schema": { "items": { "properties": { "direction": { "$ref": "#/components/schemas/direction", "description": "Direction of selected leg. Must match the direction of the corresponding leg in the Block RFQ" }, "instrument_name": { "$ref": "#/components/schemas/instrument_name", "description": "Instrument name" }, "price": { "description": "Price for trade", "type": "number" }, "ratio": { "description": "Ratio of amount between legs", "type": "integer" } }, "type": "object" }, "type": "array" }, "style": "form" }, { "description": "This value multiplied by the ratio of a leg gives trade size on that leg.", "in": "query", "name": "amount", "required": true, "schema": { "$ref": "#/components/schemas/amount" } }, { "description": "ID of the Block RFQ quote", "in": "query", "name": "block_rfq_quote_id", "required": false, "schema": { "type": "integer" } }, { "description": "User defined label for the Block RFQ quote (maximum 64 characters). Used to identify quotes of a selected Block RFQ", "in": "query", "name": "label", "required": false, "schema": { "type": "string" } }, { "description": "Hedge leg of the Block RFQ. There is only one hedge leg allowed per Block RFQ", "in": "query", "name": "hedge", "required": false, "schema": { "description": "JSON string containing: instrument_name, direction, price, amount", "type": "string" } }, { "description": "ID of the Block RFQ", "in": "query", "name": "block_rfq_id", "required": false, "schema": { "type": "integer" } }, { "description": "Aggregated price used for quoting future spreads.", "in": "query", "name": "price", "required": false, "schema": { "type": "number" } } ], "requestBody": { "content": { "application/json": { "examples": { "request": { "description": "JSON-RPC Request Example", "value": { "id": 1, "jsonrpc": "2.0", "method": "private/edit_block_rfq_quote", "params": { "amount": 20000, "block_rfq_id": 3, "direction": "buy", "execution_instruction": "any_part_of", "hedge": { "amount": 10, "direction": "buy", "instrument_name": "BTC-PERPETUAL", "price": 70000 }, "label": "example_quote", "legs": [ { "direction": "buy", "instrument_name": "BTC-15NOV24", "price": 74600, "ratio": "1" } ] } } } } } }, "description": "JSON-RPC request body" }, "responses": { "200": { "$ref": "#/components/responses/PrivateEditBlockRfqQuoteResponse" } }, "tags": [ "Block RFQ", "Private" ], "x-mint": { "href": "/api-reference/block-rfq/private-edit_block_rfq_quote", "metadata": { "keywords": [ "private/edit_block_rfq_quote", "legs", "amount", "block_rfq_quote_id", "label", "hedge", "block_rfq_id", "price", "creation_timestamp", "last_update_timestamp", "quote_state", "execution_instruction", "direction", "filled_amount", "replaced", "app_name", "quote_state_reason", "ratio", "instrument_name" ], "og:title": "private/edit_block_rfq_quote", "title": "private/edit_block_rfq_quote" } } } }, "/private/edit_by_label": { "get": { "security": [ { "ApiKey": [ "trade" ] }, { "OAuth2": [ "wallet:buys:create" ] } ], "description": "Modifies an order identified by its label. This method works only when there is exactly one open order with the specified label.\n\nYou can change the order's price, amount, and/or other properties such as time-in-force, post-only, reduce-only, trigger conditions, or advanced order type. Changes take effect immediately.\n\n[Try in API console](https://test.deribit.com/api_console?method=%2Fprivate%2Fedit_by_label)\n\n", "parameters": [ { "description": "user defined label for the order (maximum 64 characters)", "in": "query", "name": "label", "required": false, "schema": { "type": "string" } }, { "description": "Instrument name", "in": "query", "name": "instrument_name", "required": true, "schema": { "$ref": "#/components/schemas/instrument_name" } }, { "description": "It represents the requested order size. For perpetual and inverse futures the amount is in USD units. For options and linear futures it is the underlying base currency coin. The `amount` is a mandatory parameter if `contracts` parameter is missing. If both `contracts` and `amount` parameter are passed they must match each other otherwise error is returned.", "in": "query", "name": "amount", "required": false, "schema": { "type": "number" } }, { "description": "It represents the requested order size in contract units and can be passed instead of `amount`. The `contracts` is a mandatory parameter if `amount` parameter is missing. If both `contracts` and `amount` parameter are passed they must match each other otherwise error is returned.", "in": "query", "name": "contracts", "required": false, "schema": { "type": "number" } }, { "description": "The order price in base currency.
When editing an option order with advanced=usd, the field price should be the option price value in USD.
When editing an option order with advanced=implv, the field price should be a value of implied volatility in percentages. For example, price=100, means implied volatility of 100%
", "in": "query", "name": "price", "required": false, "schema": { "type": "number" } }, { "description": "If true, the order is considered post-only. If the new price would cause the order to be filled immediately (as taker), the price will be changed to be just below or above the spread (accordingly to the original order type).
Only valid in combination with time_in_force=`\"good_til_cancelled\"`
", "in": "query", "name": "post_only", "required": false, "schema": { "default": true, "type": "boolean" } }, { "description": "If `true`, the order is considered reduce-only which is intended to only reduce a current position", "in": "query", "name": "reduce_only", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "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
", "in": "query", "name": "reject_post_only", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Advanced option order type. If you have posted an advanced option order, it is necessary to re-supply this parameter when editing it (Only for options)", "in": "query", "name": "advanced", "required": false, "schema": { "$ref": "#/components/schemas/advanced" } }, { "description": "Trigger price, required for trigger orders only (Stop-loss or Take-profit orders)", "in": "query", "name": "trigger_price", "required": false, "schema": { "type": "number" } }, { "description": "Order MMP flag, only for order_type 'limit'", "in": "query", "name": "mmp", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Timestamp, when provided server will start processing request in Matching Engine only before given timestamp, in other cases `timed_out` error will be responded. Remember that the given timestamp should be consistent with the server's time, use /public/time method to obtain current server time.", "in": "query", "name": "valid_until", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "examples": { "request": { "description": "JSON-RPC Request Example", "value": { "id": 9, "jsonrpc": "2.0", "method": "private/edit_by_label", "params": { "amount": 150, "instrument_name": "BTC-PERPETUAL", "label": "i_love_deribit", "price": 50111 } } } } } }, "description": "JSON-RPC request body" }, "responses": { "200": { "$ref": "#/components/responses/PrivateEditResponse" } }, "tags": [ "Trading", "Matching Engine", "Private" ], "x-mint": { "href": "/api-reference/trading/private-edit_by_label", "metadata": { "keywords": [ "private/edit_by_label", "label", "instrument_name", "amount", "contracts", "price", "post_only", "reduce_only", "reject_post_only", "advanced", "trigger_price", "mmp", "valid_until", "order", "trades", "order_id", "order_state", "order_type", "original_order_type", "time_in_force", "is_rebalance", "is_liquidation", "creation_timestamp", "last_update_timestamp", "direction", "api", "web", "mobile", "refresh_amount", "display_amount", "filled_amount", "average_price", "implv", "usd", "triggered", "trigger", "trigger_offset", "trigger_reference_price", "block_trade", "risk_reducing", "replaced", "auto_replaced", "quote", "mmp_group", "quote_set_id", "quote_id", "trigger_order_id", "app_name", "mmp_cancelled", "cancel_reason", "oto_order_ids", "trigger_fill_condition", "oco_ref", "primary_order_id", "is_secondary_oto", "is_primary_otoco", "trade_id", "trade_seq", "timestamp", "matching_id", "tick_direction", "index_price", "iv", "underlying_price", "liquidation", "liquidity", "fee", "fee_currency", "state", "block_trade_id", "block_rfq_id", "block_rfq_quote_id", "profit_loss", "mark_price", "legs", "combo_id", "combo_trade_id", "trade_allocations", "user_id", "client_info", "client_id", "client_link_id", "name" ], "og:title": "private/edit_by_label", "title": "private/edit_by_label" } } } }, "/private/enable_cancel_on_disconnect": { "get": { "security": [ { "ApiKey": [ "trade" ] }, { "OAuth2": [ "wallet:buys:create" ] } ], "description": "Enable Cancel On Disconnect for the connection. After enabling, all orders created via this connection will be automatically cancelled when the connection is closed.\n\nCancel is triggered in the following cases: when the TCP connection is properly terminated, when the connection is closed due to 10 minutes of inactivity, or when a heartbeat detects a disconnection. To reduce the inactivity timeout, consider using [public/set_heartbeat](https://docs.deribit.com/api-reference/session-management/public-set_heartbeat).\n\n**Note:** If the connection is gracefully closed using [private/logout](https://docs.deribit.com/api-reference/authentication/private-logout), cancel-on-disconnect will **not** be triggered.\n\n**Notice:** Cancel-on-Disconnect does not affect orders created by other connections - they will remain active! When change is applied on the `account` scope, then every newly opened connection will start with **active** Cancel on Disconnect.\n\n**WebSocket Only:** This method is designed exclusively for WebSocket connections. Attempting to use it via REST/HTTP will result in an error response.\n\n[Try in API console](https://test.deribit.com/api_console?method=%2Fprivate%2Fenable_cancel_on_disconnect)\n\n", "parameters": [ { "description": "Specifies if Cancel On Disconnect change should be applied/checked for the current connection or the account (default - `connection`)The order price in base currency (Only for limit and stop_limit orders)
When adding an order with advanced=usd, the field price should be the option price value in USD.
When adding an order with advanced=implv, the field price should be a value of implied volatility in percentages. For example, price=100, means implied volatility of 100%
", "in": "query", "name": "price", "required": false, "schema": { "type": "number" } }, { "description": "Specifies how long the order remains in effect. Default `\"good_til_cancelled\"`
If true, the order is considered post-only. If the new price would cause the order to be filled immediately (as taker), the price will be changed to be just above the spread.
Only valid in combination with time_in_force=`\"good_til_cancelled\"`
", "in": "query", "name": "post_only", "required": false, "schema": { "default": true, "type": "boolean" } }, { "description": "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
", "in": "query", "name": "reject_post_only", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "If `true`, the order is considered reduce-only which is intended to only reduce a current position", "in": "query", "name": "reduce_only", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Trigger price, required for trigger orders only (Stop-loss or Take-profit orders)", "in": "query", "name": "trigger_price", "required": false, "schema": { "type": "number" } }, { "description": "The maximum deviation from the price peak beyond which the order will be triggered", "in": "query", "name": "trigger_offset", "required": false, "schema": { "type": "number" } }, { "description": "Defines the trigger type. Required for `\"Stop-Loss\"`, `\"Take-Profit\"` and `\"Trailing\"` trigger orders", "in": "query", "name": "trigger", "required": false, "schema": { "$ref": "#/components/schemas/trigger" } }, { "description": "Advanced option order type. (Only for options. Advanced USD orders are not supported for linear options.)", "in": "query", "name": "advanced", "required": false, "schema": { "$ref": "#/components/schemas/advanced" } }, { "description": "Order MMP flag, only for order_type 'limit'", "in": "query", "name": "mmp", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Timestamp, when provided server will start processing request in Matching Engine only before given timestamp, in other cases `timed_out` error will be responded. Remember that the given timestamp should be consistent with the server's time, use /public/time method to obtain current server time.", "in": "query", "name": "valid_until", "required": false, "schema": { "type": "integer" } }, { "description": "The type of the linked order.
The fill condition of the linked order (Only for linked order types), default: `first_hit`.
Private methods require authentication. All requests must include a valid OAuth2 token.
\nA token can be requested using the /public/auth method.
\nWhen using the websockets protocol, the token must be included as a parameter access_token in the message. When using REST (HTTP GET), the token may also be passed in the Authorization header.